docs: update docs/dyn (#1096)
This PR was generated using Autosynth. :rainbow:
Synth log will be available here:
https://source.cloud.google.com/results/invocations/6f0f288a-a1e8-4b2d-a85f-00b1c6150185/targets
- [ ] To automatically regenerate this PR, check this box.
Source-Link: https://github.com/googleapis/synthtool/commit/39b7149da4026765385403632db3c6f63db96b2c
Source-Link: https://github.com/googleapis/synthtool/commit/9a7d9fbb7045c34c9d3d22c1ff766eeae51f04c9
Source-Link: https://github.com/googleapis/synthtool/commit/dc9903a8c30c3662b6098f0e4a97f221d67268b2
Source-Link: https://github.com/googleapis/synthtool/commit/7fcc405a579d5d53a726ff3da1b7c8c08f0f2d58
Source-Link: https://github.com/googleapis/synthtool/commit/d5fc0bcf9ea9789c5b0e3154a9e3b29e5cea6116
Source-Link: https://github.com/googleapis/synthtool/commit/e89175cf074dccc4babb4eca66ae913696e47a71
Source-Link: https://github.com/googleapis/synthtool/commit/7d652819519dfa24da9e14548232e4aaba71a11c
Source-Link: https://github.com/googleapis/synthtool/commit/7db8a6c5ffb12a6e4c2f799c18f00f7f3d60e279
Source-Link: https://github.com/googleapis/synthtool/commit/1f1148d3c7a7a52f0c98077f976bd9b3c948ee2b
Source-Link: https://github.com/googleapis/synthtool/commit/2c8aecedd55b0480fb4e123b6e07fa5b12953862
Source-Link: https://github.com/googleapis/synthtool/commit/3d3e94c4e02370f307a9a200b0c743c3d8d19f29
Source-Link: https://github.com/googleapis/synthtool/commit/c7824ea48ff6d4d42dfae0849aec8a85acd90bd9
Source-Link: https://github.com/googleapis/synthtool/commit/ba9918cd22874245b55734f57470c719b577e591
Source-Link: https://github.com/googleapis/synthtool/commit/b19b401571e77192f8dd38eab5fb2300a0de9324
Source-Link: https://github.com/googleapis/synthtool/commit/6542bd723403513626f61642fc02ddca528409aa
diff --git a/docs/dyn/bigquerydatatransfer_v1.projects.transferConfigs.runs.html b/docs/dyn/bigquerydatatransfer_v1.projects.transferConfigs.runs.html
index 62f55cf..d4a9c6d 100644
--- a/docs/dyn/bigquerydatatransfer_v1.projects.transferConfigs.runs.html
+++ b/docs/dyn/bigquerydatatransfer_v1.projects.transferConfigs.runs.html
@@ -89,7 +89,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, states=None, pageToken=None, runAttempt=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(parent, runAttempt=None, states=None, pageSize=None, pageToken=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>
@@ -133,43 +133,46 @@
An object of the form:
{ # Represents a data transfer run.
- "endTime": "A String", # Output only. Time when transfer run ended. Parameter ignored by server for input requests.
+ "updateTime": "A String", # Output only. Last time the data transfer run state was updated.
"params": { # Output only. Data transfer specific parameters.
"a_key": "", # Properties of the object.
},
+ "dataSourceId": "A String", # Output only. Data source id.
+ "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.
- "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.
- },
- "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.
- "userId": "A String", # Deprecated. Unique ID of the user on whose behalf transfer is done.
"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.
"scheduleTime": "A String", # Minimum time after which a transfer run can be started.
+ "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.
+ "endTime": "A String", # Output only. Time when transfer run ended. Parameter ignored by server for input requests.
+ "destinationDatasetId": "A String", # Output only. The BigQuery target dataset id.
"state": "A String", # Data transfer run state. Ignored for input requests.
- "startTime": "A String", # Output only. Time when transfer run was started. Parameter ignored by server for input requests.
- "dataSourceId": "A String", # Output only. Data source id.
"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.
"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.
"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.
},
- "destinationDatasetId": "A String", # Output only. The BigQuery target dataset id.
- "updateTime": "A String", # Output only. Last time the data transfer run state was updated.
+ "notificationPubsubTopic": "A String", # Output only. Pub/Sub topic where a notification will be sent after this transfer run finishes
+ "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.
+ },
+ "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, pageSize=None, states=None, pageToken=None, runAttempt=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(parent, runAttempt=None, states=None, pageSize=None, pageToken=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)
- 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.
+ Allowed values
+ RUN_ATTEMPT_UNSPECIFIED - All runs should be returned.
+ LATEST - Only latest run per day should be returned.
states: string, When specified, only transfer runs with requested states are returned. (repeated)
Allowed values
TRANSFER_STATE_UNSPECIFIED - State placeholder.
@@ -178,11 +181,8 @@
SUCCEEDED - Data transfer completed successfully.
FAILED - Data transfer failed.
CANCELLED - Data transfer is cancelled.
+ 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.
- 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
@@ -192,38 +192,38 @@
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, 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.
{ # Represents a data transfer run.
- "endTime": "A String", # Output only. Time when transfer run ended. Parameter ignored by server for input requests.
+ "updateTime": "A String", # Output only. Last time the data transfer run state was updated.
"params": { # Output only. Data transfer specific parameters.
"a_key": "", # Properties of the object.
},
+ "dataSourceId": "A String", # Output only. Data source id.
+ "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.
- "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.
- },
- "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.
- "userId": "A String", # Deprecated. Unique ID of the user on whose behalf transfer is done.
"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.
"scheduleTime": "A String", # Minimum time after which a transfer run can be started.
+ "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.
+ "endTime": "A String", # Output only. Time when transfer run ended. Parameter ignored by server for input requests.
+ "destinationDatasetId": "A String", # Output only. The BigQuery target dataset id.
"state": "A String", # Data transfer run state. Ignored for input requests.
- "startTime": "A String", # Output only. Time when transfer run was started. Parameter ignored by server for input requests.
- "dataSourceId": "A String", # Output only. Data source id.
"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.
"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.
"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.
},
- "destinationDatasetId": "A String", # Output only. The BigQuery target dataset id.
- "updateTime": "A String", # Output only. Last time the data transfer run state was updated.
+ "notificationPubsubTopic": "A String", # Output only. Pub/Sub topic where a notification will be sent after this transfer run finishes
+ "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.
+ },
+ "userId": "A String", # Deprecated. Unique ID of the user on whose behalf transfer is done.
},
],
+ "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>