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

Commit 40a85d6

Browse files
gcf-owl-bot[bot]gcf-owl-bot[bot]
authored
docs: Fix formatting of request arg in docstring (#455)
* 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: https://github.com/googleapis/googleapis-gen/commit/b2ab4b0a0ae2907e812c209198a74e0898afcb04 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>
1 parent 250acb4 commit 40a85d6

4 files changed

Lines changed: 71 additions & 68 deletions

File tree

‎google/cloud/bigquery_datatransfer_v1/services/data_transfer_service/async_client.py‎

Lines changed: 35 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -390,7 +390,8 @@ async def sample_list_data_sources():
390390
Args:
391391
request (Optional[Union[google.cloud.bigquery_datatransfer_v1.types.ListDataSourcesRequest, dict]]):
392392
The request object. Request to list supported data
393-
sources and their data transfer settings.
393+
sources and their data transfer
394+
settings.
394395
parent (:class:`str`):
395396
Required. The BigQuery project id for which data sources
396397
should be returned. Must be in the form:
@@ -521,13 +522,16 @@ async def sample_create_transfer_config():
521522
Args:
522523
request (Optional[Union[google.cloud.bigquery_datatransfer_v1.types.CreateTransferConfigRequest, dict]]):
523524
The request object. A request to create a data transfer
524-
configuration. If new credentials are needed for this
525-
transfer configuration, authorization info must be
526-
provided. If authorization info is provided, the
527-
transfer configuration will be associated with the user
528-
id corresponding to the authorization info. Otherwise,
529-
the transfer configuration will be associated with the
530-
calling user.
525+
configuration. If new credentials are
526+
needed for this transfer configuration,
527+
authorization info must be provided. If
528+
authorization info is provided, the
529+
transfer configuration will be
530+
associated with the user id
531+
corresponding to the authorization info.
532+
Otherwise, the transfer configuration
533+
will be associated with the calling
534+
user.
531535
parent (:class:`str`):
532536
Required. The BigQuery project id where the transfer
533537
configuration should be created. Must be in the format
@@ -653,8 +657,9 @@ async def sample_update_transfer_config():
653657
Args:
654658
request (Optional[Union[google.cloud.bigquery_datatransfer_v1.types.UpdateTransferConfigRequest, dict]]):
655659
The request object. A request to update a transfer
656-
configuration. To update the user id of the transfer
657-
configuration, authorization info needs to be provided.
660+
configuration. To update the user id of
661+
the transfer configuration,
662+
authorization info needs to be provided.
658663
transfer_config (:class:`google.cloud.bigquery_datatransfer_v1.types.TransferConfig`):
659664
Required. Data transfer configuration
660665
to create.
@@ -771,8 +776,9 @@ async def sample_delete_transfer_config():
771776
Args:
772777
request (Optional[Union[google.cloud.bigquery_datatransfer_v1.types.DeleteTransferConfigRequest, dict]]):
773778
The request object. A request to delete data transfer
774-
information. All associated transfer runs and log
775-
messages will be deleted as well.
779+
information. All associated transfer
780+
runs and log messages will be deleted as
781+
well.
776782
name (:class:`str`):
777783
Required. The field will contain name of the resource
778784
requested, for example:
@@ -1450,8 +1456,8 @@ async def sample_delete_transfer_run():
14501456
14511457
Args:
14521458
request (Optional[Union[google.cloud.bigquery_datatransfer_v1.types.DeleteTransferRunRequest, dict]]):
1453-
The request object. A request to delete data transfer
1454-
run information.
1459+
The request object. A request to delete data transfer run
1460+
information.
14551461
name (:class:`str`):
14561462
Required. The field will contain name of the resource
14571463
requested, for example:
@@ -1558,8 +1564,7 @@ async def sample_list_transfer_runs():
15581564
15591565
Args:
15601566
request (Optional[Union[google.cloud.bigquery_datatransfer_v1.types.ListTransferRunsRequest, dict]]):
1561-
The request object. A request to list data transfer
1562-
runs.
1567+
The request object. A request to list data transfer runs.
15631568
parent (:class:`str`):
15641569
Required. Name of transfer configuration for which
15651570
transfer runs should be retrieved. Format of transfer
@@ -1687,7 +1692,8 @@ async def sample_list_transfer_logs():
16871692
Args:
16881693
request (Optional[Union[google.cloud.bigquery_datatransfer_v1.types.ListTransferLogsRequest, dict]]):
16891694
The request object. A request to get user facing log
1690-
messages associated with data transfer run.
1695+
messages associated with data transfer
1696+
run.
16911697
parent (:class:`str`):
16921698
Required. Transfer run name in the form:
16931699
``projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}``
@@ -1814,13 +1820,16 @@ async def sample_check_valid_creds():
18141820
Args:
18151821
request (Optional[Union[google.cloud.bigquery_datatransfer_v1.types.CheckValidCredsRequest, dict]]):
18161822
The request object. A request to determine whether the
1817-
user has valid credentials. This method is used to limit
1818-
the number of OAuth popups in the user interface. The
1819-
user id is inferred from the API call context.
1820-
If the data source has the Google+ authorization type,
1821-
this method returns false, as it cannot be determined
1822-
whether the credentials are already valid merely based
1823-
on the user id.
1823+
user has valid credentials. This method
1824+
is used to limit the number of OAuth
1825+
popups in the user interface. The user
1826+
id is inferred from the API call
1827+
context. If the data source has the
1828+
Google+ authorization type, this method
1829+
returns false, as it cannot be
1830+
determined whether the credentials are
1831+
already valid merely based on the user
1832+
id.
18241833
name (:class:`str`):
18251834
Required. The data source in the form:
18261835
``projects/{project_id}/dataSources/{data_source_id}``
@@ -1936,9 +1945,8 @@ async def sample_enroll_data_sources():
19361945
19371946
Args:
19381947
request (Optional[Union[google.cloud.bigquery_datatransfer_v1.types.EnrollDataSourcesRequest, dict]]):
1939-
The request object. A request to enroll a set of data
1940-
sources so they are visible in the BigQuery UI's
1941-
`Transfer` tab.
1948+
The request object. A request to enroll a set of data sources so they are
1949+
visible in the BigQuery UI's ``Transfer`` tab.
19421950
retry (google.api_core.retry.Retry): Designation of what errors, if any,
19431951
should be retried.
19441952
timeout (float): The timeout for this request.

‎google/cloud/bigquery_datatransfer_v1/services/data_transfer_service/client.py‎

Lines changed: 35 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -639,7 +639,8 @@ def sample_list_data_sources():
639639
Args:
640640
request (Union[google.cloud.bigquery_datatransfer_v1.types.ListDataSourcesRequest, dict]):
641641
The request object. Request to list supported data
642-
sources and their data transfer settings.
642+
sources and their data transfer
643+
settings.
643644
parent (str):
644645
Required. The BigQuery project id for which data sources
645646
should be returned. Must be in the form:
@@ -760,13 +761,16 @@ def sample_create_transfer_config():
760761
Args:
761762
request (Union[google.cloud.bigquery_datatransfer_v1.types.CreateTransferConfigRequest, dict]):
762763
The request object. A request to create a data transfer
763-
configuration. If new credentials are needed for this
764-
transfer configuration, authorization info must be
765-
provided. If authorization info is provided, the
766-
transfer configuration will be associated with the user
767-
id corresponding to the authorization info. Otherwise,
768-
the transfer configuration will be associated with the
769-
calling user.
764+
configuration. If new credentials are
765+
needed for this transfer configuration,
766+
authorization info must be provided. If
767+
authorization info is provided, the
768+
transfer configuration will be
769+
associated with the user id
770+
corresponding to the authorization info.
771+
Otherwise, the transfer configuration
772+
will be associated with the calling
773+
user.
770774
parent (str):
771775
Required. The BigQuery project id where the transfer
772776
configuration should be created. Must be in the format
@@ -892,8 +896,9 @@ def sample_update_transfer_config():
892896
Args:
893897
request (Union[google.cloud.bigquery_datatransfer_v1.types.UpdateTransferConfigRequest, dict]):
894898
The request object. A request to update a transfer
895-
configuration. To update the user id of the transfer
896-
configuration, authorization info needs to be provided.
899+
configuration. To update the user id of
900+
the transfer configuration,
901+
authorization info needs to be provided.
897902
transfer_config (google.cloud.bigquery_datatransfer_v1.types.TransferConfig):
898903
Required. Data transfer configuration
899904
to create.
@@ -1010,8 +1015,9 @@ def sample_delete_transfer_config():
10101015
Args:
10111016
request (Union[google.cloud.bigquery_datatransfer_v1.types.DeleteTransferConfigRequest, dict]):
10121017
The request object. A request to delete data transfer
1013-
information. All associated transfer runs and log
1014-
messages will be deleted as well.
1018+
information. All associated transfer
1019+
runs and log messages will be deleted as
1020+
well.
10151021
name (str):
10161022
Required. The field will contain name of the resource
10171023
requested, for example:
@@ -1652,8 +1658,8 @@ def sample_delete_transfer_run():
16521658
16531659
Args:
16541660
request (Union[google.cloud.bigquery_datatransfer_v1.types.DeleteTransferRunRequest, dict]):
1655-
The request object. A request to delete data transfer
1656-
run information.
1661+
The request object. A request to delete data transfer run
1662+
information.
16571663
name (str):
16581664
Required. The field will contain name of the resource
16591665
requested, for example:
@@ -1750,8 +1756,7 @@ def sample_list_transfer_runs():
17501756
17511757
Args:
17521758
request (Union[google.cloud.bigquery_datatransfer_v1.types.ListTransferRunsRequest, dict]):
1753-
The request object. A request to list data transfer
1754-
runs.
1759+
The request object. A request to list data transfer runs.
17551760
parent (str):
17561761
Required. Name of transfer configuration for which
17571762
transfer runs should be retrieved. Format of transfer
@@ -1869,7 +1874,8 @@ def sample_list_transfer_logs():
18691874
Args:
18701875
request (Union[google.cloud.bigquery_datatransfer_v1.types.ListTransferLogsRequest, dict]):
18711876
The request object. A request to get user facing log
1872-
messages associated with data transfer run.
1877+
messages associated with data transfer
1878+
run.
18731879
parent (str):
18741880
Required. Transfer run name in the form:
18751881
``projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}``
@@ -1986,13 +1992,16 @@ def sample_check_valid_creds():
19861992
Args:
19871993
request (Union[google.cloud.bigquery_datatransfer_v1.types.CheckValidCredsRequest, dict]):
19881994
The request object. A request to determine whether the
1989-
user has valid credentials. This method is used to limit
1990-
the number of OAuth popups in the user interface. The
1991-
user id is inferred from the API call context.
1992-
If the data source has the Google+ authorization type,
1993-
this method returns false, as it cannot be determined
1994-
whether the credentials are already valid merely based
1995-
on the user id.
1995+
user has valid credentials. This method
1996+
is used to limit the number of OAuth
1997+
popups in the user interface. The user
1998+
id is inferred from the API call
1999+
context. If the data source has the
2000+
Google+ authorization type, this method
2001+
returns false, as it cannot be
2002+
determined whether the credentials are
2003+
already valid merely based on the user
2004+
id.
19962005
name (str):
19972006
Required. The data source in the form:
19982007
``projects/{project_id}/dataSources/{data_source_id}``
@@ -2098,9 +2107,8 @@ def sample_enroll_data_sources():
20982107
20992108
Args:
21002109
request (Union[google.cloud.bigquery_datatransfer_v1.types.EnrollDataSourcesRequest, dict]):
2101-
The request object. A request to enroll a set of data
2102-
sources so they are visible in the BigQuery UI's
2103-
`Transfer` tab.
2110+
The request object. A request to enroll a set of data sources so they are
2111+
visible in the BigQuery UI's ``Transfer`` tab.
21042112
retry (google.api_core.retry.Retry): Designation of what errors, if any,
21052113
should be retried.
21062114
timeout (float): The timeout for this request.

‎google/cloud/bigquery_datatransfer_v1/services/data_transfer_service/transports/rest.py‎

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -673,7 +673,6 @@ def __call__(
673673
determined whether the credentials are
674674
already valid merely based on the user
675675
id.
676-
677676
retry (google.api_core.retry.Retry): Designation of what errors, if any,
678677
should be retried.
679678
timeout (float): The timeout for this request.
@@ -788,7 +787,6 @@ def __call__(
788787
Otherwise, the transfer configuration
789788
will be associated with the calling
790789
user.
791-
792790
retry (google.api_core.retry.Retry): Designation of what errors, if any,
793791
should be retried.
794792
timeout (float): The timeout for this request.
@@ -901,7 +899,6 @@ def __call__(
901899
information. All associated transfer
902900
runs and log messages will be deleted as
903901
well.
904-
905902
retry (google.api_core.retry.Retry): Designation of what errors, if any,
906903
should be retried.
907904
timeout (float): The timeout for this request.
@@ -983,7 +980,6 @@ def __call__(
983980
request (~.datatransfer.DeleteTransferRunRequest):
984981
The request object. A request to delete data transfer run
985982
information.
986-
987983
retry (google.api_core.retry.Retry): Designation of what errors, if any,
988984
should be retried.
989985
timeout (float): The timeout for this request.
@@ -1055,7 +1051,6 @@ def __call__(
10551051
request (~.datatransfer.EnrollDataSourcesRequest):
10561052
The request object. A request to enroll a set of data sources so they are
10571053
visible in the BigQuery UI's ``Transfer`` tab.
1058-
10591054
retry (google.api_core.retry.Retry): Designation of what errors, if any,
10601055
should be retried.
10611056
timeout (float): The timeout for this request.
@@ -1238,7 +1233,6 @@ def __call__(
12381233
request (~.datatransfer.GetTransferConfigRequest):
12391234
The request object. A request to get data transfer
12401235
information.
1241-
12421236
retry (google.api_core.retry.Retry): Designation of what errors, if any,
12431237
should be retried.
12441238
timeout (float): The timeout for this request.
@@ -1339,7 +1333,6 @@ def __call__(
13391333
request (~.datatransfer.GetTransferRunRequest):
13401334
The request object. A request to get data transfer run
13411335
information.
1342-
13431336
retry (google.api_core.retry.Retry): Designation of what errors, if any,
13441337
should be retried.
13451338
timeout (float): The timeout for this request.
@@ -1434,7 +1427,6 @@ def __call__(
14341427
The request object. Request to list supported data
14351428
sources and their data transfer
14361429
settings.
1437-
14381430
retry (google.api_core.retry.Retry): Designation of what errors, if any,
14391431
should be retried.
14401432
timeout (float): The timeout for this request.
@@ -1530,7 +1522,6 @@ def __call__(
15301522
request (~.datatransfer.ListTransferConfigsRequest):
15311523
The request object. A request to list data transfers
15321524
configured for a BigQuery project.
1533-
15341525
retry (google.api_core.retry.Retry): Designation of what errors, if any,
15351526
should be retried.
15361527
timeout (float): The timeout for this request.
@@ -1627,7 +1618,6 @@ def __call__(
16271618
The request object. A request to get user facing log
16281619
messages associated with data transfer
16291620
run.
1630-
16311621
retry (google.api_core.retry.Retry): Designation of what errors, if any,
16321622
should be retried.
16331623
timeout (float): The timeout for this request.
@@ -1817,7 +1807,6 @@ def __call__(
18171807
request (~.datatransfer.ScheduleTransferRunsRequest):
18181808
The request object. A request to schedule transfer runs
18191809
for a time range.
1820-
18211810
retry (google.api_core.retry.Retry): Designation of what errors, if any,
18221811
should be retried.
18231812
timeout (float): The timeout for this request.
@@ -1914,7 +1903,6 @@ def __call__(
19141903
request (~.datatransfer.StartManualTransferRunsRequest):
19151904
The request object. A request to start manual transfer
19161905
runs.
1917-
19181906
retry (google.api_core.retry.Retry): Designation of what errors, if any,
19191907
should be retried.
19201908
timeout (float): The timeout for this request.
@@ -2023,7 +2011,6 @@ def __call__(
20232011
configuration. To update the user id of
20242012
the transfer configuration,
20252013
authorization info needs to be provided.
2026-
20272014
retry (google.api_core.retry.Retry): Designation of what errors, if any,
20282015
should be retried.
20292016
timeout (float): The timeout for this request.

‎samples/generated_samples/snippet_metadata_google.cloud.bigquery.datatransfer.v1.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
],
99
"language": "PYTHON",
1010
"name": "google-cloud-bigquery-datatransfer",
11-
"version": "3.11.0"
11+
"version": "0.1.0"
1212
},
1313
"snippets": [
1414
{

0 commit comments

Comments
 (0)