docs: docs update (#911)
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
- [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/google-api-python-client/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
- [ ] Ensure the tests and linter pass
- [ ] Code coverage does not decrease (if any source code was changed)
- [ ] Appropriate docs were updated (if necessary)
Fixes #<issue_number_goes_here> 🦕
diff --git a/docs/dyn/bigquerydatatransfer_v1.projects.transferConfigs.html b/docs/dyn/bigquerydatatransfer_v1.projects.transferConfigs.html
index 70ef45a..98b19df 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=None, authorizationCode=None, serviceAccountName=None, versionInfo=None, x__xgafv=None)</a></code></p>
+ <code><a href="#create">create(parent, body=None, serviceAccountName=None, versionInfo=None, authorizationCode=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,13 +89,13 @@
<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, dataSourceIds=None, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p>
+ <code><a href="#list">list(parent, pageToken=None, pageSize=None, dataSourceIds=None, x__xgafv=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=None, authorizationCode=None, updateMask=None, versionInfo=None, x__xgafv=None, serviceAccountName=None)</a></code></p>
+ <code><a href="#patch">patch(name, body=None, updateMask=None, serviceAccountName=None, versionInfo=None, authorizationCode=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates a data transfer configuration.</p>
<p class="toc_element">
<code><a href="#scheduleRuns">scheduleRuns(parent, body=None, x__xgafv=None)</a></code></p>
@@ -105,7 +105,7 @@
<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=None, authorizationCode=None, serviceAccountName=None, versionInfo=None, x__xgafv=None)</code>
+ <code class="details" id="create">create(parent, body=None, serviceAccountName=None, versionInfo=None, authorizationCode=None, x__xgafv=None)</code>
<pre>Creates a new data transfer configuration.
Args:
@@ -122,21 +122,22 @@
# 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.
- "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.
- "name": "A String", # The resource name of the transfer config.
- # Transfer config names have the form of
- # `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`.
- # The name is automatically generated based on the config_id specified in
- # 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
+ "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.
+ "params": { # Data transfer specific parameters.
+ "a_key": "", # Properties of the object.
+ },
+ "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.
+ },
+ "datasetRegion": "A String", # Output only. Region in which BigQuery dataset is located.
+ "displayName": "A String", # User specified display name for the data transfer.
+ "disabled": True or False, # Is this config disabled. When set to true, no runs are scheduled
+ # for a given transfer.
+ "nextRunTime": "A String", # Output only. Next time when data transfer will run.
+ "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
# used.
@@ -148,42 +149,51 @@
# See more explanation about the format here:
# https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format
# NOTE: the granularity should be at least 8 hours, or less frequent.
- "datasetRegion": "A String", # Output only. Region in which BigQuery dataset is located.
- "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
- # will be disabled. The runs can be started on ad-hoc basis using
- # StartManualTransferRuns API. When automatic scheduling is disabled, the
- # TransferConfig.schedule field will be ignored.
- "endTime": "A String", # Defines time to stop scheduling transfer runs. A transfer run cannot be
- # scheduled at or after the end time. The end time can be changed at any
- # moment. The time when a data transfer can be trigerred manually is not
- # limited by this option.
- "startTime": "A String", # Specifies time to start scheduling transfer runs. The first run will be
- # scheduled at or after the start time according to a recurrence pattern
- # defined in the schedule string. The start time can be changed at any
- # moment. The time when a data transfer can be trigerred manually is not
- # limited by this option.
- },
- "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.
+ "updateTime": "A String", # Output only. Data transfer modification time. Ignored by server on input.
+ "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.
+ "dataSourceId": "A String", # Data source id. Cannot be changed once data transfer is created.
+ "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
+ # will be disabled. The runs can be started on ad-hoc basis using
+ # StartManualTransferRuns API. When automatic scheduling is disabled, the
+ # TransferConfig.schedule field will be ignored.
+ "endTime": "A String", # Defines time to stop scheduling transfer runs. A transfer run cannot be
+ # scheduled at or after the end time. The end time can be changed at any
+ # moment. The time when a data transfer can be trigerred manually is not
+ # limited by this option.
+ "startTime": "A String", # Specifies time to start scheduling transfer runs. The first run will be
+ # scheduled at or after the start time according to a recurrence pattern
+ # defined in the schedule string. The start time can be changed at any
+ # moment. The time when a data transfer can be trigerred manually is not
+ # limited by this option.
+ },
+ "state": "A String", # Output only. State of the most recently updated transfer run.
+ "name": "A String", # The resource name of the transfer config.
+ # Transfer config names have the form of
+ # `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`.
+ # The name is automatically generated based on the config_id specified in
+ # 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.
+ "destinationDatasetId": "A String", # The BigQuery target dataset id.
+ "userId": "A String", # Deprecated. Unique ID of the user on whose behalf transfer is done.
}
+ 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
+version_info back in the authorization response which be be put in a JWT
+claim in the token request.
authorizationCode: string, Optional OAuth2 authorization code to use with this transfer configuration.
This is required if new credentials are needed, as indicated by
`CheckValidCreds`.
@@ -200,16 +210,6 @@
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
-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
@@ -224,21 +224,22 @@
# 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.
- "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.
- "name": "A String", # The resource name of the transfer config.
- # Transfer config names have the form of
- # `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`.
- # The name is automatically generated based on the config_id specified in
- # 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
+ "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.
+ "params": { # Data transfer specific parameters.
+ "a_key": "", # Properties of the object.
+ },
+ "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.
+ },
+ "datasetRegion": "A String", # Output only. Region in which BigQuery dataset is located.
+ "displayName": "A String", # User specified display name for the data transfer.
+ "disabled": True or False, # Is this config disabled. When set to true, no runs are scheduled
+ # for a given transfer.
+ "nextRunTime": "A String", # Output only. Next time when data transfer will run.
+ "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
# used.
@@ -250,40 +251,39 @@
# See more explanation about the format here:
# https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format
# NOTE: the granularity should be at least 8 hours, or less frequent.
- "datasetRegion": "A String", # Output only. Region in which BigQuery dataset is located.
- "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
- # will be disabled. The runs can be started on ad-hoc basis using
- # StartManualTransferRuns API. When automatic scheduling is disabled, the
- # TransferConfig.schedule field will be ignored.
- "endTime": "A String", # Defines time to stop scheduling transfer runs. A transfer run cannot be
- # scheduled at or after the end time. The end time can be changed at any
- # moment. The time when a data transfer can be trigerred manually is not
- # limited by this option.
- "startTime": "A String", # Specifies time to start scheduling transfer runs. The first run will be
- # scheduled at or after the start time according to a recurrence pattern
- # defined in the schedule string. The start time can be changed at any
- # moment. The time when a data transfer can be trigerred manually is not
- # limited by this option.
- },
- "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.
+ "updateTime": "A String", # Output only. Data transfer modification time. Ignored by server on input.
+ "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.
+ "dataSourceId": "A String", # Data source id. Cannot be changed once data transfer is created.
+ "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
+ # will be disabled. The runs can be started on ad-hoc basis using
+ # StartManualTransferRuns API. When automatic scheduling is disabled, the
+ # TransferConfig.schedule field will be ignored.
+ "endTime": "A String", # Defines time to stop scheduling transfer runs. A transfer run cannot be
+ # scheduled at or after the end time. The end time can be changed at any
+ # moment. The time when a data transfer can be trigerred manually is not
+ # limited by this option.
+ "startTime": "A String", # Specifies time to start scheduling transfer runs. The first run will be
+ # scheduled at or after the start time according to a recurrence pattern
+ # defined in the schedule string. The start time can be changed at any
+ # moment. The time when a data transfer can be trigerred manually is not
+ # limited by this option.
+ },
+ "state": "A String", # Output only. State of the most recently updated transfer run.
+ "name": "A String", # The resource name of the transfer config.
+ # Transfer config names have the form of
+ # `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`.
+ # The name is automatically generated based on the config_id specified in
+ # 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.
+ "destinationDatasetId": "A String", # The BigQuery target dataset id.
+ "userId": "A String", # Deprecated. Unique ID of the user on whose behalf transfer is done.
}</pre>
</div>
@@ -338,21 +338,22 @@
# 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.
- "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.
- "name": "A String", # The resource name of the transfer config.
- # Transfer config names have the form of
- # `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`.
- # The name is automatically generated based on the config_id specified in
- # 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
+ "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.
+ "params": { # Data transfer specific parameters.
+ "a_key": "", # Properties of the object.
+ },
+ "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.
+ },
+ "datasetRegion": "A String", # Output only. Region in which BigQuery dataset is located.
+ "displayName": "A String", # User specified display name for the data transfer.
+ "disabled": True or False, # Is this config disabled. When set to true, no runs are scheduled
+ # for a given transfer.
+ "nextRunTime": "A String", # Output only. Next time when data transfer will run.
+ "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
# used.
@@ -364,93 +365,93 @@
# See more explanation about the format here:
# https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format
# NOTE: the granularity should be at least 8 hours, or less frequent.
- "datasetRegion": "A String", # Output only. Region in which BigQuery dataset is located.
- "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
- # will be disabled. The runs can be started on ad-hoc basis using
- # StartManualTransferRuns API. When automatic scheduling is disabled, the
- # TransferConfig.schedule field will be ignored.
- "endTime": "A String", # Defines time to stop scheduling transfer runs. A transfer run cannot be
- # scheduled at or after the end time. The end time can be changed at any
- # moment. The time when a data transfer can be trigerred manually is not
- # limited by this option.
- "startTime": "A String", # Specifies time to start scheduling transfer runs. The first run will be
- # scheduled at or after the start time according to a recurrence pattern
- # defined in the schedule string. The start time can be changed at any
- # moment. The time when a data transfer can be trigerred manually is not
- # limited by this option.
- },
- "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.
+ "updateTime": "A String", # Output only. Data transfer modification time. Ignored by server on input.
+ "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.
+ "dataSourceId": "A String", # Data source id. Cannot be changed once data transfer is created.
+ "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
+ # will be disabled. The runs can be started on ad-hoc basis using
+ # StartManualTransferRuns API. When automatic scheduling is disabled, the
+ # TransferConfig.schedule field will be ignored.
+ "endTime": "A String", # Defines time to stop scheduling transfer runs. A transfer run cannot be
+ # scheduled at or after the end time. The end time can be changed at any
+ # moment. The time when a data transfer can be trigerred manually is not
+ # limited by this option.
+ "startTime": "A String", # Specifies time to start scheduling transfer runs. The first run will be
+ # scheduled at or after the start time according to a recurrence pattern
+ # defined in the schedule string. The start time can be changed at any
+ # moment. The time when a data transfer can be trigerred manually is not
+ # limited by this option.
+ },
+ "state": "A String", # Output only. State of the most recently updated transfer run.
+ "name": "A String", # The resource name of the transfer config.
+ # Transfer config names have the form of
+ # `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`.
+ # The name is automatically generated based on the config_id specified in
+ # 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.
+ "destinationDatasetId": "A String", # The BigQuery target dataset id.
+ "userId": "A String", # Deprecated. Unique ID of the user on whose behalf transfer is done.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(parent, dataSourceIds=None, pageToken=None, x__xgafv=None, pageSize=None)</code>
+ <code class="details" id="list">list(parent, pageToken=None, pageSize=None, dataSourceIds=None, x__xgafv=None)</code>
<pre>Returns information about all data transfers in the project.
Args:
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
results, `ListTransfersResponse` outputs
a `next_page` token, which can be used as the
`page_token` value to request the next page of list results.
+ pageSize: integer, Page size. The default page size is the maximum value of 1000 results.
+ dataSourceIds: string, When specified, only configurations of requested data sources are returned. (repeated)
x__xgafv: string, V1 error format.
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:
{ # The returned list of pipelines in the project.
- "nextPageToken": "A String", # Output only. The next-pagination token. For multiple-page list results,
+ "nextPageToken": "A String", # Output only. The next-pagination token. For multiple-page list results,
# this token can be used as the
# `ListTransferConfigsRequest.page_token`
# to request the next page of list results.
- "transferConfigs": [ # Output only. The stored pipeline transfer configurations.
+ "transferConfigs": [ # Output only. The stored pipeline transfer configurations.
{ # Represents a data transfer configuration. A transfer configuration
# contains all metadata needed to perform a data transfer. For example,
# `destination_dataset_id` specifies where data should be stored.
# When a new transfer configuration is created, the specified
# `destination_dataset_id` is created when needed and shared with the
# appropriate data source service account.
- "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.
- "name": "A String", # The resource name of the transfer config.
- # Transfer config names have the form of
- # `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`.
- # The name is automatically generated based on the config_id specified in
- # 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
+ "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.
+ "params": { # Data transfer specific parameters.
+ "a_key": "", # Properties of the object.
+ },
+ "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.
+ },
+ "datasetRegion": "A String", # Output only. Region in which BigQuery dataset is located.
+ "displayName": "A String", # User specified display name for the data transfer.
+ "disabled": True or False, # Is this config disabled. When set to true, no runs are scheduled
+ # for a given transfer.
+ "nextRunTime": "A String", # Output only. Next time when data transfer will run.
+ "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
# used.
@@ -462,40 +463,39 @@
# See more explanation about the format here:
# https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format
# NOTE: the granularity should be at least 8 hours, or less frequent.
- "datasetRegion": "A String", # Output only. Region in which BigQuery dataset is located.
- "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
- # will be disabled. The runs can be started on ad-hoc basis using
- # StartManualTransferRuns API. When automatic scheduling is disabled, the
- # TransferConfig.schedule field will be ignored.
- "endTime": "A String", # Defines time to stop scheduling transfer runs. A transfer run cannot be
- # scheduled at or after the end time. The end time can be changed at any
- # moment. The time when a data transfer can be trigerred manually is not
- # limited by this option.
- "startTime": "A String", # Specifies time to start scheduling transfer runs. The first run will be
- # scheduled at or after the start time according to a recurrence pattern
- # defined in the schedule string. The start time can be changed at any
- # moment. The time when a data transfer can be trigerred manually is not
- # limited by this option.
- },
- "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.
+ "updateTime": "A String", # Output only. Data transfer modification time. Ignored by server on input.
+ "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.
+ "dataSourceId": "A String", # Data source id. Cannot be changed once data transfer is created.
+ "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
+ # will be disabled. The runs can be started on ad-hoc basis using
+ # StartManualTransferRuns API. When automatic scheduling is disabled, the
+ # TransferConfig.schedule field will be ignored.
+ "endTime": "A String", # Defines time to stop scheduling transfer runs. A transfer run cannot be
+ # scheduled at or after the end time. The end time can be changed at any
+ # moment. The time when a data transfer can be trigerred manually is not
+ # limited by this option.
+ "startTime": "A String", # Specifies time to start scheduling transfer runs. The first run will be
+ # scheduled at or after the start time according to a recurrence pattern
+ # defined in the schedule string. The start time can be changed at any
+ # moment. The time when a data transfer can be trigerred manually is not
+ # limited by this option.
+ },
+ "state": "A String", # Output only. State of the most recently updated transfer run.
+ "name": "A String", # The resource name of the transfer config.
+ # Transfer config names have the form of
+ # `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`.
+ # The name is automatically generated based on the config_id specified in
+ # 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.
+ "destinationDatasetId": "A String", # The BigQuery target dataset id.
+ "userId": "A String", # Deprecated. Unique ID of the user on whose behalf transfer is done.
},
],
}</pre>
@@ -510,13 +510,13 @@
previous_response: The response from the request for the previous page. (required)
Returns:
- A request object that you can call 'execute()' on to request the next
+ A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
- <code class="details" id="patch">patch(name, body=None, authorizationCode=None, updateMask=None, versionInfo=None, x__xgafv=None, serviceAccountName=None)</code>
+ <code class="details" id="patch">patch(name, body=None, updateMask=None, serviceAccountName=None, versionInfo=None, authorizationCode=None, x__xgafv=None)</code>
<pre>Updates a data transfer configuration.
All fields must be set, even if they are not updated.
@@ -537,21 +537,22 @@
# 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.
- "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.
- "name": "A String", # The resource name of the transfer config.
- # Transfer config names have the form of
- # `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`.
- # The name is automatically generated based on the config_id specified in
- # 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
+ "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.
+ "params": { # Data transfer specific parameters.
+ "a_key": "", # Properties of the object.
+ },
+ "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.
+ },
+ "datasetRegion": "A String", # Output only. Region in which BigQuery dataset is located.
+ "displayName": "A String", # User specified display name for the data transfer.
+ "disabled": True or False, # Is this config disabled. When set to true, no runs are scheduled
+ # for a given transfer.
+ "nextRunTime": "A String", # Output only. Next time when data transfer will run.
+ "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
# used.
@@ -563,42 +564,53 @@
# See more explanation about the format here:
# https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format
# NOTE: the granularity should be at least 8 hours, or less frequent.
- "datasetRegion": "A String", # Output only. Region in which BigQuery dataset is located.
- "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
- # will be disabled. The runs can be started on ad-hoc basis using
- # StartManualTransferRuns API. When automatic scheduling is disabled, the
- # TransferConfig.schedule field will be ignored.
- "endTime": "A String", # Defines time to stop scheduling transfer runs. A transfer run cannot be
- # scheduled at or after the end time. The end time can be changed at any
- # moment. The time when a data transfer can be trigerred manually is not
- # limited by this option.
- "startTime": "A String", # Specifies time to start scheduling transfer runs. The first run will be
- # scheduled at or after the start time according to a recurrence pattern
- # defined in the schedule string. The start time can be changed at any
- # moment. The time when a data transfer can be trigerred manually is not
- # limited by this option.
- },
- "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.
+ "updateTime": "A String", # Output only. Data transfer modification time. Ignored by server on input.
+ "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.
+ "dataSourceId": "A String", # Data source id. Cannot be changed once data transfer is created.
+ "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
+ # will be disabled. The runs can be started on ad-hoc basis using
+ # StartManualTransferRuns API. When automatic scheduling is disabled, the
+ # TransferConfig.schedule field will be ignored.
+ "endTime": "A String", # Defines time to stop scheduling transfer runs. A transfer run cannot be
+ # scheduled at or after the end time. The end time can be changed at any
+ # moment. The time when a data transfer can be trigerred manually is not
+ # limited by this option.
+ "startTime": "A String", # Specifies time to start scheduling transfer runs. The first run will be
+ # scheduled at or after the start time according to a recurrence pattern
+ # defined in the schedule string. The start time can be changed at any
+ # moment. The time when a data transfer can be trigerred manually is not
+ # limited by this option.
+ },
+ "state": "A String", # Output only. State of the most recently updated transfer run.
+ "name": "A String", # The resource name of the transfer config.
+ # Transfer config names have the form of
+ # `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`.
+ # The name is automatically generated based on the config_id specified in
+ # 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.
+ "destinationDatasetId": "A String", # The BigQuery target dataset id.
+ "userId": "A String", # Deprecated. Unique ID of the user on whose behalf transfer is done.
}
+ updateMask: string, Required. Required list of fields to be updated in this request.
+ 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.
+ 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
+version_info back in the authorization response which be be put in a JWT
+claim in the token request.
authorizationCode: string, Optional OAuth2 authorization code to use with this transfer configuration.
If it is provided, the transfer configuration will be associated with the
authorizing user.
@@ -615,22 +627,10 @@
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. 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
-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:
@@ -641,21 +641,22 @@
# 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.
- "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.
- "name": "A String", # The resource name of the transfer config.
- # Transfer config names have the form of
- # `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`.
- # The name is automatically generated based on the config_id specified in
- # 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
+ "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.
+ "params": { # Data transfer specific parameters.
+ "a_key": "", # Properties of the object.
+ },
+ "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.
+ },
+ "datasetRegion": "A String", # Output only. Region in which BigQuery dataset is located.
+ "displayName": "A String", # User specified display name for the data transfer.
+ "disabled": True or False, # Is this config disabled. When set to true, no runs are scheduled
+ # for a given transfer.
+ "nextRunTime": "A String", # Output only. Next time when data transfer will run.
+ "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
# used.
@@ -667,40 +668,39 @@
# See more explanation about the format here:
# https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format
# NOTE: the granularity should be at least 8 hours, or less frequent.
- "datasetRegion": "A String", # Output only. Region in which BigQuery dataset is located.
- "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
- # will be disabled. The runs can be started on ad-hoc basis using
- # StartManualTransferRuns API. When automatic scheduling is disabled, the
- # TransferConfig.schedule field will be ignored.
- "endTime": "A String", # Defines time to stop scheduling transfer runs. A transfer run cannot be
- # scheduled at or after the end time. The end time can be changed at any
- # moment. The time when a data transfer can be trigerred manually is not
- # limited by this option.
- "startTime": "A String", # Specifies time to start scheduling transfer runs. The first run will be
- # scheduled at or after the start time according to a recurrence pattern
- # defined in the schedule string. The start time can be changed at any
- # moment. The time when a data transfer can be trigerred manually is not
- # limited by this option.
- },
- "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.
+ "updateTime": "A String", # Output only. Data transfer modification time. Ignored by server on input.
+ "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.
+ "dataSourceId": "A String", # Data source id. Cannot be changed once data transfer is created.
+ "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
+ # will be disabled. The runs can be started on ad-hoc basis using
+ # StartManualTransferRuns API. When automatic scheduling is disabled, the
+ # TransferConfig.schedule field will be ignored.
+ "endTime": "A String", # Defines time to stop scheduling transfer runs. A transfer run cannot be
+ # scheduled at or after the end time. The end time can be changed at any
+ # moment. The time when a data transfer can be trigerred manually is not
+ # limited by this option.
+ "startTime": "A String", # Specifies time to start scheduling transfer runs. The first run will be
+ # scheduled at or after the start time according to a recurrence pattern
+ # defined in the schedule string. The start time can be changed at any
+ # moment. The time when a data transfer can be trigerred manually is not
+ # limited by this option.
+ },
+ "state": "A String", # Output only. State of the most recently updated transfer run.
+ "name": "A String", # The resource name of the transfer config.
+ # Transfer config names have the form of
+ # `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`.
+ # The name is automatically generated based on the config_id specified in
+ # 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.
+ "destinationDatasetId": "A String", # The BigQuery target dataset id.
+ "userId": "A String", # Deprecated. Unique ID of the user on whose behalf transfer is done.
}</pre>
</div>
@@ -720,10 +720,10 @@
The object takes the form of:
{ # A request to schedule transfer runs for a time range.
- "endTime": "A String", # Required. End time of the range of transfer runs. For example,
- # `"2017-05-30T00:00:00+00:00"`.
- "startTime": "A String", # Required. Start time of the range of transfer runs. For example,
- # `"2017-05-25T00:00:00+00:00"`.
+ "endTime": "A String", # Required. End time of the range of transfer runs. For example,
+ # `"2017-05-30T00:00:00+00:00"`.
+ "startTime": "A String", # Required. Start time of the range of transfer runs. For example,
+ # `"2017-05-25T00:00:00+00:00"`.
}
x__xgafv: string, V1 error format.
@@ -735,58 +735,58 @@
An object of the form:
{ # A response to schedule transfer runs for a time range.
- "runs": [ # The transfer runs that were scheduled.
+ "runs": [ # The transfer runs that were scheduled.
{ # Represents a data transfer run.
- "updateTime": "A String", # Output only. Last time the data transfer run state was updated.
- "destinationDatasetId": "A String", # Output only. The BigQuery target dataset id.
- "name": "A String", # The resource name of the transfer run.
+ "dataSourceId": "A String", # Output only. Data source id.
+ "state": "A String", # Data transfer run state. Ignored for input requests.
+ "destinationDatasetId": "A String", # Output only. The BigQuery target dataset id.
+ "name": "A String", # The resource name of the transfer run.
# Transfer run names have the form
# `projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}`.
# The name is ignored when creating a transfer run.
- "notificationPubsubTopic": "A String", # Output only. Pub/Sub topic where a notification will be sent after this
+ "userId": "A String", # Deprecated. Unique ID of the user on whose behalf transfer is done.
+ "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.
- "startTime": "A String", # Output only. Time when transfer run was started.
+ "params": { # Output only. Data transfer specific parameters.
+ "a_key": "", # Properties of the object.
+ },
+ "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.
+ },
+ "endTime": "A String", # Output only. Time when transfer run ended.
# 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.
+ "startTime": "A String", # Output only. Time when transfer run was started.
+ # Parameter ignored by server for input requests.
+ "scheduleTime": "A String", # Minimum time after which a transfer run can be started.
+ "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
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
# three pieces of data: error code, error message, and error details.
#
# You can find out more about this error model and how to work with it in the
# [API Design Guide](https://cloud.google.com/apis/design/errors).
- "message": "A String", # A developer-facing error message, which should be in English. Any
+ "message": "A String", # A developer-facing error message, which should be in English. Any
# user-facing error message should be localized and sent in the
# google.rpc.Status.details field, or localized by the client.
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "details": [ # A list of messages that carry the error details. There is a common set of
+ "details": [ # A list of messages that carry the error details. There is a common set of
# message types for APIs to use.
{
- "a_key": "", # Properties of the object. Contains field @type with type URL.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
},
- "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.
- },
- "runTime": "A String", # For batch transfer runs, specifies the date and time of the data should be
+ "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.
+ "updateTime": "A String", # Output only. Last time the data transfer run state was updated.
+ "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.
},
],
}</pre>
@@ -807,18 +807,18 @@
The object takes the form of:
{ # A request to start manual transfer runs.
- "requestedTimeRange": { # A specification for a time range, this will request transfer runs with # Time range for the transfer runs that should be started.
+ "requestedTimeRange": { # A specification for a time range, this will request transfer runs with # Time range for the transfer runs that should be started.
# run_time between start_time (inclusive) and end_time (exclusive).
- "endTime": "A String", # End time of the range of transfer runs. For example,
- # `"2017-05-30T00:00:00+00:00"`. The end_time must not be in the future.
- # Creates transfer runs where run_time is in the range betwen start_time
- # (inclusive) and end_time (exlusive).
- "startTime": "A String", # Start time of the range of transfer runs. For example,
- # `"2017-05-25T00:00:00+00:00"`. The start_time must be strictly less than
+ "startTime": "A String", # Start time of the range of transfer runs. For example,
+ # `"2017-05-25T00:00:00+00:00"`. The start_time must be strictly less than
# the end_time. Creates transfer runs where run_time is in the range betwen
# start_time (inclusive) and end_time (exlusive).
+ "endTime": "A String", # End time of the range of transfer runs. For example,
+ # `"2017-05-30T00:00:00+00:00"`. The end_time must not be in the future.
+ # Creates transfer runs where run_time is in the range betwen start_time
+ # (inclusive) and end_time (exlusive).
},
- "requestedRunTime": "A String", # Specific run_time for a transfer run to be started. The
+ "requestedRunTime": "A String", # Specific run_time for a transfer run to be started. The
# requested_run_time must not be in the future.
}
@@ -831,58 +831,58 @@
An object of the form:
{ # A response to start manual transfer runs.
- "runs": [ # The transfer runs that were created.
+ "runs": [ # The transfer runs that were created.
{ # Represents a data transfer run.
- "updateTime": "A String", # Output only. Last time the data transfer run state was updated.
- "destinationDatasetId": "A String", # Output only. The BigQuery target dataset id.
- "name": "A String", # The resource name of the transfer run.
+ "dataSourceId": "A String", # Output only. Data source id.
+ "state": "A String", # Data transfer run state. Ignored for input requests.
+ "destinationDatasetId": "A String", # Output only. The BigQuery target dataset id.
+ "name": "A String", # The resource name of the transfer run.
# Transfer run names have the form
# `projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}`.
# The name is ignored when creating a transfer run.
- "notificationPubsubTopic": "A String", # Output only. Pub/Sub topic where a notification will be sent after this
+ "userId": "A String", # Deprecated. Unique ID of the user on whose behalf transfer is done.
+ "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.
- "startTime": "A String", # Output only. Time when transfer run was started.
+ "params": { # Output only. Data transfer specific parameters.
+ "a_key": "", # Properties of the object.
+ },
+ "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.
+ },
+ "endTime": "A String", # Output only. Time when transfer run ended.
# 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.
+ "startTime": "A String", # Output only. Time when transfer run was started.
+ # Parameter ignored by server for input requests.
+ "scheduleTime": "A String", # Minimum time after which a transfer run can be started.
+ "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
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
# three pieces of data: error code, error message, and error details.
#
# You can find out more about this error model and how to work with it in the
# [API Design Guide](https://cloud.google.com/apis/design/errors).
- "message": "A String", # A developer-facing error message, which should be in English. Any
+ "message": "A String", # A developer-facing error message, which should be in English. Any
# user-facing error message should be localized and sent in the
# google.rpc.Status.details field, or localized by the client.
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "details": [ # A list of messages that carry the error details. There is a common set of
+ "details": [ # A list of messages that carry the error details. There is a common set of
# message types for APIs to use.
{
- "a_key": "", # Properties of the object. Contains field @type with type URL.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
},
- "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.
- },
- "runTime": "A String", # For batch transfer runs, specifies the date and time of the data should be
+ "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.
+ "updateTime": "A String", # Output only. Last time the data transfer run state was updated.
+ "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.
},
],
}</pre>