docs: update generated docs (#1053)
Updates for both discovery docs and epydoc API Documentation
Fixes: #1049
diff --git a/docs/dyn/bigquerydatatransfer_v1.projects.transferConfigs.runs.html b/docs/dyn/bigquerydatatransfer_v1.projects.transferConfigs.runs.html
index 00c0264..950a357 100644
--- a/docs/dyn/bigquerydatatransfer_v1.projects.transferConfigs.runs.html
+++ b/docs/dyn/bigquerydatatransfer_v1.projects.transferConfigs.runs.html
@@ -80,26 +80,32 @@
<p class="firstline">Returns the transferLogs Resource.</p>
<p class="toc_element">
+ <code><a href="#close">close()</a></code></p>
+<p class="firstline">Close httplib2 connections.</p>
+<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes the specified transfer run.</p>
<p class="toc_element">
<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, pageToken=None, states=None, pageSize=None, runAttempt=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(parent, pageSize=None, pageToken=None, states=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>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
+ <code class="details" id="close">close()</code>
+ <pre>Close httplib2 connections.</pre>
+</div>
+
+<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Deletes the specified transfer run.
Args:
- name: string, Required. The field will contain name of the resource requested, for example:
-`projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or
-`projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}` (required)
+ name: string, Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -108,15 +114,7 @@
Returns:
An object of the form:
- { # A generic empty message that you can re-use to avoid defining duplicated
- # empty messages in your APIs. A typical example is to use it as the request
- # or the response type of an API method. For instance:
- #
- # service Foo {
- # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
- # }
- #
- # The JSON representation for `Empty` is empty JSON object `{}`.
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
}</pre>
</div>
@@ -125,9 +123,7 @@
<pre>Returns information about the particular transfer run.
Args:
- name: string, Required. The field will contain name of the resource requested, for example:
-`projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or
-`projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}` (required)
+ name: string, Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -137,76 +133,56 @@
An object of the form:
{ # Represents a data 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.
- "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
- "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.
- "startTime": "A String", # Output only. Time when transfer run was started.
- # Parameter ignored by server for input requests.
+ "runTime": "A String", # For batch transfer runs, specifies the date and time of the data should be ingested.
+ "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).
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
+ "notificationPubsubTopic": "A String", # Output only. Pub/Sub topic where a notification will be sent after this transfer run finishes
+ "errorStatus": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Status of the transfer run.
+ "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.
},
],
+ "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.
- "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.
},
+ "params": { # Output only. Data transfer specific parameters.
+ "a_key": "", # Properties of the object.
+ },
+ "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.
"updateTime": "A String", # Output only. Last time the data transfer run state was updated.
- "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.
- "runTime": "A String", # For batch transfer runs, specifies the date and time of the data should be
- # ingested.
+ "emailPreferences": { # Represents preferences for sending email notifications for transfer run events. # Output only. Email notifications will be sent according to these preferences to the email address of the user who owns the transfer config this run was derived from.
+ "enableFailureEmail": True or False, # If true, email notifications will be sent on transfer run failures.
+ },
+ "state": "A String", # Data transfer run state. Ignored for input requests.
+ "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.
+ "destinationDatasetId": "A String", # Output only. The BigQuery target dataset id.
+ "userId": "A String", # Deprecated. Unique ID of the user on whose behalf transfer is done.
+ "dataSourceId": "A String", # Output only. Data source id.
+ "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, pageToken=None, states=None, pageSize=None, runAttempt=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(parent, pageSize=None, pageToken=None, states=None, runAttempt=None, x__xgafv=None)</code>
<pre>Returns information about running and completed jobs.
Args:
- parent: string, Required. Name of transfer configuration for which transfer runs should be retrieved.
-Format of transfer configuration resource name is:
-`projects/{project_id}/transferConfigs/{config_id}` or
-`projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`. (required)
- 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.
- states: string, When specified, only transfer runs with requested states are returned. (repeated)
+ parent: string, Required. Name of transfer configuration for which transfer runs should be retrieved. 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.
+ states: string, When specified, only transfer runs with requested states are returned. (repeated)
+ Allowed values
+ TRANSFER_STATE_UNSPECIFIED - State placeholder.
+ PENDING - Data transfer is scheduled and is waiting to be picked up by data transfer backend.
+ RUNNING - Data transfer is in progress.
+ SUCCEEDED - Data transfer completed successfully.
+ FAILED - Data transfer failed.
+ CANCELLED - Data transfer is cancelled.
runAttempt: string, Indicates how run attempts are to be pulled.
+ Allowed values
+ RUN_ATTEMPT_UNSPECIFIED - All runs should be returned.
+ LATEST - Only latest run per day should be returned.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -218,62 +194,36 @@
{ # The returned list of pipelines in the project.
"transferRuns": [ # Output only. The stored pipeline transfer runs.
{ # Represents a data 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.
- "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
- "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.
- "startTime": "A String", # Output only. Time when transfer run was started.
- # Parameter ignored by server for input requests.
+ "runTime": "A String", # For batch transfer runs, specifies the date and time of the data should be ingested.
+ "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).
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
+ "notificationPubsubTopic": "A String", # Output only. Pub/Sub topic where a notification will be sent after this transfer run finishes
+ "errorStatus": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Status of the transfer run.
+ "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.
},
],
+ "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.
- "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.
},
+ "params": { # Output only. Data transfer specific parameters.
+ "a_key": "", # Properties of the object.
+ },
+ "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.
"updateTime": "A String", # Output only. Last time the data transfer run state was updated.
- "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.
- "runTime": "A String", # For batch transfer runs, specifies the date and time of the data should be
- # ingested.
+ "emailPreferences": { # Represents preferences for sending email notifications for transfer run events. # Output only. Email notifications will be sent according to these preferences to the email address of the user who owns the transfer config this run was derived from.
+ "enableFailureEmail": True or False, # If true, email notifications will be sent on transfer run failures.
+ },
+ "state": "A String", # Data transfer run state. Ignored for input requests.
+ "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.
+ "destinationDatasetId": "A String", # Output only. The BigQuery target dataset id.
+ "userId": "A String", # Deprecated. Unique ID of the user on whose behalf transfer is done.
+ "dataSourceId": "A String", # Output only. Data source id.
+ "endTime": "A String", # Output only. Time when transfer run ended. Parameter ignored by server for input requests.
},
],
- "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.
+ "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.
}</pre>
</div>