blob: 8735b2892224b5c2d936b23a0fd8814bf37e819d [file] [log] [blame]
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070075<h1><a href="bigquerydatatransfer_v1.html">BigQuery Data Transfer API</a> . <a href="bigquerydatatransfer_v1.projects.html">projects</a> . <a href="bigquerydatatransfer_v1.projects.transferConfigs.html">transferConfigs</a></h1>
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -040076<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="bigquerydatatransfer_v1.projects.transferConfigs.runs.html">runs()</a></code>
79</p>
80<p class="firstline">Returns the runs Resource.</p>
81
82<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070083 <code><a href="#close">close()</a></code></p>
84<p class="firstline">Close httplib2 connections.</p>
85<p class="toc_element">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -080086 <code><a href="#create">create(parent, authorizationCode=None, body=None, serviceAccountName=None, versionInfo=None, x__xgafv=None)</a></code></p>
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -040087<p class="firstline">Creates a new data transfer configuration.</p>
88<p class="toc_element">
89 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070090<p class="firstline">Deletes a data transfer configuration, including any associated transfer runs and logs.</p>
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -040091<p class="toc_element">
92 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
93<p class="firstline">Returns information about a data transfer config.</p>
94<p class="toc_element">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -080095 <code><a href="#list">list(parent, dataSourceIds=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
yoshi-code-botb539cc42021-08-03 00:20:27 -070096<p class="firstline">Returns information about all transfer configs owned by a project in the specified location.</p>
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -040097<p class="toc_element">
98 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
99<p class="firstline">Retrieves the next page of results.</p>
100<p class="toc_element">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800101 <code><a href="#patch">patch(name, authorizationCode=None, body=None, serviceAccountName=None, updateMask=None, versionInfo=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700102<p class="firstline">Updates a data transfer configuration. All fields must be set, even if they are not updated.</p>
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400103<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700104 <code><a href="#scheduleRuns">scheduleRuns(parent, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700105<p class="firstline">Creates transfer runs for a time range [start_time, end_time]. For each date - or whatever granularity the data source supports - in the range, one transfer run is created. Note that runs are created per UTC time in the time range. DEPRECATED: use StartManualTransferRuns instead.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700106<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700107 <code><a href="#startManualRuns">startManualRuns(parent, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700108<p class="firstline">Start manual transfer runs to be executed now with schedule_time equal to current time. The transfer runs can be created for a time range where the run_time is between start_time (inclusive) and end_time (exclusive), or for a specific run_time.</p>
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400109<h3>Method Details</h3>
110<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700111 <code class="details" id="close">close()</code>
112 <pre>Close httplib2 connections.</pre>
113</div>
114
115<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800116 <code class="details" id="create">create(parent, authorizationCode=None, body=None, serviceAccountName=None, versionInfo=None, x__xgafv=None)</code>
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400117 <pre>Creates a new data transfer configuration.
118
119Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700120 parent: string, Required. The BigQuery project id where the transfer configuration should be created. Must be in the format projects/{project_id}/locations/{location_id} or projects/{project_id}. If specified location and location of the destination bigquery dataset do not match - the request will fail. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700121 body: object, The request body.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400122 The object takes the form of:
123
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700124{ # Represents a data transfer configuration. A transfer configuration contains all metadata needed to perform a data transfer. For example, `destination_dataset_id` specifies where data should be stored. When a new transfer configuration is created, the specified `destination_dataset_id` is created when needed and shared with the appropriate data source service account.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800125 &quot;dataRefreshWindowDays&quot;: 42, # The number of days to look back to automatically refresh the data. For example, if `data_refresh_window_days = 10`, 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.
126 &quot;dataSourceId&quot;: &quot;A String&quot;, # Data source id. Cannot be changed once data transfer is created.
127 &quot;datasetRegion&quot;: &quot;A String&quot;, # Output only. Region in which BigQuery dataset is located.
128 &quot;destinationDatasetId&quot;: &quot;A String&quot;, # The BigQuery target dataset id.
129 &quot;disabled&quot;: True or False, # Is this config disabled. When set to true, no runs are scheduled for a given transfer.
130 &quot;displayName&quot;: &quot;A String&quot;, # User specified display name for the data transfer.
131 &quot;emailPreferences&quot;: { # Represents preferences for sending email notifications for transfer run events. # Email notifications will be sent according to these preferences to the email address of the user who owns this transfer config.
132 &quot;enableFailureEmail&quot;: True or False, # If true, email notifications will be sent on transfer run failures.
133 },
yoshi-code-bot69706592021-03-03 03:54:02 -0800134 &quot;name&quot;: &quot;A String&quot;, # The resource name of the transfer config. Transfer config names have the form `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`. Where `config_id` is usually a uuid, even though it is not guaranteed or required. The name is ignored when creating a transfer config.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800135 &quot;nextRunTime&quot;: &quot;A String&quot;, # Output only. Next time when data transfer will run.
yoshi-code-bot96afc042021-08-24 00:22:31 -0700136 &quot;notificationPubsubTopic&quot;: &quot;A String&quot;, # 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: `projects/{project}/topics/{topic}`
137 &quot;ownerInfo&quot;: { # Information about a user. # Output only. Information about the user whose credentials are used to transfer data. Populated only for `transferConfigs.get` requests. In case the user information is not available, this field will not be populated.
138 &quot;email&quot;: &quot;A String&quot;, # E-mail address of the user.
139 },
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700140 &quot;params&quot;: { # Parameters specific to each data source. For more information see the bq tab in the &#x27;Setting up a data transfer&#x27; section for each data source. For example the parameters for Cloud Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800141 &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
142 },
yoshi-code-bot85954412021-12-06 23:26:37 -0800143 &quot;schedule&quot;: &quot;A String&quot;, # 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: `1st,3rd monday of month 15:30`, `every wed,fri of jan,jun 13:15`, and `first sunday of quarter 00:00`. 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.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800144 &quot;scheduleOptions&quot;: { # Options customizing the data transfer schedule. # Options customizing the data transfer schedule.
145 &quot;disableAutoScheduling&quot;: True or False, # 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.
146 &quot;endTime&quot;: &quot;A String&quot;, # 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.
147 &quot;startTime&quot;: &quot;A String&quot;, # 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.
148 },
149 &quot;state&quot;: &quot;A String&quot;, # Output only. State of the most recently updated transfer run.
150 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Data transfer modification time. Ignored by server on input.
151 &quot;userId&quot;: &quot;A String&quot;, # Deprecated. Unique ID of the user on whose behalf transfer is done.
152}
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400153
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700154 authorizationCode: string, Optional OAuth2 authorization code to use with this transfer configuration. This is required if new credentials are needed, as indicated by `CheckValidCreds`. 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= * 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. * redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800155 serviceAccountName: string, Optional service account name. If this field is set, transfer config will be created with this service account credentials. It requires that requesting user calling this API has permissions to act as this service account.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800156 versionInfo: string, Optional version info. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the &quot;none+gsession&quot; response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400157 x__xgafv: string, V1 error format.
158 Allowed values
159 1 - v1 error format
160 2 - v2 error format
161
162Returns:
163 An object of the form:
164
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700165 { # Represents a data transfer configuration. A transfer configuration contains all metadata needed to perform a data transfer. For example, `destination_dataset_id` specifies where data should be stored. When a new transfer configuration is created, the specified `destination_dataset_id` is created when needed and shared with the appropriate data source service account.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800166 &quot;dataRefreshWindowDays&quot;: 42, # The number of days to look back to automatically refresh the data. For example, if `data_refresh_window_days = 10`, 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.
167 &quot;dataSourceId&quot;: &quot;A String&quot;, # Data source id. Cannot be changed once data transfer is created.
168 &quot;datasetRegion&quot;: &quot;A String&quot;, # Output only. Region in which BigQuery dataset is located.
169 &quot;destinationDatasetId&quot;: &quot;A String&quot;, # The BigQuery target dataset id.
170 &quot;disabled&quot;: True or False, # Is this config disabled. When set to true, no runs are scheduled for a given transfer.
171 &quot;displayName&quot;: &quot;A String&quot;, # User specified display name for the data transfer.
172 &quot;emailPreferences&quot;: { # Represents preferences for sending email notifications for transfer run events. # Email notifications will be sent according to these preferences to the email address of the user who owns this transfer config.
173 &quot;enableFailureEmail&quot;: True or False, # If true, email notifications will be sent on transfer run failures.
174 },
yoshi-code-bot69706592021-03-03 03:54:02 -0800175 &quot;name&quot;: &quot;A String&quot;, # The resource name of the transfer config. Transfer config names have the form `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`. Where `config_id` is usually a uuid, even though it is not guaranteed or required. The name is ignored when creating a transfer config.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800176 &quot;nextRunTime&quot;: &quot;A String&quot;, # Output only. Next time when data transfer will run.
yoshi-code-bot96afc042021-08-24 00:22:31 -0700177 &quot;notificationPubsubTopic&quot;: &quot;A String&quot;, # 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: `projects/{project}/topics/{topic}`
178 &quot;ownerInfo&quot;: { # Information about a user. # Output only. Information about the user whose credentials are used to transfer data. Populated only for `transferConfigs.get` requests. In case the user information is not available, this field will not be populated.
179 &quot;email&quot;: &quot;A String&quot;, # E-mail address of the user.
180 },
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700181 &quot;params&quot;: { # Parameters specific to each data source. For more information see the bq tab in the &#x27;Setting up a data transfer&#x27; section for each data source. For example the parameters for Cloud Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800182 &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
183 },
yoshi-code-bot85954412021-12-06 23:26:37 -0800184 &quot;schedule&quot;: &quot;A String&quot;, # 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: `1st,3rd monday of month 15:30`, `every wed,fri of jan,jun 13:15`, and `first sunday of quarter 00:00`. 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.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800185 &quot;scheduleOptions&quot;: { # Options customizing the data transfer schedule. # Options customizing the data transfer schedule.
186 &quot;disableAutoScheduling&quot;: True or False, # 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.
187 &quot;endTime&quot;: &quot;A String&quot;, # 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.
188 &quot;startTime&quot;: &quot;A String&quot;, # 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.
189 },
190 &quot;state&quot;: &quot;A String&quot;, # Output only. State of the most recently updated transfer run.
191 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Data transfer modification time. Ignored by server on input.
192 &quot;userId&quot;: &quot;A String&quot;, # Deprecated. Unique ID of the user on whose behalf transfer is done.
193}</pre>
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400194</div>
195
196<div class="method">
197 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700198 <pre>Deletes a data transfer configuration, including any associated transfer runs and logs.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400199
200Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700201 name: string, Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}` (required)
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400202 x__xgafv: string, V1 error format.
203 Allowed values
204 1 - v1 error format
205 2 - v2 error format
206
207Returns:
208 An object of the form:
209
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700210 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800211}</pre>
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400212</div>
213
214<div class="method">
215 <code class="details" id="get">get(name, x__xgafv=None)</code>
216 <pre>Returns information about a data transfer config.
217
218Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700219 name: string, Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}` (required)
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400220 x__xgafv: string, V1 error format.
221 Allowed values
222 1 - v1 error format
223 2 - v2 error format
224
225Returns:
226 An object of the form:
227
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700228 { # Represents a data transfer configuration. A transfer configuration contains all metadata needed to perform a data transfer. For example, `destination_dataset_id` specifies where data should be stored. When a new transfer configuration is created, the specified `destination_dataset_id` is created when needed and shared with the appropriate data source service account.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800229 &quot;dataRefreshWindowDays&quot;: 42, # The number of days to look back to automatically refresh the data. For example, if `data_refresh_window_days = 10`, 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.
230 &quot;dataSourceId&quot;: &quot;A String&quot;, # Data source id. Cannot be changed once data transfer is created.
231 &quot;datasetRegion&quot;: &quot;A String&quot;, # Output only. Region in which BigQuery dataset is located.
232 &quot;destinationDatasetId&quot;: &quot;A String&quot;, # The BigQuery target dataset id.
233 &quot;disabled&quot;: True or False, # Is this config disabled. When set to true, no runs are scheduled for a given transfer.
234 &quot;displayName&quot;: &quot;A String&quot;, # User specified display name for the data transfer.
235 &quot;emailPreferences&quot;: { # Represents preferences for sending email notifications for transfer run events. # Email notifications will be sent according to these preferences to the email address of the user who owns this transfer config.
236 &quot;enableFailureEmail&quot;: True or False, # If true, email notifications will be sent on transfer run failures.
237 },
yoshi-code-bot69706592021-03-03 03:54:02 -0800238 &quot;name&quot;: &quot;A String&quot;, # The resource name of the transfer config. Transfer config names have the form `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`. Where `config_id` is usually a uuid, even though it is not guaranteed or required. The name is ignored when creating a transfer config.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800239 &quot;nextRunTime&quot;: &quot;A String&quot;, # Output only. Next time when data transfer will run.
yoshi-code-bot96afc042021-08-24 00:22:31 -0700240 &quot;notificationPubsubTopic&quot;: &quot;A String&quot;, # 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: `projects/{project}/topics/{topic}`
241 &quot;ownerInfo&quot;: { # Information about a user. # Output only. Information about the user whose credentials are used to transfer data. Populated only for `transferConfigs.get` requests. In case the user information is not available, this field will not be populated.
242 &quot;email&quot;: &quot;A String&quot;, # E-mail address of the user.
243 },
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700244 &quot;params&quot;: { # Parameters specific to each data source. For more information see the bq tab in the &#x27;Setting up a data transfer&#x27; section for each data source. For example the parameters for Cloud Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800245 &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
246 },
yoshi-code-bot85954412021-12-06 23:26:37 -0800247 &quot;schedule&quot;: &quot;A String&quot;, # 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: `1st,3rd monday of month 15:30`, `every wed,fri of jan,jun 13:15`, and `first sunday of quarter 00:00`. 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.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800248 &quot;scheduleOptions&quot;: { # Options customizing the data transfer schedule. # Options customizing the data transfer schedule.
249 &quot;disableAutoScheduling&quot;: True or False, # 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.
250 &quot;endTime&quot;: &quot;A String&quot;, # 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.
251 &quot;startTime&quot;: &quot;A String&quot;, # 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.
252 },
253 &quot;state&quot;: &quot;A String&quot;, # Output only. State of the most recently updated transfer run.
254 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Data transfer modification time. Ignored by server on input.
255 &quot;userId&quot;: &quot;A String&quot;, # Deprecated. Unique ID of the user on whose behalf transfer is done.
256}</pre>
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400257</div>
258
259<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800260 <code class="details" id="list">list(parent, dataSourceIds=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
yoshi-code-botb539cc42021-08-03 00:20:27 -0700261 <pre>Returns information about all transfer configs owned by a project in the specified location.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400262
263Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700264 parent: string, Required. The BigQuery project id for which data sources should be returned: `projects/{project_id}` or `projects/{project_id}/locations/{location_id}` (required)
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800265 dataSourceIds: string, When specified, only configurations of requested data sources are returned. (repeated)
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800266 pageSize: integer, Page size. The default page size is the maximum value of 1000 results.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800267 pageToken: string, Pagination token, which can be used to request a specific page of `ListTransfersRequest` list results. For multiple-page results, `ListTransfersResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400268 x__xgafv: string, V1 error format.
269 Allowed values
270 1 - v1 error format
271 2 - v2 error format
272
273Returns:
274 An object of the form:
275
276 { # The returned list of pipelines in the project.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800277 &quot;nextPageToken&quot;: &quot;A String&quot;, # Output only. The next-pagination token. For multiple-page list results, this token can be used as the `ListTransferConfigsRequest.page_token` to request the next page of list results.
278 &quot;transferConfigs&quot;: [ # Output only. The stored pipeline transfer configurations.
279 { # Represents a data transfer configuration. A transfer configuration contains all metadata needed to perform a data transfer. For example, `destination_dataset_id` specifies where data should be stored. When a new transfer configuration is created, the specified `destination_dataset_id` is created when needed and shared with the appropriate data source service account.
280 &quot;dataRefreshWindowDays&quot;: 42, # The number of days to look back to automatically refresh the data. For example, if `data_refresh_window_days = 10`, 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.
281 &quot;dataSourceId&quot;: &quot;A String&quot;, # Data source id. Cannot be changed once data transfer is created.
282 &quot;datasetRegion&quot;: &quot;A String&quot;, # Output only. Region in which BigQuery dataset is located.
283 &quot;destinationDatasetId&quot;: &quot;A String&quot;, # The BigQuery target dataset id.
284 &quot;disabled&quot;: True or False, # Is this config disabled. When set to true, no runs are scheduled for a given transfer.
285 &quot;displayName&quot;: &quot;A String&quot;, # User specified display name for the data transfer.
286 &quot;emailPreferences&quot;: { # Represents preferences for sending email notifications for transfer run events. # Email notifications will be sent according to these preferences to the email address of the user who owns this transfer config.
287 &quot;enableFailureEmail&quot;: True or False, # If true, email notifications will be sent on transfer run failures.
288 },
yoshi-code-bot69706592021-03-03 03:54:02 -0800289 &quot;name&quot;: &quot;A String&quot;, # The resource name of the transfer config. Transfer config names have the form `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`. Where `config_id` is usually a uuid, even though it is not guaranteed or required. The name is ignored when creating a transfer config.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800290 &quot;nextRunTime&quot;: &quot;A String&quot;, # Output only. Next time when data transfer will run.
yoshi-code-bot96afc042021-08-24 00:22:31 -0700291 &quot;notificationPubsubTopic&quot;: &quot;A String&quot;, # 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: `projects/{project}/topics/{topic}`
292 &quot;ownerInfo&quot;: { # Information about a user. # Output only. Information about the user whose credentials are used to transfer data. Populated only for `transferConfigs.get` requests. In case the user information is not available, this field will not be populated.
293 &quot;email&quot;: &quot;A String&quot;, # E-mail address of the user.
294 },
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700295 &quot;params&quot;: { # Parameters specific to each data source. For more information see the bq tab in the &#x27;Setting up a data transfer&#x27; section for each data source. For example the parameters for Cloud Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800296 &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
297 },
yoshi-code-bot85954412021-12-06 23:26:37 -0800298 &quot;schedule&quot;: &quot;A String&quot;, # 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: `1st,3rd monday of month 15:30`, `every wed,fri of jan,jun 13:15`, and `first sunday of quarter 00:00`. 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.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800299 &quot;scheduleOptions&quot;: { # Options customizing the data transfer schedule. # Options customizing the data transfer schedule.
300 &quot;disableAutoScheduling&quot;: True or False, # 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.
301 &quot;endTime&quot;: &quot;A String&quot;, # 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.
302 &quot;startTime&quot;: &quot;A String&quot;, # 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.
303 },
304 &quot;state&quot;: &quot;A String&quot;, # Output only. State of the most recently updated transfer run.
305 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Data transfer modification time. Ignored by server on input.
306 &quot;userId&quot;: &quot;A String&quot;, # Deprecated. Unique ID of the user on whose behalf transfer is done.
307 },
308 ],
309}</pre>
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400310</div>
311
312<div class="method">
313 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
314 <pre>Retrieves the next page of results.
315
316Args:
317 previous_request: The request for the previous page. (required)
318 previous_response: The response from the request for the previous page. (required)
319
320Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700321 A request object that you can call &#x27;execute()&#x27; on to request the next
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400322 page. Returns None if there are no more items in the collection.
323 </pre>
324</div>
325
326<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800327 <code class="details" id="patch">patch(name, authorizationCode=None, body=None, serviceAccountName=None, updateMask=None, versionInfo=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700328 <pre>Updates a data transfer configuration. All fields must be set, even if they are not updated.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400329
330Args:
yoshi-code-bot69706592021-03-03 03:54:02 -0800331 name: string, The resource name of the transfer config. Transfer config names have the form `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`. Where `config_id` is usually a uuid, even though it is not guaranteed or required. The name is ignored when creating a transfer config. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700332 body: object, The request body.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400333 The object takes the form of:
334
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700335{ # Represents a data transfer configuration. A transfer configuration contains all metadata needed to perform a data transfer. For example, `destination_dataset_id` specifies where data should be stored. When a new transfer configuration is created, the specified `destination_dataset_id` is created when needed and shared with the appropriate data source service account.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800336 &quot;dataRefreshWindowDays&quot;: 42, # The number of days to look back to automatically refresh the data. For example, if `data_refresh_window_days = 10`, 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.
337 &quot;dataSourceId&quot;: &quot;A String&quot;, # Data source id. Cannot be changed once data transfer is created.
338 &quot;datasetRegion&quot;: &quot;A String&quot;, # Output only. Region in which BigQuery dataset is located.
339 &quot;destinationDatasetId&quot;: &quot;A String&quot;, # The BigQuery target dataset id.
340 &quot;disabled&quot;: True or False, # Is this config disabled. When set to true, no runs are scheduled for a given transfer.
341 &quot;displayName&quot;: &quot;A String&quot;, # User specified display name for the data transfer.
342 &quot;emailPreferences&quot;: { # Represents preferences for sending email notifications for transfer run events. # Email notifications will be sent according to these preferences to the email address of the user who owns this transfer config.
343 &quot;enableFailureEmail&quot;: True or False, # If true, email notifications will be sent on transfer run failures.
344 },
yoshi-code-bot69706592021-03-03 03:54:02 -0800345 &quot;name&quot;: &quot;A String&quot;, # The resource name of the transfer config. Transfer config names have the form `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`. Where `config_id` is usually a uuid, even though it is not guaranteed or required. The name is ignored when creating a transfer config.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800346 &quot;nextRunTime&quot;: &quot;A String&quot;, # Output only. Next time when data transfer will run.
yoshi-code-bot96afc042021-08-24 00:22:31 -0700347 &quot;notificationPubsubTopic&quot;: &quot;A String&quot;, # 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: `projects/{project}/topics/{topic}`
348 &quot;ownerInfo&quot;: { # Information about a user. # Output only. Information about the user whose credentials are used to transfer data. Populated only for `transferConfigs.get` requests. In case the user information is not available, this field will not be populated.
349 &quot;email&quot;: &quot;A String&quot;, # E-mail address of the user.
350 },
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700351 &quot;params&quot;: { # Parameters specific to each data source. For more information see the bq tab in the &#x27;Setting up a data transfer&#x27; section for each data source. For example the parameters for Cloud Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800352 &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
353 },
yoshi-code-bot85954412021-12-06 23:26:37 -0800354 &quot;schedule&quot;: &quot;A String&quot;, # 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: `1st,3rd monday of month 15:30`, `every wed,fri of jan,jun 13:15`, and `first sunday of quarter 00:00`. 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.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800355 &quot;scheduleOptions&quot;: { # Options customizing the data transfer schedule. # Options customizing the data transfer schedule.
356 &quot;disableAutoScheduling&quot;: True or False, # 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.
357 &quot;endTime&quot;: &quot;A String&quot;, # 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.
358 &quot;startTime&quot;: &quot;A String&quot;, # 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.
359 },
360 &quot;state&quot;: &quot;A String&quot;, # Output only. State of the most recently updated transfer run.
361 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Data transfer modification time. Ignored by server on input.
362 &quot;userId&quot;: &quot;A String&quot;, # Deprecated. Unique ID of the user on whose behalf transfer is done.
363}
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400364
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800365 authorizationCode: string, Optional OAuth2 authorization code to use with this transfer configuration. If it is provided, the transfer configuration will be associated with the authorizing user. 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= * 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. * redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800366 serviceAccountName: string, Optional service account name. If this field is set and &quot;service_account_name&quot; is set in update_mask, transfer config will be updated to use this service account credentials. It requires that requesting user calling this API has permissions to act as this service account.
367 updateMask: string, Required. Required list of fields to be updated in this request.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800368 versionInfo: string, Optional version info. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the &quot;none+gsession&quot; response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400369 x__xgafv: string, V1 error format.
370 Allowed values
371 1 - v1 error format
372 2 - v2 error format
373
374Returns:
375 An object of the form:
376
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700377 { # Represents a data transfer configuration. A transfer configuration contains all metadata needed to perform a data transfer. For example, `destination_dataset_id` specifies where data should be stored. When a new transfer configuration is created, the specified `destination_dataset_id` is created when needed and shared with the appropriate data source service account.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800378 &quot;dataRefreshWindowDays&quot;: 42, # The number of days to look back to automatically refresh the data. For example, if `data_refresh_window_days = 10`, 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.
379 &quot;dataSourceId&quot;: &quot;A String&quot;, # Data source id. Cannot be changed once data transfer is created.
380 &quot;datasetRegion&quot;: &quot;A String&quot;, # Output only. Region in which BigQuery dataset is located.
381 &quot;destinationDatasetId&quot;: &quot;A String&quot;, # The BigQuery target dataset id.
382 &quot;disabled&quot;: True or False, # Is this config disabled. When set to true, no runs are scheduled for a given transfer.
383 &quot;displayName&quot;: &quot;A String&quot;, # User specified display name for the data transfer.
384 &quot;emailPreferences&quot;: { # Represents preferences for sending email notifications for transfer run events. # Email notifications will be sent according to these preferences to the email address of the user who owns this transfer config.
385 &quot;enableFailureEmail&quot;: True or False, # If true, email notifications will be sent on transfer run failures.
386 },
yoshi-code-bot69706592021-03-03 03:54:02 -0800387 &quot;name&quot;: &quot;A String&quot;, # The resource name of the transfer config. Transfer config names have the form `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`. Where `config_id` is usually a uuid, even though it is not guaranteed or required. The name is ignored when creating a transfer config.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800388 &quot;nextRunTime&quot;: &quot;A String&quot;, # Output only. Next time when data transfer will run.
yoshi-code-bot96afc042021-08-24 00:22:31 -0700389 &quot;notificationPubsubTopic&quot;: &quot;A String&quot;, # 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: `projects/{project}/topics/{topic}`
390 &quot;ownerInfo&quot;: { # Information about a user. # Output only. Information about the user whose credentials are used to transfer data. Populated only for `transferConfigs.get` requests. In case the user information is not available, this field will not be populated.
391 &quot;email&quot;: &quot;A String&quot;, # E-mail address of the user.
392 },
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700393 &quot;params&quot;: { # Parameters specific to each data source. For more information see the bq tab in the &#x27;Setting up a data transfer&#x27; section for each data source. For example the parameters for Cloud Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800394 &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
395 },
yoshi-code-bot85954412021-12-06 23:26:37 -0800396 &quot;schedule&quot;: &quot;A String&quot;, # 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: `1st,3rd monday of month 15:30`, `every wed,fri of jan,jun 13:15`, and `first sunday of quarter 00:00`. 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.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800397 &quot;scheduleOptions&quot;: { # Options customizing the data transfer schedule. # Options customizing the data transfer schedule.
398 &quot;disableAutoScheduling&quot;: True or False, # 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.
399 &quot;endTime&quot;: &quot;A String&quot;, # 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.
400 &quot;startTime&quot;: &quot;A String&quot;, # 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.
401 },
402 &quot;state&quot;: &quot;A String&quot;, # Output only. State of the most recently updated transfer run.
403 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Data transfer modification time. Ignored by server on input.
404 &quot;userId&quot;: &quot;A String&quot;, # Deprecated. Unique ID of the user on whose behalf transfer is done.
405}</pre>
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400406</div>
407
408<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700409 <code class="details" id="scheduleRuns">scheduleRuns(parent, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700410 <pre>Creates transfer runs for a time range [start_time, end_time]. For each date - or whatever granularity the data source supports - in the range, one transfer run is created. Note that runs are created per UTC time in the time range. DEPRECATED: use StartManualTransferRuns instead.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400411
412Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700413 parent: string, Required. Transfer configuration name in the form: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700414 body: object, The request body.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400415 The object takes the form of:
416
417{ # A request to schedule transfer runs for a time range.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800418 &quot;endTime&quot;: &quot;A String&quot;, # Required. End time of the range of transfer runs. For example, `&quot;2017-05-30T00:00:00+00:00&quot;`.
419 &quot;startTime&quot;: &quot;A String&quot;, # Required. Start time of the range of transfer runs. For example, `&quot;2017-05-25T00:00:00+00:00&quot;`.
420}
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400421
422 x__xgafv: string, V1 error format.
423 Allowed values
424 1 - v1 error format
425 2 - v2 error format
426
427Returns:
428 An object of the form:
429
430 { # A response to schedule transfer runs for a time range.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800431 &quot;runs&quot;: [ # The transfer runs that were scheduled.
432 { # Represents a data transfer run.
433 &quot;dataSourceId&quot;: &quot;A String&quot;, # Output only. Data source id.
434 &quot;destinationDatasetId&quot;: &quot;A String&quot;, # Output only. The BigQuery target dataset id.
435 &quot;emailPreferences&quot;: { # Represents preferences for sending email notifications for transfer run events. # Output only. Email notifications will be sent according to these preferences to the email address of the user who owns the transfer config this run was derived from.
436 &quot;enableFailureEmail&quot;: True or False, # If true, email notifications will be sent on transfer run failures.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700437 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800438 &quot;endTime&quot;: &quot;A String&quot;, # Output only. Time when transfer run ended. Parameter ignored by server for input requests.
439 &quot;errorStatus&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Status of the transfer run.
440 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
441 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
442 {
443 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
444 },
445 ],
446 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
447 },
448 &quot;name&quot;: &quot;A String&quot;, # The resource name of the transfer run. Transfer run names have the form `projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}`. The name is ignored when creating a transfer run.
yoshi-code-bot96afc042021-08-24 00:22:31 -0700449 &quot;notificationPubsubTopic&quot;: &quot;A String&quot;, # Output only. Pub/Sub topic where a notification will be sent after this transfer run finishes. The format for specifying a pubsub topic is: `projects/{project}/topics/{topic}`
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700450 &quot;params&quot;: { # Output only. Parameters specific to each data source. For more information see the bq tab in the &#x27;Setting up a data transfer&#x27; section for each data source. For example the parameters for Cloud Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800451 &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
452 },
453 &quot;runTime&quot;: &quot;A String&quot;, # For batch transfer runs, specifies the date and time of the data should be ingested.
454 &quot;schedule&quot;: &quot;A String&quot;, # Output only. Describes the schedule of this transfer run if it was created as part of a regular schedule. For batch transfer runs that are scheduled manually, this is empty. NOTE: the system might choose to delay the schedule depending on the current load, so `schedule_time` doesn&#x27;t always match this.
455 &quot;scheduleTime&quot;: &quot;A String&quot;, # Minimum time after which a transfer run can be started.
456 &quot;startTime&quot;: &quot;A String&quot;, # Output only. Time when transfer run was started. Parameter ignored by server for input requests.
457 &quot;state&quot;: &quot;A String&quot;, # Data transfer run state. Ignored for input requests.
458 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Last time the data transfer run state was updated.
459 &quot;userId&quot;: &quot;A String&quot;, # Deprecated. Unique ID of the user on whose behalf transfer is done.
460 },
461 ],
462}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700463</div>
464
465<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700466 <code class="details" id="startManualRuns">startManualRuns(parent, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700467 <pre>Start manual transfer runs to be executed now with schedule_time equal to current time. The transfer runs can be created for a time range where the run_time is between start_time (inclusive) and end_time (exclusive), or for a specific run_time.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700468
469Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700470 parent: string, Transfer configuration name in the form: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700471 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700472 The object takes the form of:
473
474{ # A request to start manual transfer runs.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800475 &quot;requestedRunTime&quot;: &quot;A String&quot;, # Specific run_time for a transfer run to be started. The requested_run_time must not be in the future.
476 &quot;requestedTimeRange&quot;: { # A specification for a time range, this will request transfer runs with run_time between start_time (inclusive) and end_time (exclusive). # Time range for the transfer runs that should be started.
477 &quot;endTime&quot;: &quot;A String&quot;, # End time of the range of transfer runs. For example, `&quot;2017-05-30T00:00:00+00:00&quot;`. The end_time must not be in the future. Creates transfer runs where run_time is in the range between start_time (inclusive) and end_time (exclusive).
478 &quot;startTime&quot;: &quot;A String&quot;, # Start time of the range of transfer runs. For example, `&quot;2017-05-25T00:00:00+00:00&quot;`. The start_time must be strictly less than the end_time. Creates transfer runs where run_time is in the range between start_time (inclusive) and end_time (exclusive).
479 },
480}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700481
482 x__xgafv: string, V1 error format.
483 Allowed values
484 1 - v1 error format
485 2 - v2 error format
486
487Returns:
488 An object of the form:
489
490 { # A response to start manual transfer runs.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800491 &quot;runs&quot;: [ # The transfer runs that were created.
492 { # Represents a data transfer run.
493 &quot;dataSourceId&quot;: &quot;A String&quot;, # Output only. Data source id.
494 &quot;destinationDatasetId&quot;: &quot;A String&quot;, # Output only. The BigQuery target dataset id.
495 &quot;emailPreferences&quot;: { # Represents preferences for sending email notifications for transfer run events. # Output only. Email notifications will be sent according to these preferences to the email address of the user who owns the transfer config this run was derived from.
496 &quot;enableFailureEmail&quot;: True or False, # If true, email notifications will be sent on transfer run failures.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400497 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800498 &quot;endTime&quot;: &quot;A String&quot;, # Output only. Time when transfer run ended. Parameter ignored by server for input requests.
499 &quot;errorStatus&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Status of the transfer run.
500 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
501 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
502 {
503 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
504 },
505 ],
506 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
507 },
508 &quot;name&quot;: &quot;A String&quot;, # The resource name of the transfer run. Transfer run names have the form `projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}`. The name is ignored when creating a transfer run.
yoshi-code-bot96afc042021-08-24 00:22:31 -0700509 &quot;notificationPubsubTopic&quot;: &quot;A String&quot;, # Output only. Pub/Sub topic where a notification will be sent after this transfer run finishes. The format for specifying a pubsub topic is: `projects/{project}/topics/{topic}`
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700510 &quot;params&quot;: { # Output only. Parameters specific to each data source. For more information see the bq tab in the &#x27;Setting up a data transfer&#x27; section for each data source. For example the parameters for Cloud Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800511 &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
512 },
513 &quot;runTime&quot;: &quot;A String&quot;, # For batch transfer runs, specifies the date and time of the data should be ingested.
514 &quot;schedule&quot;: &quot;A String&quot;, # Output only. Describes the schedule of this transfer run if it was created as part of a regular schedule. For batch transfer runs that are scheduled manually, this is empty. NOTE: the system might choose to delay the schedule depending on the current load, so `schedule_time` doesn&#x27;t always match this.
515 &quot;scheduleTime&quot;: &quot;A String&quot;, # Minimum time after which a transfer run can be started.
516 &quot;startTime&quot;: &quot;A String&quot;, # Output only. Time when transfer run was started. Parameter ignored by server for input requests.
517 &quot;state&quot;: &quot;A String&quot;, # Data transfer run state. Ignored for input requests.
518 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Last time the data transfer run state was updated.
519 &quot;userId&quot;: &quot;A String&quot;, # Deprecated. Unique ID of the user on whose behalf transfer is done.
520 },
521 ],
522}</pre>
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400523</div>
524
525</body></html>