Files
2022-03-08 15:36:16 +08:00

557 lines
24 KiB
HTML

<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Locations Transfer Configs Patch - BigQuery Data Transfer v3.0.0+20220225</title>
<link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
<link rel="stylesheet" href="../css/theme.css" type="text/css" />
<link rel="stylesheet" href="../css/theme_extra.css" type="text/css" />
<link rel="stylesheet" href="../css/highlight.css">
<script src="//cdnjs.cloudflare.com/ajax/libs/jquery/2.1.1/jquery.min.js"></script>
<script src="//cdnjs.cloudflare.com/ajax/libs/modernizr/2.8.3/modernizr.min.js"></script>
<script type="text/javascript" src="../js/highlight.pack.js"></script>
<script src="../js/theme.js"></script>
<style>
body {font-size: 90%;}
pre, code {font-size: 100%;}
h3, h4, h5, h6 {color: #2980b9; font-weight: 300}
</style>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-nav-search">
<a href=".." class="icon icon-home"> BigQuery Data Transfer v3.0.0+20220225</a>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<span>Projects</span>
<li class="toctree-l1 ">
<a class="" href="../projects_data-sources-check-valid-creds">Data Sources Check Valid Creds</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_data-sources-get">Data Sources Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_data-sources-list">Data Sources List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_enroll-data-sources">Enroll Data Sources</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-data-sources-check-valid-creds">Locations Data Sources Check Valid Creds</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-data-sources-get">Locations Data Sources Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-data-sources-list">Locations Data Sources List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-enroll-data-sources">Locations Enroll Data Sources</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-get">Locations Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-list">Locations List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-transfer-configs-create">Locations Transfer Configs Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-transfer-configs-delete">Locations Transfer Configs Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-transfer-configs-get">Locations Transfer Configs Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-transfer-configs-list">Locations Transfer Configs List</a>
</li>
<li class="toctree-l1 current">
<a class="current" href=".">Locations Transfer Configs Patch</a>
<ul>
<li class="toctree-l2"><a href="#scopes">Scopes</a></li>
<li class="toctree-l2"><a href="#required-scalar-argument">Required Scalar Argument</a></li>
<li class="toctree-l2"><a href="#required-request-value">Required Request Value</a></li>
<li><a class="toctree-l3" href="#about-cursors">About Cursors</a></li>
<li class="toctree-l2"><a href="#optional-output-flags">Optional Output Flags</a></li>
<li class="toctree-l2"><a href="#optional-method-properties">Optional Method Properties</a></li>
<li class="toctree-l2"><a href="#optional-general-properties">Optional General Properties</a></li>
</ul>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-transfer-configs-runs-delete">Locations Transfer Configs Runs Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-transfer-configs-runs-get">Locations Transfer Configs Runs Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-transfer-configs-runs-list">Locations Transfer Configs Runs List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-transfer-configs-runs-transfer-logs-list">Locations Transfer Configs Runs Transfer Logs List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-transfer-configs-schedule-runs">Locations Transfer Configs Schedule Runs</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-transfer-configs-start-manual-runs">Locations Transfer Configs Start Manual Runs</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_transfer-configs-create">Transfer Configs Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_transfer-configs-delete">Transfer Configs Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_transfer-configs-get">Transfer Configs Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_transfer-configs-list">Transfer Configs List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_transfer-configs-patch">Transfer Configs Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_transfer-configs-runs-delete">Transfer Configs Runs Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_transfer-configs-runs-get">Transfer Configs Runs Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_transfer-configs-runs-list">Transfer Configs Runs List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_transfer-configs-runs-transfer-logs-list">Transfer Configs Runs Transfer Logs List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_transfer-configs-schedule-runs">Transfer Configs Schedule Runs</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_transfer-configs-start-manual-runs">Transfer Configs Start Manual Runs</a>
</li>
</ul>
</div>
&nbsp;
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="icon icon-reorder"></i>
<a href=".."></a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="..">Docs</a> &raquo;</li>
<li>Locations Transfer Configs Patch</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/bigquerydatatransfer1-cli" class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main">
<div class="section">
<p>Updates a data transfer configuration. All fields must be set, even if they are not updated.</p>
<h1 id="scopes">Scopes</h1>
<p>You will need authorization for the <em>https://www.googleapis.com/auth/cloud-platform</em> scope to make a valid call.</p>
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/cloud-platform</em>.
You can set the scope for this method like this: <code>bigquerydatatransfer1 --scope &lt;scope&gt; projects locations-transfer-configs-patch ...</code></p>
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
<ul>
<li><strong>&lt;name&gt;</strong> <em>(string)</em><ul>
<li>The resource name of the transfer config. Transfer config names have the form <code>projects/{project_id}/locations/{region}/transferConfigs/{config_id}</code>. Where <code>config_id</code> is usually a uuid, even though it is not guaranteed or required. The name is ignored when creating a transfer config.</li>
</ul>
</li>
</ul>
<h1 id="required-request-value">Required Request Value</h1>
<p>The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure.
In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.</p>
<p>For example, a structure like this:</p>
<pre><code>TransferConfig:
data-refresh-window-days: integer
data-source-id: string
dataset-region: string
destination-dataset-id: string
disabled: boolean
display-name: string
email-preferences:
enable-failure-email: boolean
name: string
next-run-time: string
notification-pubsub-topic: string
owner-info:
email: string
schedule: string
schedule-options:
disable-auto-scheduling: boolean
end-time: string
start-time: string
state: string
update-time: string
user-id: string
</code></pre>
<p>can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.</p>
<ul>
<li><code>-r . data-refresh-window-days=81</code><ul>
<li>The number of days to look back to automatically refresh the data. For example, if <code>data_refresh_window_days = 10</code>, then every day BigQuery reingests data for [today-10, today-1], rather than ingesting data for just [today-1]. Only valid if the data source supports the feature. Set the value to 0 to use the default value.</li>
</ul>
</li>
<li><code>data-source-id=ipsum</code><ul>
<li>Data source id. Cannot be changed once data transfer is created.</li>
</ul>
</li>
<li><code>dataset-region=sed</code><ul>
<li>Output only. Region in which BigQuery dataset is located.</li>
</ul>
</li>
<li><code>destination-dataset-id=ut</code><ul>
<li>The BigQuery target dataset id.</li>
</ul>
</li>
<li><code>disabled=true</code><ul>
<li>Is this config disabled. When set to true, no runs are scheduled for a given transfer.</li>
</ul>
</li>
<li><code>display-name=ipsum</code><ul>
<li>User specified display name for the data transfer.</li>
</ul>
</li>
<li>
<p><code>email-preferences enable-failure-email=true</code></p>
<ul>
<li>If true, email notifications will be sent on transfer run failures.</li>
</ul>
</li>
<li>
<p><code>.. name=est</code></p>
<ul>
<li>The resource name of the transfer config. Transfer config names have the form <code>projects/{project_id}/locations/{region}/transferConfigs/{config_id}</code>. Where <code>config_id</code> is usually a uuid, even though it is not guaranteed or required. The name is ignored when creating a transfer config.</li>
</ul>
</li>
<li><code>next-run-time=gubergren</code><ul>
<li>Output only. Next time when data transfer will run.</li>
</ul>
</li>
<li><code>notification-pubsub-topic=ea</code><ul>
<li>Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish. The format for specifying a pubsub topic is: <code>projects/{project}/topics/{topic}</code></li>
</ul>
</li>
<li>
<p><code>owner-info email=dolor</code></p>
<ul>
<li>E-mail address of the user.</li>
</ul>
</li>
<li>
<p><code>.. schedule=lorem</code></p>
<ul>
<li>Data transfer schedule. If the data source does not support a custom schedule, this should be empty. If it is empty, the default value for the data source will be used. The specified times are in UTC. Examples of valid format: <code>1st,3rd monday of month 15:30</code>, <code>every wed,fri of jan,jun 13:15</code>, and <code>first sunday of quarter 00:00</code>. See more explanation about the format here: https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format NOTE: The minimum interval time between recurring transfers depends on the data source; refer to the documentation for your data source.</li>
</ul>
</li>
<li><code>schedule-options disable-auto-scheduling=false</code><ul>
<li>If true, automatic scheduling of data transfer runs for this configuration will be disabled. The runs can be started on ad-hoc basis using StartManualTransferRuns API. When automatic scheduling is disabled, the TransferConfig.schedule field will be ignored.</li>
</ul>
</li>
<li><code>end-time=sed</code><ul>
<li>Defines time to stop scheduling transfer runs. A transfer run cannot be scheduled at or after the end time. The end time can be changed at any moment. The time when a data transfer can be trigerred manually is not limited by this option.</li>
</ul>
</li>
<li>
<p><code>start-time=duo</code></p>
<ul>
<li>Specifies time to start scheduling transfer runs. The first run will be scheduled at or after the start time according to a recurrence pattern defined in the schedule string. The start time can be changed at any moment. The time when a data transfer can be trigerred manually is not limited by this option.</li>
</ul>
</li>
<li>
<p><code>.. state=sed</code></p>
<ul>
<li>Output only. State of the most recently updated transfer run.</li>
</ul>
</li>
<li><code>update-time=no</code><ul>
<li>Output only. Data transfer modification time. Ignored by server on input.</li>
</ul>
</li>
<li><code>user-id=stet</code><ul>
<li>Deprecated. Unique ID of the user on whose behalf transfer is done.</li>
</ul>
</li>
</ul>
<h3 id="about-cursors">About Cursors</h3>
<p>The cursor position is key to comfortably set complex nested structures. The following rules apply:</p>
<ul>
<li>The cursor position is always set relative to the current one, unless the field name starts with the <code>.</code> character. Fields can be nested such as in <code>-r f.s.o</code> .</li>
<li>The cursor position is set relative to the top-level structure if it starts with <code>.</code>, e.g. <code>-r .s.s</code></li>
<li>You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify <code>-r struct.sub_struct=bar</code>.</li>
<li>You can move the cursor one level up by using <code>..</code>. Each additional <code>.</code> moves it up one additional level. E.g. <code>...</code> would go three levels up.</li>
</ul>
<h1 id="optional-output-flags">Optional Output Flags</h1>
<p>The method's return value a JSON encoded structure, which will be written to standard output by default.</p>
<ul>
<li><strong>-o out</strong><ul>
<li><em>out</em> specifies the <em>destination</em> to which to write the server's result to.
It will be a JSON-encoded structure.
The <em>destination</em> may be <code>-</code> to indicate standard output, or a filepath that is to contain the received bytes.
If unset, it defaults to standard output.</li>
</ul>
</li>
</ul>
<h1 id="optional-method-properties">Optional Method Properties</h1>
<p>You may set the following properties to further configure the call. Please note that <code>-p</code> is followed by one
or more key-value-pairs, and is called like this <code>-p k1=v1 k2=v2</code> even though the listing below repeats the
<code>-p</code> for completeness.</p>
<ul>
<li>
<p><strong>-p authorization-code=string</strong></p>
<ul>
<li>Optional OAuth2 authorization code to use with this transfer configuration. This is required only if <code>transferConfig.dataSourceId</code> is &#39;youtube_channel&#39; and new credentials are needed, as indicated by <code>CheckValidCreds</code>. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&amp;scope=&amp;redirect_uri=urn:ietf:wg:oauth:2.0:oob&amp;response_type=authorization_code * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when <code>service_account_name</code> is used to create the transfer config.</li>
</ul>
</li>
<li>
<p><strong>-p service-account-name=string</strong></p>
<ul>
<li>Optional service account name. If this field is set and &#34;service_account_name&#34; is set in update_mask, transfer config will be created with this service account credential. It requires that requesting user calling this API has permissions to act as this service account. Note that not all data sources support service account credentials when creating transfer config. Please refer to this public guide for the latest list of data sources with service account support: https://cloud.google.com/bigquery-transfer/docs/use-service-accounts</li>
</ul>
</li>
<li>
<p><strong>-p update-mask=string</strong></p>
<ul>
<li>Required. Required list of fields to be updated in this request.</li>
</ul>
</li>
<li>
<p><strong>-p version-info=string</strong></p>
<ul>
<li>Optional version info. This is required only if <code>transferConfig.dataSourceId</code> is anything else but &#39;youtube_channel&#39; and new credentials are needed, as indicated by <code>CheckValidCreds</code>. In order to obtain version info, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&amp;scope=&amp;redirect_uri=urn:ietf:wg:oauth:2.0:oob&amp;response_type=version_info * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when <code>service_account_name</code> is used to create the transfer config.</li>
</ul>
</li>
</ul>
<h1 id="optional-general-properties">Optional General Properties</h1>
<p>The following properties can configure any call, and are not specific to this method.</p>
<ul>
<li>
<p><strong>-p $-xgafv=string</strong></p>
<ul>
<li>V1 error format.</li>
</ul>
</li>
<li>
<p><strong>-p access-token=string</strong></p>
<ul>
<li>OAuth access token.</li>
</ul>
</li>
<li>
<p><strong>-p alt=string</strong></p>
<ul>
<li>Data format for response.</li>
</ul>
</li>
<li>
<p><strong>-p callback=string</strong></p>
<ul>
<li>JSONP</li>
</ul>
</li>
<li>
<p><strong>-p fields=string</strong></p>
<ul>
<li>Selector specifying which fields to include in a partial response.</li>
</ul>
</li>
<li>
<p><strong>-p key=string</strong></p>
<ul>
<li>API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.</li>
</ul>
</li>
<li>
<p><strong>-p oauth-token=string</strong></p>
<ul>
<li>OAuth 2.0 token for the current user.</li>
</ul>
</li>
<li>
<p><strong>-p pretty-print=boolean</strong></p>
<ul>
<li>Returns response with indentations and line breaks.</li>
</ul>
</li>
<li>
<p><strong>-p quota-user=string</strong></p>
<ul>
<li>Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.</li>
</ul>
</li>
<li>
<p><strong>-p upload-type=string</strong></p>
<ul>
<li>Legacy upload protocol for media (e.g. &#34;media&#34;, &#34;multipart&#34;).</li>
</ul>
</li>
<li>
<p><strong>-p upload-protocol=string</strong></p>
<ul>
<li>Upload protocol for media (e.g. &#34;raw&#34;, &#34;multipart&#34;).</li>
</ul>
</li>
</ul>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="../projects_locations-transfer-configs-runs-delete" class="btn btn-neutral float-right" title="Locations Transfer Configs Runs Delete"/>Next <span class="icon icon-circle-arrow-right"></span></a>
<a href="../projects_locations-transfer-configs-list" class="btn btn-neutral" title="Locations Transfer Configs List"><span class="icon icon-circle-arrow-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
<!-- Copyright etc -->
</p>
</div>
Built with <a href="http://www.mkdocs.org">MkDocs</a>, using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" role="note" style="cursor: pointer">
<span class="rst-current-version" data-toggle="rst-current-version">
<a class="icon icon-github" style="float: left; color: #fcfcfc"> GitHub</a>
<span><a href="../projects_locations-transfer-configs-list" style="color: #fcfcfc;">&laquo; Previous</a></span>
<span style="margin-left: 15px"><a href="../projects_locations-transfer-configs-runs-delete" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
</body>
</html>