chore: regens API reference docs (#889)
diff --git a/docs/dyn/bigquerydatatransfer_v1.projects.transferConfigs.html b/docs/dyn/bigquerydatatransfer_v1.projects.transferConfigs.html
index a535d94..70ef45a 100644
--- a/docs/dyn/bigquerydatatransfer_v1.projects.transferConfigs.html
+++ b/docs/dyn/bigquerydatatransfer_v1.projects.transferConfigs.html
@@ -80,7 +80,7 @@
<p class="firstline">Returns the runs Resource.</p>
<p class="toc_element">
- <code><a href="#create">create(parent, body, authorizationCode=None, versionInfo=None, x__xgafv=None)</a></code></p>
+ <code><a href="#create">create(parent, body=None, authorizationCode=None, serviceAccountName=None, versionInfo=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new data transfer configuration.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
@@ -89,31 +89,31 @@
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Returns information about a data transfer config.</p>
<p class="toc_element">
- <code><a href="#list">list(parent, pageSize=None, dataSourceIds=None, pageToken=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(parent, dataSourceIds=None, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p>
<p class="firstline">Returns information about all data transfers in the project.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
- <code><a href="#patch">patch(name, body, authorizationCode=None, updateMask=None, versionInfo=None, x__xgafv=None)</a></code></p>
+ <code><a href="#patch">patch(name, body=None, authorizationCode=None, updateMask=None, versionInfo=None, x__xgafv=None, serviceAccountName=None)</a></code></p>
<p class="firstline">Updates a data transfer configuration.</p>
<p class="toc_element">
- <code><a href="#scheduleRuns">scheduleRuns(parent, body, x__xgafv=None)</a></code></p>
+ <code><a href="#scheduleRuns">scheduleRuns(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates transfer runs for a time range [start_time, end_time].</p>
<p class="toc_element">
- <code><a href="#startManualRuns">startManualRuns(parent, body, x__xgafv=None)</a></code></p>
+ <code><a href="#startManualRuns">startManualRuns(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Start manual transfer runs to be executed now with schedule_time equal to</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="create">create(parent, body, authorizationCode=None, versionInfo=None, x__xgafv=None)</code>
+ <code class="details" id="create">create(parent, body=None, authorizationCode=None, serviceAccountName=None, versionInfo=None, x__xgafv=None)</code>
<pre>Creates a new data transfer configuration.
Args:
- parent: string, The BigQuery project id where the transfer configuration should be created.
-Must be in the format projects/{project_id}/locations/{location_id}
-If specified location and location of the destination bigquery dataset
-do not match - the request will fail. (required)
- body: object, The request body. (required)
+ 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)
+ body: object, The request body.
The object takes the form of:
{ # Represents a data transfer configuration. A transfer configuration
@@ -122,12 +122,8 @@
# 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.
- "dataRefreshWindowDays": 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.
+ "disabled": True or False, # Is this config disabled. When set to true, no runs are scheduled
+ # for a given transfer.
"updateTime": "A String", # Output only. Data transfer modification time. Ignored by server on input.
"destinationDatasetId": "A String", # The BigQuery target dataset id.
"displayName": "A String", # User specified display name for the data transfer.
@@ -138,6 +134,8 @@
# CreateTransferConfigRequest along with project_id and region. If config_id
# is not provided, usually a uuid, even though it is not guaranteed or
# required, will be generated for config_id.
+ "notificationPubsubTopic": "A String", # Pub/Sub topic where notifications will be sent after transfer runs
+ # associated with this transfer config finish.
"schedule": "A String", # 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
@@ -151,8 +149,6 @@
# https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format
# NOTE: the granularity should be at least 8 hours, or less frequent.
"datasetRegion": "A String", # Output only. Region in which BigQuery dataset is located.
- "disabled": True or False, # Is this config disabled. When set to true, no runs are scheduled
- # for a given transfer.
"userId": "A String", # Deprecated. Unique ID of the user on whose behalf transfer is done.
"scheduleOptions": { # Options customizing the data transfer schedule. # Options customizing the data transfer schedule.
"disableAutoScheduling": True or False, # If true, automatic scheduling of data transfer runs for this configuration
@@ -171,10 +167,21 @@
},
"state": "A String", # Output only. State of the most recently updated transfer run.
"dataSourceId": "A String", # Data source id. Cannot be changed once data transfer is created.
+ "emailPreferences": { # Represents preferences for sending email notifications for transfer run # Email notifications will be sent according to these preferences
+ # to the email address of the user who owns this transfer config.
+ # events.
+ "enableFailureEmail": True or False, # If true, email notifications will be sent on transfer run failures.
+ },
"nextRunTime": "A String", # Output only. Next time when data transfer will run.
"params": { # Data transfer specific parameters.
"a_key": "", # Properties of the object.
},
+ "dataRefreshWindowDays": 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.
}
authorizationCode: string, Optional OAuth2 authorization code to use with this transfer configuration.
@@ -182,7 +189,7 @@
`CheckValidCreds`.
In order to obtain authorization_code, please make a
request to
-https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=<datatransferapiclientid>&scope=<data_source_scopes>&redirect_uri=<redirect_uri>
+https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=<datatransferapiclientid>&scope=<data_source_scopes>&redirect_uri=<redirect_uri>
* client_id should be OAuth client_id of BigQuery DTS API for the given
data source returned by ListDataSources method.
@@ -193,10 +200,14 @@
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.
+ 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.
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 “none+gsession” response type. which be return a
+must use the "none+gsession" 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.
x__xgafv: string, V1 error format.
@@ -213,12 +224,8 @@
# 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.
- "dataRefreshWindowDays": 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.
+ "disabled": True or False, # Is this config disabled. When set to true, no runs are scheduled
+ # for a given transfer.
"updateTime": "A String", # Output only. Data transfer modification time. Ignored by server on input.
"destinationDatasetId": "A String", # The BigQuery target dataset id.
"displayName": "A String", # User specified display name for the data transfer.
@@ -229,6 +236,8 @@
# CreateTransferConfigRequest along with project_id and region. If config_id
# is not provided, usually a uuid, even though it is not guaranteed or
# required, will be generated for config_id.
+ "notificationPubsubTopic": "A String", # Pub/Sub topic where notifications will be sent after transfer runs
+ # associated with this transfer config finish.
"schedule": "A String", # 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
@@ -242,8 +251,6 @@
# https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format
# NOTE: the granularity should be at least 8 hours, or less frequent.
"datasetRegion": "A String", # Output only. Region in which BigQuery dataset is located.
- "disabled": True or False, # Is this config disabled. When set to true, no runs are scheduled
- # for a given transfer.
"userId": "A String", # Deprecated. Unique ID of the user on whose behalf transfer is done.
"scheduleOptions": { # Options customizing the data transfer schedule. # Options customizing the data transfer schedule.
"disableAutoScheduling": True or False, # If true, automatic scheduling of data transfer runs for this configuration
@@ -262,10 +269,21 @@
},
"state": "A String", # Output only. State of the most recently updated transfer run.
"dataSourceId": "A String", # Data source id. Cannot be changed once data transfer is created.
+ "emailPreferences": { # Represents preferences for sending email notifications for transfer run # Email notifications will be sent according to these preferences
+ # to the email address of the user who owns this transfer config.
+ # events.
+ "enableFailureEmail": True or False, # If true, email notifications will be sent on transfer run failures.
+ },
"nextRunTime": "A String", # Output only. Next time when data transfer will run.
"params": { # Data transfer specific parameters.
"a_key": "", # Properties of the object.
},
+ "dataRefreshWindowDays": 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.
}</pre>
</div>
@@ -275,8 +293,9 @@
including any associated transfer runs and logs.
Args:
- name: string, The field will contain name of the resource requested, for example:
-`projects/{project_id}/transferConfigs/{config_id}` (required)
+ 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)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -302,8 +321,9 @@
<pre>Returns information about a data transfer config.
Args:
- name: string, The field will contain name of the resource requested, for example:
-`projects/{project_id}/transferConfigs/{config_id}` (required)
+ 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)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -318,12 +338,8 @@
# 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.
- "dataRefreshWindowDays": 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.
+ "disabled": True or False, # Is this config disabled. When set to true, no runs are scheduled
+ # for a given transfer.
"updateTime": "A String", # Output only. Data transfer modification time. Ignored by server on input.
"destinationDatasetId": "A String", # The BigQuery target dataset id.
"displayName": "A String", # User specified display name for the data transfer.
@@ -334,6 +350,8 @@
# CreateTransferConfigRequest along with project_id and region. If config_id
# is not provided, usually a uuid, even though it is not guaranteed or
# required, will be generated for config_id.
+ "notificationPubsubTopic": "A String", # Pub/Sub topic where notifications will be sent after transfer runs
+ # associated with this transfer config finish.
"schedule": "A String", # 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
@@ -347,8 +365,6 @@
# https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format
# NOTE: the granularity should be at least 8 hours, or less frequent.
"datasetRegion": "A String", # Output only. Region in which BigQuery dataset is located.
- "disabled": True or False, # Is this config disabled. When set to true, no runs are scheduled
- # for a given transfer.
"userId": "A String", # Deprecated. Unique ID of the user on whose behalf transfer is done.
"scheduleOptions": { # Options customizing the data transfer schedule. # Options customizing the data transfer schedule.
"disableAutoScheduling": True or False, # If true, automatic scheduling of data transfer runs for this configuration
@@ -367,21 +383,32 @@
},
"state": "A String", # Output only. State of the most recently updated transfer run.
"dataSourceId": "A String", # Data source id. Cannot be changed once data transfer is created.
+ "emailPreferences": { # Represents preferences for sending email notifications for transfer run # Email notifications will be sent according to these preferences
+ # to the email address of the user who owns this transfer config.
+ # events.
+ "enableFailureEmail": True or False, # If true, email notifications will be sent on transfer run failures.
+ },
"nextRunTime": "A String", # Output only. Next time when data transfer will run.
"params": { # Data transfer specific parameters.
"a_key": "", # Properties of the object.
},
+ "dataRefreshWindowDays": 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.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(parent, pageSize=None, dataSourceIds=None, pageToken=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(parent, dataSourceIds=None, pageToken=None, x__xgafv=None, pageSize=None)</code>
<pre>Returns information about all data transfers in the project.
Args:
- parent: string, The BigQuery project id for which data sources
-should be returned: `projects/{project_id}`. (required)
- pageSize: integer, Page size. The default page size is the maximum value of 1000 results.
+ 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)
dataSourceIds: string, When specified, only configurations of requested data sources are returned. (repeated)
pageToken: string, Pagination token, which can be used to request a specific page
of `ListTransfersRequest` list results. For multiple-page
@@ -392,6 +419,7 @@
Allowed values
1 - v1 error format
2 - v2 error format
+ pageSize: integer, Page size. The default page size is the maximum value of 1000 results.
Returns:
An object of the form:
@@ -408,12 +436,8 @@
# 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.
- "dataRefreshWindowDays": 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.
+ "disabled": True or False, # Is this config disabled. When set to true, no runs are scheduled
+ # for a given transfer.
"updateTime": "A String", # Output only. Data transfer modification time. Ignored by server on input.
"destinationDatasetId": "A String", # The BigQuery target dataset id.
"displayName": "A String", # User specified display name for the data transfer.
@@ -424,6 +448,8 @@
# CreateTransferConfigRequest along with project_id and region. If config_id
# is not provided, usually a uuid, even though it is not guaranteed or
# required, will be generated for config_id.
+ "notificationPubsubTopic": "A String", # Pub/Sub topic where notifications will be sent after transfer runs
+ # associated with this transfer config finish.
"schedule": "A String", # 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
@@ -437,8 +463,6 @@
# https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format
# NOTE: the granularity should be at least 8 hours, or less frequent.
"datasetRegion": "A String", # Output only. Region in which BigQuery dataset is located.
- "disabled": True or False, # Is this config disabled. When set to true, no runs are scheduled
- # for a given transfer.
"userId": "A String", # Deprecated. Unique ID of the user on whose behalf transfer is done.
"scheduleOptions": { # Options customizing the data transfer schedule. # Options customizing the data transfer schedule.
"disableAutoScheduling": True or False, # If true, automatic scheduling of data transfer runs for this configuration
@@ -457,10 +481,21 @@
},
"state": "A String", # Output only. State of the most recently updated transfer run.
"dataSourceId": "A String", # Data source id. Cannot be changed once data transfer is created.
+ "emailPreferences": { # Represents preferences for sending email notifications for transfer run # Email notifications will be sent according to these preferences
+ # to the email address of the user who owns this transfer config.
+ # events.
+ "enableFailureEmail": True or False, # If true, email notifications will be sent on transfer run failures.
+ },
"nextRunTime": "A String", # Output only. Next time when data transfer will run.
"params": { # Data transfer specific parameters.
"a_key": "", # Properties of the object.
},
+ "dataRefreshWindowDays": 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.
},
],
}</pre>
@@ -481,7 +516,7 @@
</div>
<div class="method">
- <code class="details" id="patch">patch(name, body, authorizationCode=None, updateMask=None, versionInfo=None, x__xgafv=None)</code>
+ <code class="details" id="patch">patch(name, body=None, authorizationCode=None, updateMask=None, versionInfo=None, x__xgafv=None, serviceAccountName=None)</code>
<pre>Updates a data transfer configuration.
All fields must be set, even if they are not updated.
@@ -493,7 +528,7 @@
CreateTransferConfigRequest along with project_id and region. If config_id
is not provided, usually a uuid, even though it is not guaranteed or
required, will be generated for config_id. (required)
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{ # Represents a data transfer configuration. A transfer configuration
@@ -502,12 +537,8 @@
# 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.
- "dataRefreshWindowDays": 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.
+ "disabled": True or False, # Is this config disabled. When set to true, no runs are scheduled
+ # for a given transfer.
"updateTime": "A String", # Output only. Data transfer modification time. Ignored by server on input.
"destinationDatasetId": "A String", # The BigQuery target dataset id.
"displayName": "A String", # User specified display name for the data transfer.
@@ -518,6 +549,8 @@
# CreateTransferConfigRequest along with project_id and region. If config_id
# is not provided, usually a uuid, even though it is not guaranteed or
# required, will be generated for config_id.
+ "notificationPubsubTopic": "A String", # Pub/Sub topic where notifications will be sent after transfer runs
+ # associated with this transfer config finish.
"schedule": "A String", # 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
@@ -531,8 +564,6 @@
# https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format
# NOTE: the granularity should be at least 8 hours, or less frequent.
"datasetRegion": "A String", # Output only. Region in which BigQuery dataset is located.
- "disabled": True or False, # Is this config disabled. When set to true, no runs are scheduled
- # for a given transfer.
"userId": "A String", # Deprecated. Unique ID of the user on whose behalf transfer is done.
"scheduleOptions": { # Options customizing the data transfer schedule. # Options customizing the data transfer schedule.
"disableAutoScheduling": True or False, # If true, automatic scheduling of data transfer runs for this configuration
@@ -551,10 +582,21 @@
},
"state": "A String", # Output only. State of the most recently updated transfer run.
"dataSourceId": "A String", # Data source id. Cannot be changed once data transfer is created.
+ "emailPreferences": { # Represents preferences for sending email notifications for transfer run # Email notifications will be sent according to these preferences
+ # to the email address of the user who owns this transfer config.
+ # events.
+ "enableFailureEmail": True or False, # If true, email notifications will be sent on transfer run failures.
+ },
"nextRunTime": "A String", # Output only. Next time when data transfer will run.
"params": { # Data transfer specific parameters.
"a_key": "", # Properties of the object.
},
+ "dataRefreshWindowDays": 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.
}
authorizationCode: string, Optional OAuth2 authorization code to use with this transfer configuration.
@@ -562,7 +604,7 @@
authorizing user.
In order to obtain authorization_code, please make a
request to
-https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=<datatransferapiclientid>&scope=<data_source_scopes>&redirect_uri=<redirect_uri>
+https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=<datatransferapiclientid>&scope=<data_source_scopes>&redirect_uri=<redirect_uri>
* client_id should be OAuth client_id of BigQuery DTS API for the given
data source returned by ListDataSources method.
@@ -573,17 +615,22 @@
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.
- updateMask: string, Required list of fields to be updated in this request.
+ updateMask: string, Required. Required list of fields to be updated in this request.
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 “none+gsession” response type. which be return a
+must use the "none+gsession" 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.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
+ serviceAccountName: string, Optional service account name. If this field is set and
+"service_account_name" 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.
Returns:
An object of the form:
@@ -594,12 +641,8 @@
# 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.
- "dataRefreshWindowDays": 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.
+ "disabled": True or False, # Is this config disabled. When set to true, no runs are scheduled
+ # for a given transfer.
"updateTime": "A String", # Output only. Data transfer modification time. Ignored by server on input.
"destinationDatasetId": "A String", # The BigQuery target dataset id.
"displayName": "A String", # User specified display name for the data transfer.
@@ -610,6 +653,8 @@
# CreateTransferConfigRequest along with project_id and region. If config_id
# is not provided, usually a uuid, even though it is not guaranteed or
# required, will be generated for config_id.
+ "notificationPubsubTopic": "A String", # Pub/Sub topic where notifications will be sent after transfer runs
+ # associated with this transfer config finish.
"schedule": "A String", # 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
@@ -623,8 +668,6 @@
# https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format
# NOTE: the granularity should be at least 8 hours, or less frequent.
"datasetRegion": "A String", # Output only. Region in which BigQuery dataset is located.
- "disabled": True or False, # Is this config disabled. When set to true, no runs are scheduled
- # for a given transfer.
"userId": "A String", # Deprecated. Unique ID of the user on whose behalf transfer is done.
"scheduleOptions": { # Options customizing the data transfer schedule. # Options customizing the data transfer schedule.
"disableAutoScheduling": True or False, # If true, automatic scheduling of data transfer runs for this configuration
@@ -643,15 +686,26 @@
},
"state": "A String", # Output only. State of the most recently updated transfer run.
"dataSourceId": "A String", # Data source id. Cannot be changed once data transfer is created.
+ "emailPreferences": { # Represents preferences for sending email notifications for transfer run # Email notifications will be sent according to these preferences
+ # to the email address of the user who owns this transfer config.
+ # events.
+ "enableFailureEmail": True or False, # If true, email notifications will be sent on transfer run failures.
+ },
"nextRunTime": "A String", # Output only. Next time when data transfer will run.
"params": { # Data transfer specific parameters.
"a_key": "", # Properties of the object.
},
+ "dataRefreshWindowDays": 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.
}</pre>
</div>
<div class="method">
- <code class="details" id="scheduleRuns">scheduleRuns(parent, body, x__xgafv=None)</code>
+ <code class="details" id="scheduleRuns">scheduleRuns(parent, body=None, x__xgafv=None)</code>
<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.
@@ -659,15 +713,16 @@
DEPRECATED: use StartManualTransferRuns instead.
Args:
- parent: string, Transfer configuration name in the form:
-`projects/{project_id}/transferConfigs/{config_id}`. (required)
- body: object, The request body. (required)
+ 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)
+ body: object, The request body.
The object takes the form of:
{ # A request to schedule transfer runs for a time range.
- "endTime": "A String", # End time of the range of transfer runs. For example,
+ "endTime": "A String", # Required. End time of the range of transfer runs. For example,
# `"2017-05-30T00:00:00+00:00"`.
- "startTime": "A String", # Start time of the range of transfer runs. For example,
+ "startTime": "A String", # Required. Start time of the range of transfer runs. For example,
# `"2017-05-25T00:00:00+00:00"`.
}
@@ -688,13 +743,17 @@
# 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.
+ "notificationPubsubTopic": "A String", # Output only. Pub/Sub topic where a notification will be sent after this
+ # transfer run finishes
"schedule": "A String", # 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't always match this.
- "scheduleTime": "A String", # Minimum time after which a transfer run can be started.
+ "startTime": "A String", # Output only. Time when transfer run was started.
+ # Parameter ignored by server for input requests.
"userId": "A String", # Deprecated. Unique ID of the user on whose behalf transfer is done.
+ "scheduleTime": "A String", # Minimum time after which a transfer run can be started.
"state": "A String", # Data transfer run state. Ignored for input requests.
"errorStatus": { # The `Status` type defines a logical error model that is suitable for # Status of the transfer run.
# different programming environments, including REST APIs and RPC APIs. It is
@@ -714,14 +773,18 @@
},
],
},
+ "dataSourceId": "A String", # Output only. Data source id.
+ "emailPreferences": { # Represents preferences for sending email notifications for transfer run # 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.
+ # events.
+ "enableFailureEmail": True or False, # If true, email notifications will be sent on transfer run failures.
+ },
"params": { # Output only. Data transfer specific parameters.
"a_key": "", # Properties of the object.
},
- "startTime": "A String", # Output only. Time when transfer run was started.
- # Parameter ignored by server for input requests.
- "dataSourceId": "A String", # Output only. Data source id.
- "runTime": "A String", # For batch transfer runs, specifies the date and time that
- # data should be ingested.
+ "runTime": "A String", # For batch transfer runs, specifies the date and time of the data should be
+ # ingested.
"endTime": "A String", # Output only. Time when transfer run ended.
# Parameter ignored by server for input requests.
},
@@ -730,7 +793,7 @@
</div>
<div class="method">
- <code class="details" id="startManualRuns">startManualRuns(parent, body, x__xgafv=None)</code>
+ <code class="details" id="startManualRuns">startManualRuns(parent, body=None, x__xgafv=None)</code>
<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
@@ -738,8 +801,9 @@
Args:
parent: string, Transfer configuration name in the form:
-`projects/{project_id}/transferConfigs/{config_id}`. (required)
- body: object, The request body. (required)
+`projects/{project_id}/transferConfigs/{config_id}` or
+`projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`. (required)
+ body: object, The request body.
The object takes the form of:
{ # A request to start manual transfer runs.
@@ -775,13 +839,17 @@
# 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.
+ "notificationPubsubTopic": "A String", # Output only. Pub/Sub topic where a notification will be sent after this
+ # transfer run finishes
"schedule": "A String", # 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't always match this.
- "scheduleTime": "A String", # Minimum time after which a transfer run can be started.
+ "startTime": "A String", # Output only. Time when transfer run was started.
+ # Parameter ignored by server for input requests.
"userId": "A String", # Deprecated. Unique ID of the user on whose behalf transfer is done.
+ "scheduleTime": "A String", # Minimum time after which a transfer run can be started.
"state": "A String", # Data transfer run state. Ignored for input requests.
"errorStatus": { # The `Status` type defines a logical error model that is suitable for # Status of the transfer run.
# different programming environments, including REST APIs and RPC APIs. It is
@@ -801,14 +869,18 @@
},
],
},
+ "dataSourceId": "A String", # Output only. Data source id.
+ "emailPreferences": { # Represents preferences for sending email notifications for transfer run # 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.
+ # events.
+ "enableFailureEmail": True or False, # If true, email notifications will be sent on transfer run failures.
+ },
"params": { # Output only. Data transfer specific parameters.
"a_key": "", # Properties of the object.
},
- "startTime": "A String", # Output only. Time when transfer run was started.
- # Parameter ignored by server for input requests.
- "dataSourceId": "A String", # Output only. Data source id.
- "runTime": "A String", # For batch transfer runs, specifies the date and time that
- # data should be ingested.
+ "runTime": "A String", # For batch transfer runs, specifies the date and time of the data should be
+ # ingested.
"endTime": "A String", # Output only. Time when transfer run ended.
# Parameter ignored by server for input requests.
},