Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / bigquerydatatransfer_v1.projects.transferConfigs.html
blob: 70ef45ae4c023e753486e03eb9614789dd4120f5 [file] [log] [blame]
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1<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 -0700[diff] [blame]75<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 -0400[diff] [blame]76<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">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]83 <code><a href="#create">create(parent, body=None, authorizationCode=None, serviceAccountName=None, versionInfo=None, x__xgafv=None)</a></code></p>
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]84<p class="firstline">Creates a new data transfer configuration.</p>
85<p class="toc_element">
86 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
87<p class="firstline">Deletes a data transfer configuration,</p>
88<p class="toc_element">
89 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
90<p class="firstline">Returns information about a data transfer config.</p>
91<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]92 <code><a href="#list">list(parent, dataSourceIds=None, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p>
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]93<p class="firstline">Returns information about all data transfers in the project.</p>
94<p class="toc_element">
95 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
96<p class="firstline">Retrieves the next page of results.</p>
97<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]98 <code><a href="#patch">patch(name, body=None, authorizationCode=None, updateMask=None, versionInfo=None, x__xgafv=None, serviceAccountName=None)</a></code></p>
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]99<p class="firstline">Updates a data transfer configuration.</p>
100<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]101 <code><a href="#scheduleRuns">scheduleRuns(parent, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]102<p class="firstline">Creates transfer runs for a time range [start_time, end_time].</p>
103<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]104 <code><a href="#startManualRuns">startManualRuns(parent, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]105<p class="firstline">Start manual transfer runs to be executed now with schedule_time equal to</p>
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]106<h3>Method Details</h3>
107<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]108 <code class="details" id="create">create(parent, body=None, authorizationCode=None, serviceAccountName=None, versionInfo=None, x__xgafv=None)</code>
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]109 <pre>Creates a new data transfer configuration.
110
111Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]112 parent: string, Required. The BigQuery project id where the transfer configuration should be created.
113Must be in the format projects/{project_id}/locations/{location_id} or
114projects/{project_id}. If specified location and location of the
115destination bigquery dataset do not match - the request will fail. (required)
116 body: object, The request body.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]117 The object takes the form of:
118
119{ # Represents a data transfer configuration. A transfer configuration
120 # contains all metadata needed to perform a data transfer. For example,
121 # `destination_dataset_id` specifies where data should be stored.
122 # When a new transfer configuration is created, the specified
123 # `destination_dataset_id` is created when needed and shared with the
124 # appropriate data source service account.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]125 "disabled": True or False, # Is this config disabled. When set to true, no runs are scheduled
126 # for a given transfer.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]127 "updateTime": "A String", # Output only. Data transfer modification time. Ignored by server on input.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]128 "destinationDatasetId": "A String", # The BigQuery target dataset id.
129 "displayName": "A String", # User specified display name for the data transfer.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]130 "name": "A String", # The resource name of the transfer config.
131 # Transfer config names have the form of
132 # `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`.
133 # The name is automatically generated based on the config_id specified in
134 # CreateTransferConfigRequest along with project_id and region. If config_id
135 # is not provided, usually a uuid, even though it is not guaranteed or
136 # required, will be generated for config_id.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]137 "notificationPubsubTopic": "A String", # Pub/Sub topic where notifications will be sent after transfer runs
138 # associated with this transfer config finish.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]139 "schedule": "A String", # Data transfer schedule.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]140 # If the data source does not support a custom schedule, this should be
141 # empty. If it is empty, the default value for the data source will be
142 # used.
143 # The specified times are in UTC.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]144 # Examples of valid format:
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]145 # `1st,3rd monday of month 15:30`,
146 # `every wed,fri of jan,jun 13:15`, and
147 # `first sunday of quarter 00:00`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]148 # See more explanation about the format here:
149 # https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format
150 # NOTE: the granularity should be at least 8 hours, or less frequent.
151 "datasetRegion": "A String", # Output only. Region in which BigQuery dataset is located.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]152 "userId": "A String", # Deprecated. Unique ID of the user on whose behalf transfer is done.
153 "scheduleOptions": { # Options customizing the data transfer schedule. # Options customizing the data transfer schedule.
154 "disableAutoScheduling": True or False, # If true, automatic scheduling of data transfer runs for this configuration
155 # will be disabled. The runs can be started on ad-hoc basis using
156 # StartManualTransferRuns API. When automatic scheduling is disabled, the
157 # TransferConfig.schedule field will be ignored.
158 "endTime": "A String", # Defines time to stop scheduling transfer runs. A transfer run cannot be
159 # scheduled at or after the end time. The end time can be changed at any
160 # moment. The time when a data transfer can be trigerred manually is not
161 # limited by this option.
162 "startTime": "A String", # Specifies time to start scheduling transfer runs. The first run will be
163 # scheduled at or after the start time according to a recurrence pattern
164 # defined in the schedule string. The start time can be changed at any
165 # moment. The time when a data transfer can be trigerred manually is not
166 # limited by this option.
167 },
168 "state": "A String", # Output only. State of the most recently updated transfer run.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]169 "dataSourceId": "A String", # Data source id. Cannot be changed once data transfer is created.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]170 "emailPreferences": { # Represents preferences for sending email notifications for transfer run # Email notifications will be sent according to these preferences
171 # to the email address of the user who owns this transfer config.
172 # events.
173 "enableFailureEmail": True or False, # If true, email notifications will be sent on transfer run failures.
174 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]175 "nextRunTime": "A String", # Output only. Next time when data transfer will run.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]176 "params": { # Data transfer specific parameters.
177 "a_key": "", # Properties of the object.
178 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]179 "dataRefreshWindowDays": 42, # The number of days to look back to automatically refresh the data.
180 # For example, if `data_refresh_window_days = 10`, then every day
181 # BigQuery reingests data for [today-10, today-1], rather than ingesting data
182 # for just [today-1].
183 # Only valid if the data source supports the feature. Set the value to 0
184 # to use the default value.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]185}
186
187 authorizationCode: string, Optional OAuth2 authorization code to use with this transfer configuration.
188This is required if new credentials are needed, as indicated by
189`CheckValidCreds`.
190In order to obtain authorization_code, please make a
191request to
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]192https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&lt;datatransferapiclientid&gt;&amp;scope=&lt;data_source_scopes&gt;&amp;redirect_uri=&lt;redirect_uri&gt;
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]193
194* client_id should be OAuth client_id of BigQuery DTS API for the given
195 data source returned by ListDataSources method.
196* data_source_scopes are the scopes returned by ListDataSources method.
197* redirect_uri is an optional parameter. If not specified, then
198 authorization code is posted to the opener of authorization flow window.
199 Otherwise it will be sent to the redirect uri. A special value of
200 urn:ietf:wg:oauth:2.0:oob means that authorization code should be
201 returned in the title bar of the browser, with the page text prompting
202 the user to copy the code and paste it in the application.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]203 serviceAccountName: string, Optional service account name. If this field is set, transfer config will
204be created with this service account credentials. It requires that
205requesting user calling this API has permissions to act as this service
206account.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]207 versionInfo: string, Optional version info. If users want to find a very recent access token,
208that is, immediately after approving access, users have to set the
209version_info claim in the token request. To obtain the version_info, users
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]210must use the "none+gsession" response type. which be return a
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]211version_info back in the authorization response which be be put in a JWT
212claim in the token request.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]213 x__xgafv: string, V1 error format.
214 Allowed values
215 1 - v1 error format
216 2 - v2 error format
217
218Returns:
219 An object of the form:
220
221 { # Represents a data transfer configuration. A transfer configuration
222 # contains all metadata needed to perform a data transfer. For example,
223 # `destination_dataset_id` specifies where data should be stored.
224 # When a new transfer configuration is created, the specified
225 # `destination_dataset_id` is created when needed and shared with the
226 # appropriate data source service account.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]227 "disabled": True or False, # Is this config disabled. When set to true, no runs are scheduled
228 # for a given transfer.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]229 "updateTime": "A String", # Output only. Data transfer modification time. Ignored by server on input.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]230 "destinationDatasetId": "A String", # The BigQuery target dataset id.
231 "displayName": "A String", # User specified display name for the data transfer.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]232 "name": "A String", # The resource name of the transfer config.
233 # Transfer config names have the form of
234 # `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`.
235 # The name is automatically generated based on the config_id specified in
236 # CreateTransferConfigRequest along with project_id and region. If config_id
237 # is not provided, usually a uuid, even though it is not guaranteed or
238 # required, will be generated for config_id.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]239 "notificationPubsubTopic": "A String", # Pub/Sub topic where notifications will be sent after transfer runs
240 # associated with this transfer config finish.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]241 "schedule": "A String", # Data transfer schedule.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]242 # If the data source does not support a custom schedule, this should be
243 # empty. If it is empty, the default value for the data source will be
244 # used.
245 # The specified times are in UTC.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]246 # Examples of valid format:
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]247 # `1st,3rd monday of month 15:30`,
248 # `every wed,fri of jan,jun 13:15`, and
249 # `first sunday of quarter 00:00`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]250 # See more explanation about the format here:
251 # https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format
252 # NOTE: the granularity should be at least 8 hours, or less frequent.
253 "datasetRegion": "A String", # Output only. Region in which BigQuery dataset is located.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]254 "userId": "A String", # Deprecated. Unique ID of the user on whose behalf transfer is done.
255 "scheduleOptions": { # Options customizing the data transfer schedule. # Options customizing the data transfer schedule.
256 "disableAutoScheduling": True or False, # If true, automatic scheduling of data transfer runs for this configuration
257 # will be disabled. The runs can be started on ad-hoc basis using
258 # StartManualTransferRuns API. When automatic scheduling is disabled, the
259 # TransferConfig.schedule field will be ignored.
260 "endTime": "A String", # Defines time to stop scheduling transfer runs. A transfer run cannot be
261 # scheduled at or after the end time. The end time can be changed at any
262 # moment. The time when a data transfer can be trigerred manually is not
263 # limited by this option.
264 "startTime": "A String", # Specifies time to start scheduling transfer runs. The first run will be
265 # scheduled at or after the start time according to a recurrence pattern
266 # defined in the schedule string. The start time can be changed at any
267 # moment. The time when a data transfer can be trigerred manually is not
268 # limited by this option.
269 },
270 "state": "A String", # Output only. State of the most recently updated transfer run.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]271 "dataSourceId": "A String", # Data source id. Cannot be changed once data transfer is created.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]272 "emailPreferences": { # Represents preferences for sending email notifications for transfer run # Email notifications will be sent according to these preferences
273 # to the email address of the user who owns this transfer config.
274 # events.
275 "enableFailureEmail": True or False, # If true, email notifications will be sent on transfer run failures.
276 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]277 "nextRunTime": "A String", # Output only. Next time when data transfer will run.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]278 "params": { # Data transfer specific parameters.
279 "a_key": "", # Properties of the object.
280 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]281 "dataRefreshWindowDays": 42, # The number of days to look back to automatically refresh the data.
282 # For example, if `data_refresh_window_days = 10`, then every day
283 # BigQuery reingests data for [today-10, today-1], rather than ingesting data
284 # for just [today-1].
285 # Only valid if the data source supports the feature. Set the value to 0
286 # to use the default value.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]287 }</pre>
288</div>
289
290<div class="method">
291 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
292 <pre>Deletes a data transfer configuration,
293including any associated transfer runs and logs.
294
295Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]296 name: string, Required. The field will contain name of the resource requested, for example:
297`projects/{project_id}/transferConfigs/{config_id}` or
298`projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}` (required)
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]299 x__xgafv: string, V1 error format.
300 Allowed values
301 1 - v1 error format
302 2 - v2 error format
303
304Returns:
305 An object of the form:
306
307 { # A generic empty message that you can re-use to avoid defining duplicated
308 # empty messages in your APIs. A typical example is to use it as the request
309 # or the response type of an API method. For instance:
310 #
311 # service Foo {
312 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
313 # }
314 #
315 # The JSON representation for `Empty` is empty JSON object `{}`.
316 }</pre>
317</div>
318
319<div class="method">
320 <code class="details" id="get">get(name, x__xgafv=None)</code>
321 <pre>Returns information about a data transfer config.
322
323Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]324 name: string, Required. The field will contain name of the resource requested, for example:
325`projects/{project_id}/transferConfigs/{config_id}` or
326`projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}` (required)
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]327 x__xgafv: string, V1 error format.
328 Allowed values
329 1 - v1 error format
330 2 - v2 error format
331
332Returns:
333 An object of the form:
334
335 { # Represents a data transfer configuration. A transfer configuration
336 # contains all metadata needed to perform a data transfer. For example,
337 # `destination_dataset_id` specifies where data should be stored.
338 # When a new transfer configuration is created, the specified
339 # `destination_dataset_id` is created when needed and shared with the
340 # appropriate data source service account.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]341 "disabled": True or False, # Is this config disabled. When set to true, no runs are scheduled
342 # for a given transfer.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]343 "updateTime": "A String", # Output only. Data transfer modification time. Ignored by server on input.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]344 "destinationDatasetId": "A String", # The BigQuery target dataset id.
345 "displayName": "A String", # User specified display name for the data transfer.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]346 "name": "A String", # The resource name of the transfer config.
347 # Transfer config names have the form of
348 # `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`.
349 # The name is automatically generated based on the config_id specified in
350 # CreateTransferConfigRequest along with project_id and region. If config_id
351 # is not provided, usually a uuid, even though it is not guaranteed or
352 # required, will be generated for config_id.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]353 "notificationPubsubTopic": "A String", # Pub/Sub topic where notifications will be sent after transfer runs
354 # associated with this transfer config finish.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]355 "schedule": "A String", # Data transfer schedule.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]356 # If the data source does not support a custom schedule, this should be
357 # empty. If it is empty, the default value for the data source will be
358 # used.
359 # The specified times are in UTC.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]360 # Examples of valid format:
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]361 # `1st,3rd monday of month 15:30`,
362 # `every wed,fri of jan,jun 13:15`, and
363 # `first sunday of quarter 00:00`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]364 # See more explanation about the format here:
365 # https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format
366 # NOTE: the granularity should be at least 8 hours, or less frequent.
367 "datasetRegion": "A String", # Output only. Region in which BigQuery dataset is located.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]368 "userId": "A String", # Deprecated. Unique ID of the user on whose behalf transfer is done.
369 "scheduleOptions": { # Options customizing the data transfer schedule. # Options customizing the data transfer schedule.
370 "disableAutoScheduling": True or False, # If true, automatic scheduling of data transfer runs for this configuration
371 # will be disabled. The runs can be started on ad-hoc basis using
372 # StartManualTransferRuns API. When automatic scheduling is disabled, the
373 # TransferConfig.schedule field will be ignored.
374 "endTime": "A String", # Defines time to stop scheduling transfer runs. A transfer run cannot be
375 # scheduled at or after the end time. The end time can be changed at any
376 # moment. The time when a data transfer can be trigerred manually is not
377 # limited by this option.
378 "startTime": "A String", # Specifies time to start scheduling transfer runs. The first run will be
379 # scheduled at or after the start time according to a recurrence pattern
380 # defined in the schedule string. The start time can be changed at any
381 # moment. The time when a data transfer can be trigerred manually is not
382 # limited by this option.
383 },
384 "state": "A String", # Output only. State of the most recently updated transfer run.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]385 "dataSourceId": "A String", # Data source id. Cannot be changed once data transfer is created.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]386 "emailPreferences": { # Represents preferences for sending email notifications for transfer run # Email notifications will be sent according to these preferences
387 # to the email address of the user who owns this transfer config.
388 # events.
389 "enableFailureEmail": True or False, # If true, email notifications will be sent on transfer run failures.
390 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]391 "nextRunTime": "A String", # Output only. Next time when data transfer will run.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]392 "params": { # Data transfer specific parameters.
393 "a_key": "", # Properties of the object.
394 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]395 "dataRefreshWindowDays": 42, # The number of days to look back to automatically refresh the data.
396 # For example, if `data_refresh_window_days = 10`, then every day
397 # BigQuery reingests data for [today-10, today-1], rather than ingesting data
398 # for just [today-1].
399 # Only valid if the data source supports the feature. Set the value to 0
400 # to use the default value.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]401 }</pre>
402</div>
403
404<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]405 <code class="details" id="list">list(parent, dataSourceIds=None, pageToken=None, x__xgafv=None, pageSize=None)</code>
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]406 <pre>Returns information about all data transfers in the project.
407
408Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]409 parent: string, Required. The BigQuery project id for which data sources
410should be returned: `projects/{project_id}` or
411`projects/{project_id}/locations/{location_id}` (required)
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]412 dataSourceIds: string, When specified, only configurations of requested data sources are returned. (repeated)
413 pageToken: string, Pagination token, which can be used to request a specific page
414of `ListTransfersRequest` list results. For multiple-page
415results, `ListTransfersResponse` outputs
416a `next_page` token, which can be used as the
417`page_token` value to request the next page of list results.
418 x__xgafv: string, V1 error format.
419 Allowed values
420 1 - v1 error format
421 2 - v2 error format
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]422 pageSize: integer, Page size. The default page size is the maximum value of 1000 results.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]423
424Returns:
425 An object of the form:
426
427 { # The returned list of pipelines in the project.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]428 "nextPageToken": "A String", # Output only. The next-pagination token. For multiple-page list results,
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]429 # this token can be used as the
430 # `ListTransferConfigsRequest.page_token`
431 # to request the next page of list results.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]432 "transferConfigs": [ # Output only. The stored pipeline transfer configurations.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]433 { # Represents a data transfer configuration. A transfer configuration
434 # contains all metadata needed to perform a data transfer. For example,
435 # `destination_dataset_id` specifies where data should be stored.
436 # When a new transfer configuration is created, the specified
437 # `destination_dataset_id` is created when needed and shared with the
438 # appropriate data source service account.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]439 "disabled": True or False, # Is this config disabled. When set to true, no runs are scheduled
440 # for a given transfer.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]441 "updateTime": "A String", # Output only. Data transfer modification time. Ignored by server on input.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]442 "destinationDatasetId": "A String", # The BigQuery target dataset id.
443 "displayName": "A String", # User specified display name for the data transfer.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]444 "name": "A String", # The resource name of the transfer config.
445 # Transfer config names have the form of
446 # `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`.
447 # The name is automatically generated based on the config_id specified in
448 # CreateTransferConfigRequest along with project_id and region. If config_id
449 # is not provided, usually a uuid, even though it is not guaranteed or
450 # required, will be generated for config_id.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]451 "notificationPubsubTopic": "A String", # Pub/Sub topic where notifications will be sent after transfer runs
452 # associated with this transfer config finish.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]453 "schedule": "A String", # Data transfer schedule.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]454 # If the data source does not support a custom schedule, this should be
455 # empty. If it is empty, the default value for the data source will be
456 # used.
457 # The specified times are in UTC.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]458 # Examples of valid format:
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]459 # `1st,3rd monday of month 15:30`,
460 # `every wed,fri of jan,jun 13:15`, and
461 # `first sunday of quarter 00:00`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]462 # See more explanation about the format here:
463 # https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format
464 # NOTE: the granularity should be at least 8 hours, or less frequent.
465 "datasetRegion": "A String", # Output only. Region in which BigQuery dataset is located.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]466 "userId": "A String", # Deprecated. Unique ID of the user on whose behalf transfer is done.
467 "scheduleOptions": { # Options customizing the data transfer schedule. # Options customizing the data transfer schedule.
468 "disableAutoScheduling": True or False, # If true, automatic scheduling of data transfer runs for this configuration
469 # will be disabled. The runs can be started on ad-hoc basis using
470 # StartManualTransferRuns API. When automatic scheduling is disabled, the
471 # TransferConfig.schedule field will be ignored.
472 "endTime": "A String", # Defines time to stop scheduling transfer runs. A transfer run cannot be
473 # scheduled at or after the end time. The end time can be changed at any
474 # moment. The time when a data transfer can be trigerred manually is not
475 # limited by this option.
476 "startTime": "A String", # Specifies time to start scheduling transfer runs. The first run will be
477 # scheduled at or after the start time according to a recurrence pattern
478 # defined in the schedule string. The start time can be changed at any
479 # moment. The time when a data transfer can be trigerred manually is not
480 # limited by this option.
481 },
482 "state": "A String", # Output only. State of the most recently updated transfer run.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]483 "dataSourceId": "A String", # Data source id. Cannot be changed once data transfer is created.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]484 "emailPreferences": { # Represents preferences for sending email notifications for transfer run # Email notifications will be sent according to these preferences
485 # to the email address of the user who owns this transfer config.
486 # events.
487 "enableFailureEmail": True or False, # If true, email notifications will be sent on transfer run failures.
488 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]489 "nextRunTime": "A String", # Output only. Next time when data transfer will run.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]490 "params": { # Data transfer specific parameters.
491 "a_key": "", # Properties of the object.
492 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]493 "dataRefreshWindowDays": 42, # The number of days to look back to automatically refresh the data.
494 # For example, if `data_refresh_window_days = 10`, then every day
495 # BigQuery reingests data for [today-10, today-1], rather than ingesting data
496 # for just [today-1].
497 # Only valid if the data source supports the feature. Set the value to 0
498 # to use the default value.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]499 },
500 ],
501 }</pre>
502</div>
503
504<div class="method">
505 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
506 <pre>Retrieves the next page of results.
507
508Args:
509 previous_request: The request for the previous page. (required)
510 previous_response: The response from the request for the previous page. (required)
511
512Returns:
513 A request object that you can call 'execute()' on to request the next
514 page. Returns None if there are no more items in the collection.
515 </pre>
516</div>
517
518<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]519 <code class="details" id="patch">patch(name, body=None, authorizationCode=None, updateMask=None, versionInfo=None, x__xgafv=None, serviceAccountName=None)</code>
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]520 <pre>Updates a data transfer configuration.
521All fields must be set, even if they are not updated.
522
523Args:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]524 name: string, The resource name of the transfer config.
525Transfer config names have the form of
526`projects/{project_id}/locations/{region}/transferConfigs/{config_id}`.
527The name is automatically generated based on the config_id specified in
528CreateTransferConfigRequest along with project_id and region. If config_id
529is not provided, usually a uuid, even though it is not guaranteed or
530required, will be generated for config_id. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]531 body: object, The request body.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]532 The object takes the form of:
533
534{ # Represents a data transfer configuration. A transfer configuration
535 # contains all metadata needed to perform a data transfer. For example,
536 # `destination_dataset_id` specifies where data should be stored.
537 # When a new transfer configuration is created, the specified
538 # `destination_dataset_id` is created when needed and shared with the
539 # appropriate data source service account.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]540 "disabled": True or False, # Is this config disabled. When set to true, no runs are scheduled
541 # for a given transfer.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]542 "updateTime": "A String", # Output only. Data transfer modification time. Ignored by server on input.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]543 "destinationDatasetId": "A String", # The BigQuery target dataset id.
544 "displayName": "A String", # User specified display name for the data transfer.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]545 "name": "A String", # The resource name of the transfer config.
546 # Transfer config names have the form of
547 # `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`.
548 # The name is automatically generated based on the config_id specified in
549 # CreateTransferConfigRequest along with project_id and region. If config_id
550 # is not provided, usually a uuid, even though it is not guaranteed or
551 # required, will be generated for config_id.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]552 "notificationPubsubTopic": "A String", # Pub/Sub topic where notifications will be sent after transfer runs
553 # associated with this transfer config finish.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]554 "schedule": "A String", # Data transfer schedule.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]555 # If the data source does not support a custom schedule, this should be
556 # empty. If it is empty, the default value for the data source will be
557 # used.
558 # The specified times are in UTC.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]559 # Examples of valid format:
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]560 # `1st,3rd monday of month 15:30`,
561 # `every wed,fri of jan,jun 13:15`, and
562 # `first sunday of quarter 00:00`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]563 # See more explanation about the format here:
564 # https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format
565 # NOTE: the granularity should be at least 8 hours, or less frequent.
566 "datasetRegion": "A String", # Output only. Region in which BigQuery dataset is located.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]567 "userId": "A String", # Deprecated. Unique ID of the user on whose behalf transfer is done.
568 "scheduleOptions": { # Options customizing the data transfer schedule. # Options customizing the data transfer schedule.
569 "disableAutoScheduling": True or False, # If true, automatic scheduling of data transfer runs for this configuration
570 # will be disabled. The runs can be started on ad-hoc basis using
571 # StartManualTransferRuns API. When automatic scheduling is disabled, the
572 # TransferConfig.schedule field will be ignored.
573 "endTime": "A String", # Defines time to stop scheduling transfer runs. A transfer run cannot be
574 # scheduled at or after the end time. The end time can be changed at any
575 # moment. The time when a data transfer can be trigerred manually is not
576 # limited by this option.
577 "startTime": "A String", # Specifies time to start scheduling transfer runs. The first run will be
578 # scheduled at or after the start time according to a recurrence pattern
579 # defined in the schedule string. The start time can be changed at any
580 # moment. The time when a data transfer can be trigerred manually is not
581 # limited by this option.
582 },
583 "state": "A String", # Output only. State of the most recently updated transfer run.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]584 "dataSourceId": "A String", # Data source id. Cannot be changed once data transfer is created.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]585 "emailPreferences": { # Represents preferences for sending email notifications for transfer run # Email notifications will be sent according to these preferences
586 # to the email address of the user who owns this transfer config.
587 # events.
588 "enableFailureEmail": True or False, # If true, email notifications will be sent on transfer run failures.
589 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]590 "nextRunTime": "A String", # Output only. Next time when data transfer will run.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]591 "params": { # Data transfer specific parameters.
592 "a_key": "", # Properties of the object.
593 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]594 "dataRefreshWindowDays": 42, # The number of days to look back to automatically refresh the data.
595 # For example, if `data_refresh_window_days = 10`, then every day
596 # BigQuery reingests data for [today-10, today-1], rather than ingesting data
597 # for just [today-1].
598 # Only valid if the data source supports the feature. Set the value to 0
599 # to use the default value.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]600}
601
602 authorizationCode: string, Optional OAuth2 authorization code to use with this transfer configuration.
603If it is provided, the transfer configuration will be associated with the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]604authorizing user.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]605In order to obtain authorization_code, please make a
606request to
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]607https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&lt;datatransferapiclientid&gt;&amp;scope=&lt;data_source_scopes&gt;&amp;redirect_uri=&lt;redirect_uri&gt;
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]608
609* client_id should be OAuth client_id of BigQuery DTS API for the given
610 data source returned by ListDataSources method.
611* data_source_scopes are the scopes returned by ListDataSources method.
612* redirect_uri is an optional parameter. If not specified, then
613 authorization code is posted to the opener of authorization flow window.
614 Otherwise it will be sent to the redirect uri. A special value of
615 urn:ietf:wg:oauth:2.0:oob means that authorization code should be
616 returned in the title bar of the browser, with the page text prompting
617 the user to copy the code and paste it in the application.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]618 updateMask: string, Required. Required list of fields to be updated in this request.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]619 versionInfo: string, Optional version info. If users want to find a very recent access token,
620that is, immediately after approving access, users have to set the
621version_info claim in the token request. To obtain the version_info, users
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]622must use the "none+gsession" response type. which be return a
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]623version_info back in the authorization response which be be put in a JWT
624claim in the token request.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]625 x__xgafv: string, V1 error format.
626 Allowed values
627 1 - v1 error format
628 2 - v2 error format
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]629 serviceAccountName: string, Optional service account name. If this field is set and
630"service_account_name" is set in update_mask, transfer config will be
631updated to use this service account credentials. It requires that
632requesting user calling this API has permissions to act as this service
633account.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]634
635Returns:
636 An object of the form:
637
638 { # Represents a data transfer configuration. A transfer configuration
639 # contains all metadata needed to perform a data transfer. For example,
640 # `destination_dataset_id` specifies where data should be stored.
641 # When a new transfer configuration is created, the specified
642 # `destination_dataset_id` is created when needed and shared with the
643 # appropriate data source service account.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]644 "disabled": True or False, # Is this config disabled. When set to true, no runs are scheduled
645 # for a given transfer.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]646 "updateTime": "A String", # Output only. Data transfer modification time. Ignored by server on input.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]647 "destinationDatasetId": "A String", # The BigQuery target dataset id.
648 "displayName": "A String", # User specified display name for the data transfer.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]649 "name": "A String", # The resource name of the transfer config.
650 # Transfer config names have the form of
651 # `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`.
652 # The name is automatically generated based on the config_id specified in
653 # CreateTransferConfigRequest along with project_id and region. If config_id
654 # is not provided, usually a uuid, even though it is not guaranteed or
655 # required, will be generated for config_id.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]656 "notificationPubsubTopic": "A String", # Pub/Sub topic where notifications will be sent after transfer runs
657 # associated with this transfer config finish.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]658 "schedule": "A String", # Data transfer schedule.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]659 # If the data source does not support a custom schedule, this should be
660 # empty. If it is empty, the default value for the data source will be
661 # used.
662 # The specified times are in UTC.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]663 # Examples of valid format:
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]664 # `1st,3rd monday of month 15:30`,
665 # `every wed,fri of jan,jun 13:15`, and
666 # `first sunday of quarter 00:00`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]667 # See more explanation about the format here:
668 # https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format
669 # NOTE: the granularity should be at least 8 hours, or less frequent.
670 "datasetRegion": "A String", # Output only. Region in which BigQuery dataset is located.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]671 "userId": "A String", # Deprecated. Unique ID of the user on whose behalf transfer is done.
672 "scheduleOptions": { # Options customizing the data transfer schedule. # Options customizing the data transfer schedule.
673 "disableAutoScheduling": True or False, # If true, automatic scheduling of data transfer runs for this configuration
674 # will be disabled. The runs can be started on ad-hoc basis using
675 # StartManualTransferRuns API. When automatic scheduling is disabled, the
676 # TransferConfig.schedule field will be ignored.
677 "endTime": "A String", # Defines time to stop scheduling transfer runs. A transfer run cannot be
678 # scheduled at or after the end time. The end time can be changed at any
679 # moment. The time when a data transfer can be trigerred manually is not
680 # limited by this option.
681 "startTime": "A String", # Specifies time to start scheduling transfer runs. The first run will be
682 # scheduled at or after the start time according to a recurrence pattern
683 # defined in the schedule string. The start time can be changed at any
684 # moment. The time when a data transfer can be trigerred manually is not
685 # limited by this option.
686 },
687 "state": "A String", # Output only. State of the most recently updated transfer run.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]688 "dataSourceId": "A String", # Data source id. Cannot be changed once data transfer is created.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]689 "emailPreferences": { # Represents preferences for sending email notifications for transfer run # Email notifications will be sent according to these preferences
690 # to the email address of the user who owns this transfer config.
691 # events.
692 "enableFailureEmail": True or False, # If true, email notifications will be sent on transfer run failures.
693 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]694 "nextRunTime": "A String", # Output only. Next time when data transfer will run.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]695 "params": { # Data transfer specific parameters.
696 "a_key": "", # Properties of the object.
697 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]698 "dataRefreshWindowDays": 42, # The number of days to look back to automatically refresh the data.
699 # For example, if `data_refresh_window_days = 10`, then every day
700 # BigQuery reingests data for [today-10, today-1], rather than ingesting data
701 # for just [today-1].
702 # Only valid if the data source supports the feature. Set the value to 0
703 # to use the default value.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]704 }</pre>
705</div>
706
707<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]708 <code class="details" id="scheduleRuns">scheduleRuns(parent, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]709 <pre>Creates transfer runs for a time range [start_time, end_time].
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]710For each date - or whatever granularity the data source supports - in the
711range, one transfer run is created.
712Note that runs are created per UTC time in the time range.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]713DEPRECATED: use StartManualTransferRuns instead.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]714
715Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]716 parent: string, Required. Transfer configuration name in the form:
717`projects/{project_id}/transferConfigs/{config_id}` or
718`projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`. (required)
719 body: object, The request body.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]720 The object takes the form of:
721
722{ # A request to schedule transfer runs for a time range.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]723 "endTime": "A String", # Required. End time of the range of transfer runs. For example,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]724 # `"2017-05-30T00:00:00+00:00"`.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]725 "startTime": "A String", # Required. Start time of the range of transfer runs. For example,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]726 # `"2017-05-25T00:00:00+00:00"`.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]727 }
728
729 x__xgafv: string, V1 error format.
730 Allowed values
731 1 - v1 error format
732 2 - v2 error format
733
734Returns:
735 An object of the form:
736
737 { # A response to schedule transfer runs for a time range.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]738 "runs": [ # The transfer runs that were scheduled.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]739 { # Represents a data transfer run.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]740 "updateTime": "A String", # Output only. Last time the data transfer run state was updated.
741 "destinationDatasetId": "A String", # Output only. The BigQuery target dataset id.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]742 "name": "A String", # The resource name of the transfer run.
743 # Transfer run names have the form
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]744 # `projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}`.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]745 # The name is ignored when creating a transfer run.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]746 "notificationPubsubTopic": "A String", # Output only. Pub/Sub topic where a notification will be sent after this
747 # transfer run finishes
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]748 "schedule": "A String", # Output only. Describes the schedule of this transfer run if it was
749 # created as part of a regular schedule. For batch transfer runs that are
750 # scheduled manually, this is empty.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]751 # NOTE: the system might choose to delay the schedule depending on the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]752 # current load, so `schedule_time` doesn't always match this.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]753 "startTime": "A String", # Output only. Time when transfer run was started.
754 # Parameter ignored by server for input requests.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]755 "userId": "A String", # Deprecated. Unique ID of the user on whose behalf transfer is done.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]756 "scheduleTime": "A String", # Minimum time after which a transfer run can be started.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]757 "state": "A String", # Data transfer run state. Ignored for input requests.
758 "errorStatus": { # The `Status` type defines a logical error model that is suitable for # Status of the transfer run.
759 # different programming environments, including REST APIs and RPC APIs. It is
760 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
761 # three pieces of data: error code, error message, and error details.
762 #
763 # You can find out more about this error model and how to work with it in the
764 # [API Design Guide](https://cloud.google.com/apis/design/errors).
765 "message": "A String", # A developer-facing error message, which should be in English. Any
766 # user-facing error message should be localized and sent in the
767 # google.rpc.Status.details field, or localized by the client.
768 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
769 "details": [ # A list of messages that carry the error details. There is a common set of
770 # message types for APIs to use.
771 {
772 "a_key": "", # Properties of the object. Contains field @type with type URL.
773 },
774 ],
775 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]776 "dataSourceId": "A String", # Output only. Data source id.
777 "emailPreferences": { # Represents preferences for sending email notifications for transfer run # Output only. Email notifications will be sent according to these
778 # preferences to the email address of the user who owns the transfer config
779 # this run was derived from.
780 # events.
781 "enableFailureEmail": True or False, # If true, email notifications will be sent on transfer run failures.
782 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]783 "params": { # Output only. Data transfer specific parameters.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]784 "a_key": "", # Properties of the object.
785 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]786 "runTime": "A String", # For batch transfer runs, specifies the date and time of the data should be
787 # ingested.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]788 "endTime": "A String", # Output only. Time when transfer run ended.
789 # Parameter ignored by server for input requests.
790 },
791 ],
792 }</pre>
793</div>
794
795<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]796 <code class="details" id="startManualRuns">startManualRuns(parent, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]797 <pre>Start manual transfer runs to be executed now with schedule_time equal to
798current time. The transfer runs can be created for a time range where the
799run_time is between start_time (inclusive) and end_time (exclusive), or for
800a specific run_time.
801
802Args:
803 parent: string, Transfer configuration name in the form:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]804`projects/{project_id}/transferConfigs/{config_id}` or
805`projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`. (required)
806 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]807 The object takes the form of:
808
809{ # A request to start manual transfer runs.
810 "requestedTimeRange": { # A specification for a time range, this will request transfer runs with # Time range for the transfer runs that should be started.
811 # run_time between start_time (inclusive) and end_time (exclusive).
812 "endTime": "A String", # End time of the range of transfer runs. For example,
813 # `"2017-05-30T00:00:00+00:00"`. The end_time must not be in the future.
814 # Creates transfer runs where run_time is in the range betwen start_time
815 # (inclusive) and end_time (exlusive).
816 "startTime": "A String", # Start time of the range of transfer runs. For example,
817 # `"2017-05-25T00:00:00+00:00"`. The start_time must be strictly less than
818 # the end_time. Creates transfer runs where run_time is in the range betwen
819 # start_time (inclusive) and end_time (exlusive).
820 },
821 "requestedRunTime": "A String", # Specific run_time for a transfer run to be started. The
822 # requested_run_time must not be in the future.
823 }
824
825 x__xgafv: string, V1 error format.
826 Allowed values
827 1 - v1 error format
828 2 - v2 error format
829
830Returns:
831 An object of the form:
832
833 { # A response to start manual transfer runs.
834 "runs": [ # The transfer runs that were created.
835 { # Represents a data transfer run.
836 "updateTime": "A String", # Output only. Last time the data transfer run state was updated.
837 "destinationDatasetId": "A String", # Output only. The BigQuery target dataset id.
838 "name": "A String", # The resource name of the transfer run.
839 # Transfer run names have the form
840 # `projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}`.
841 # The name is ignored when creating a transfer run.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]842 "notificationPubsubTopic": "A String", # Output only. Pub/Sub topic where a notification will be sent after this
843 # transfer run finishes
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]844 "schedule": "A String", # Output only. Describes the schedule of this transfer run if it was
845 # created as part of a regular schedule. For batch transfer runs that are
846 # scheduled manually, this is empty.
847 # NOTE: the system might choose to delay the schedule depending on the
848 # current load, so `schedule_time` doesn't always match this.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]849 "startTime": "A String", # Output only. Time when transfer run was started.
850 # Parameter ignored by server for input requests.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]851 "userId": "A String", # Deprecated. Unique ID of the user on whose behalf transfer is done.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]852 "scheduleTime": "A String", # Minimum time after which a transfer run can be started.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]853 "state": "A String", # Data transfer run state. Ignored for input requests.
854 "errorStatus": { # The `Status` type defines a logical error model that is suitable for # Status of the transfer run.
855 # different programming environments, including REST APIs and RPC APIs. It is
856 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
857 # three pieces of data: error code, error message, and error details.
858 #
859 # You can find out more about this error model and how to work with it in the
860 # [API Design Guide](https://cloud.google.com/apis/design/errors).
861 "message": "A String", # A developer-facing error message, which should be in English. Any
862 # user-facing error message should be localized and sent in the
863 # google.rpc.Status.details field, or localized by the client.
864 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
865 "details": [ # A list of messages that carry the error details. There is a common set of
866 # message types for APIs to use.
867 {
868 "a_key": "", # Properties of the object. Contains field @type with type URL.
869 },
870 ],
871 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]872 "dataSourceId": "A String", # Output only. Data source id.
873 "emailPreferences": { # Represents preferences for sending email notifications for transfer run # Output only. Email notifications will be sent according to these
874 # preferences to the email address of the user who owns the transfer config
875 # this run was derived from.
876 # events.
877 "enableFailureEmail": True or False, # If true, email notifications will be sent on transfer run failures.
878 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]879 "params": { # Output only. Data transfer specific parameters.
880 "a_key": "", # Properties of the object.
881 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]882 "runTime": "A String", # For batch transfer runs, specifies the date and time of the data should be
883 # ingested.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]884 "endTime": "A String", # Output only. Time when transfer run ended.
885 # Parameter ignored by server for input requests.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]886 },
887 ],
888 }</pre>
889</div>
890
891</body></html>