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.runs.html b/docs/dyn/bigquerydatatransfer_v1.projects.transferConfigs.runs.html
index a8085e9..42c89d3 100644
--- a/docs/dyn/bigquerydatatransfer_v1.projects.transferConfigs.runs.html
+++ b/docs/dyn/bigquerydatatransfer_v1.projects.transferConfigs.runs.html
@@ -86,7 +86,7 @@
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Returns information about the particular transfer run.</p>
<p class="toc_element">
- <code><a href="#list">list(parent, pageSize=None, pageToken=None, runAttempt=None, states=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(parent, pageToken=None, states=None, pageSize=None, runAttempt=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns information about running and completed jobs.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -137,61 +137,61 @@
An object of the form:
{ # 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>
</div>
<div class="method">
- <code class="details" id="list">list(parent, pageSize=None, pageToken=None, runAttempt=None, states=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(parent, pageToken=None, states=None, pageSize=None, runAttempt=None, x__xgafv=None)</code>
<pre>Returns information about running and completed jobs.
Args:
@@ -199,14 +199,14 @@
Format of transfer configuration resource name is:
`projects/{project_id}/transferConfigs/{config_id}` or
`projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`. (required)
- pageSize: integer, Page size. The default page size is the maximum value of 1000 results.
pageToken: string, Pagination token, which can be used to request a specific page
of `ListTransferRunsRequest` list results. For multiple-page
results, `ListTransferRunsResponse` outputs
a `next_page` token, which can be used as the
`page_token` value to request the next page of list results.
- runAttempt: string, Indicates how run attempts are to be pulled.
states: string, When specified, only transfer runs with requested states are returned. (repeated)
+ pageSize: integer, Page size. The default page size is the maximum value of 1000 results.
+ runAttempt: string, Indicates how run attempts are to be pulled.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -216,62 +216,62 @@
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
# `ListTransferRunsRequest.page_token`
# to request the next page of list results.
- "transferRuns": [ # Output only. The stored pipeline transfer runs.
+ "transferRuns": [ # Output only. The stored pipeline transfer runs.
{ # 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>
@@ -286,7 +286,7 @@
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>