Skip to content
This repository has been archived by the owner on Nov 29, 2023. It is now read-only.

Commit

Permalink
docs: Fix formatting of request arg in docstring (#455)
Browse files Browse the repository at this point in the history 
* docs: Fix formatting of request arg in docstring

chore: Update gapic-generator-python to v1.9.1
PiperOrigin-RevId: 518604533

Source-Link: googleapis/googleapis@8a085ae

Source-Link: googleapis/googleapis-gen@b2ab4b0
Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiYjJhYjRiMGEwYWUyOTA3ZTgxMmMyMDkxOThhNzRlMDg5OGFmY2IwNCJ9

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

---------

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
  • Loading branch information
@gcf-owl-bot
gcf-owl-bot[bot] and gcf-owl-bot[bot] committed Mar 23, 2023
1 parent 250acb4 commit 40a85d6
Show file tree
Hide file tree
Showing 4 changed files with 71 additions and 68 deletions.
62 changes: 35 additions & 27 deletions google/cloud/bigquery_datatransfer_v1/services/data_transfer_service/async_client.py
View file
Expand Up @@ -390,7 +390,8 @@ async def sample_list_data_sources():
Args:
request (Optional[Union[google.cloud.bigquery_datatransfer_v1.types.ListDataSourcesRequest, dict]]):
The request object. Request to list supported data
sources and their data transfer settings.
sources and their data transfer
settings.
parent (:class:`str`):
Required. The BigQuery project id for which data sources
should be returned. Must be in the form:
Expand Down Expand Up @@ -521,13 +522,16 @@ async def sample_create_transfer_config():
Args:
request (Optional[Union[google.cloud.bigquery_datatransfer_v1.types.CreateTransferConfigRequest, dict]]):
The request object. A request to create a data transfer
configuration. If new credentials are needed for this
transfer configuration, authorization info must be
provided. If authorization info is provided, the
transfer configuration will be associated with the user
id corresponding to the authorization info. Otherwise,
the transfer configuration will be associated with the
calling user.
configuration. If new credentials are
needed for this transfer configuration,
authorization info must be provided. If
authorization info is provided, the
transfer configuration will be
associated with the user id
corresponding to the authorization info.
Otherwise, the transfer configuration
will be associated with the calling
user.
parent (:class:`str`):
Required. The BigQuery project id where the transfer
configuration should be created. Must be in the format
Expand Down Expand Up @@ -653,8 +657,9 @@ async def sample_update_transfer_config():
Args:
request (Optional[Union[google.cloud.bigquery_datatransfer_v1.types.UpdateTransferConfigRequest, dict]]):
The request object. A request to update a transfer
configuration. To update the user id of the transfer
configuration, authorization info needs to be provided.
configuration. To update the user id of
the transfer configuration,
authorization info needs to be provided.
transfer_config (:class:`google.cloud.bigquery_datatransfer_v1.types.TransferConfig`):
Required. Data transfer configuration
to create.
Expand Down Expand Up @@ -771,8 +776,9 @@ async def sample_delete_transfer_config():
Args:
request (Optional[Union[google.cloud.bigquery_datatransfer_v1.types.DeleteTransferConfigRequest, dict]]):
The request object. A request to delete data transfer
information. All associated transfer runs and log
messages will be deleted as well.
information. All associated transfer
runs and log messages will be deleted as
well.
name (:class:`str`):
Required. The field will contain name of the resource
requested, for example:
Expand Down Expand Up @@ -1450,8 +1456,8 @@ async def sample_delete_transfer_run():
Args:
request (Optional[Union[google.cloud.bigquery_datatransfer_v1.types.DeleteTransferRunRequest, dict]]):
The request object. A request to delete data transfer
run information.
The request object. A request to delete data transfer run
information.
name (:class:`str`):
Required. The field will contain name of the resource
requested, for example:
Expand Down Expand Up @@ -1558,8 +1564,7 @@ async def sample_list_transfer_runs():
Args:
request (Optional[Union[google.cloud.bigquery_datatransfer_v1.types.ListTransferRunsRequest, dict]]):
The request object. A request to list data transfer
runs.
The request object. A request to list data transfer runs.
parent (:class:`str`):
Required. Name of transfer configuration for which
transfer runs should be retrieved. Format of transfer
Expand Down Expand Up @@ -1687,7 +1692,8 @@ async def sample_list_transfer_logs():
Args:
request (Optional[Union[google.cloud.bigquery_datatransfer_v1.types.ListTransferLogsRequest, dict]]):
The request object. A request to get user facing log
messages associated with data transfer run.
messages associated with data transfer
run.
parent (:class:`str`):
Required. Transfer run name in the form:
``projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}``
Expand Down Expand Up @@ -1814,13 +1820,16 @@ async def sample_check_valid_creds():
Args:
request (Optional[Union[google.cloud.bigquery_datatransfer_v1.types.CheckValidCredsRequest, dict]]):
The request object. A request to determine whether the
user has valid credentials. This method is used to limit
the number of OAuth popups in the user interface. The
user id is inferred from the API call context.
If the data source has the Google+ authorization type,
this method returns false, as it cannot be determined
whether the credentials are already valid merely based
on the user id.
user has valid credentials. This method
is used to limit the number of OAuth
popups in the user interface. The user
id is inferred from the API call
context. If the data source has the
Google+ authorization type, this method
returns false, as it cannot be
determined whether the credentials are
already valid merely based on the user
id.
name (:class:`str`):
Required. The data source in the form:
``projects/{project_id}/dataSources/{data_source_id}``
Expand Down Expand Up @@ -1936,9 +1945,8 @@ async def sample_enroll_data_sources():
Args:
request (Optional[Union[google.cloud.bigquery_datatransfer_v1.types.EnrollDataSourcesRequest, dict]]):
The request object. A request to enroll a set of data
sources so they are visible in the BigQuery UI's
`Transfer` tab.
The request object. A request to enroll a set of data sources so they are
visible in the BigQuery UI's ``Transfer`` tab.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down
62 changes: 35 additions & 27 deletions google/cloud/bigquery_datatransfer_v1/services/data_transfer_service/client.py
View file
Expand Up @@ -639,7 +639,8 @@ def sample_list_data_sources():
Args:
request (Union[google.cloud.bigquery_datatransfer_v1.types.ListDataSourcesRequest, dict]):
The request object. Request to list supported data
sources and their data transfer settings.
sources and their data transfer
settings.
parent (str):
Required. The BigQuery project id for which data sources
should be returned. Must be in the form:
Expand Down Expand Up @@ -760,13 +761,16 @@ def sample_create_transfer_config():
Args:
request (Union[google.cloud.bigquery_datatransfer_v1.types.CreateTransferConfigRequest, dict]):
The request object. A request to create a data transfer
configuration. If new credentials are needed for this
transfer configuration, authorization info must be
provided. If authorization info is provided, the
transfer configuration will be associated with the user
id corresponding to the authorization info. Otherwise,
the transfer configuration will be associated with the
calling user.
configuration. If new credentials are
needed for this transfer configuration,
authorization info must be provided. If
authorization info is provided, the
transfer configuration will be
associated with the user id
corresponding to the authorization info.
Otherwise, the transfer configuration
will be associated with the calling
user.
parent (str):
Required. The BigQuery project id where the transfer
configuration should be created. Must be in the format
Expand Down Expand Up @@ -892,8 +896,9 @@ def sample_update_transfer_config():
Args:
request (Union[google.cloud.bigquery_datatransfer_v1.types.UpdateTransferConfigRequest, dict]):
The request object. A request to update a transfer
configuration. To update the user id of the transfer
configuration, authorization info needs to be provided.
configuration. To update the user id of
the transfer configuration,
authorization info needs to be provided.
transfer_config (google.cloud.bigquery_datatransfer_v1.types.TransferConfig):
Required. Data transfer configuration
to create.
Expand Down Expand Up @@ -1010,8 +1015,9 @@ def sample_delete_transfer_config():
Args:
request (Union[google.cloud.bigquery_datatransfer_v1.types.DeleteTransferConfigRequest, dict]):
The request object. A request to delete data transfer
information. All associated transfer runs and log
messages will be deleted as well.
information. All associated transfer
runs and log messages will be deleted as
well.
name (str):
Required. The field will contain name of the resource
requested, for example:
Expand Down Expand Up @@ -1652,8 +1658,8 @@ def sample_delete_transfer_run():
Args:
request (Union[google.cloud.bigquery_datatransfer_v1.types.DeleteTransferRunRequest, dict]):
The request object. A request to delete data transfer
run information.
The request object. A request to delete data transfer run
information.
name (str):
Required. The field will contain name of the resource
requested, for example:
Expand Down Expand Up @@ -1750,8 +1756,7 @@ def sample_list_transfer_runs():
Args:
request (Union[google.cloud.bigquery_datatransfer_v1.types.ListTransferRunsRequest, dict]):
The request object. A request to list data transfer
runs.
The request object. A request to list data transfer runs.
parent (str):
Required. Name of transfer configuration for which
transfer runs should be retrieved. Format of transfer
Expand Down Expand Up @@ -1869,7 +1874,8 @@ def sample_list_transfer_logs():
Args:
request (Union[google.cloud.bigquery_datatransfer_v1.types.ListTransferLogsRequest, dict]):
The request object. A request to get user facing log
messages associated with data transfer run.
messages associated with data transfer
run.
parent (str):
Required. Transfer run name in the form:
``projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}``
Expand Down Expand Up @@ -1986,13 +1992,16 @@ def sample_check_valid_creds():
Args:
request (Union[google.cloud.bigquery_datatransfer_v1.types.CheckValidCredsRequest, dict]):
The request object. A request to determine whether the
user has valid credentials. This method is used to limit
the number of OAuth popups in the user interface. The
user id is inferred from the API call context.
If the data source has the Google+ authorization type,
this method returns false, as it cannot be determined
whether the credentials are already valid merely based
on the user id.
user has valid credentials. This method
is used to limit the number of OAuth
popups in the user interface. The user
id is inferred from the API call
context. If the data source has the
Google+ authorization type, this method
returns false, as it cannot be
determined whether the credentials are
already valid merely based on the user
id.
name (str):
Required. The data source in the form:
``projects/{project_id}/dataSources/{data_source_id}``
Expand Down Expand Up @@ -2098,9 +2107,8 @@ def sample_enroll_data_sources():
Args:
request (Union[google.cloud.bigquery_datatransfer_v1.types.EnrollDataSourcesRequest, dict]):
The request object. A request to enroll a set of data
sources so they are visible in the BigQuery UI's
`Transfer` tab.
The request object. A request to enroll a set of data sources so they are
visible in the BigQuery UI's ``Transfer`` tab.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down
13 changes: 0 additions & 13 deletions google/cloud/bigquery_datatransfer_v1/services/data_transfer_service/transports/rest.py
View file
Expand Up @@ -673,7 +673,6 @@ def __call__(
determined whether the credentials are
already valid merely based on the user
id.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -788,7 +787,6 @@ def __call__(
Otherwise, the transfer configuration
will be associated with the calling
user.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -901,7 +899,6 @@ def __call__(
information. All associated transfer
runs and log messages will be deleted as
well.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -983,7 +980,6 @@ def __call__(
request (~.datatransfer.DeleteTransferRunRequest):
The request object. A request to delete data transfer run
information.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -1055,7 +1051,6 @@ def __call__(
request (~.datatransfer.EnrollDataSourcesRequest):
The request object. A request to enroll a set of data sources so they are
visible in the BigQuery UI's ``Transfer`` tab.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -1238,7 +1233,6 @@ def __call__(
request (~.datatransfer.GetTransferConfigRequest):
The request object. A request to get data transfer
information.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -1339,7 +1333,6 @@ def __call__(
request (~.datatransfer.GetTransferRunRequest):
The request object. A request to get data transfer run
information.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -1434,7 +1427,6 @@ def __call__(
The request object. Request to list supported data
sources and their data transfer
settings.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -1530,7 +1522,6 @@ def __call__(
request (~.datatransfer.ListTransferConfigsRequest):
The request object. A request to list data transfers
configured for a BigQuery project.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -1627,7 +1618,6 @@ def __call__(
The request object. A request to get user facing log
messages associated with data transfer
run.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -1817,7 +1807,6 @@ def __call__(
request (~.datatransfer.ScheduleTransferRunsRequest):
The request object. A request to schedule transfer runs
for a time range.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -1914,7 +1903,6 @@ def __call__(
request (~.datatransfer.StartManualTransferRunsRequest):
The request object. A request to start manual transfer
runs.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -2023,7 +2011,6 @@ def __call__(
configuration. To update the user id of
the transfer configuration,
authorization info needs to be provided.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down
2 changes: 1 addition & 1 deletion samples/generated_samples/snippet_metadata_google.cloud.bigquery.datatransfer.v1.json
View file
Expand Up @@ -8,7 +8,7 @@
],
"language": "PYTHON",
"name": "google-cloud-bigquery-datatransfer",
"version": "3.11.0"
"version": "0.1.0"
},
"snippets": [
{
Expand Down

0 comments on commit 40a85d6

Please sign in to comment.