Skip to content

Commit 45d3e43

Browse files
gcf-owl-bot[bot]gcf-owl-bot[bot]
authored
docs: Fix formatting of request arg in docstring (#756)
* 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>
1 parent 748310b commit 45d3e43

File tree

9 files changed

+42
-90
lines changed

9 files changed

+42
-90
lines changed

‎google/cloud/bigtable_admin_v2/services/bigtable_instance_admin/async_client.py‎

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1137,8 +1137,8 @@ async def update_cluster(
11371137
11381138
Args:
11391139
request (Optional[Union[google.cloud.bigtable_admin_v2.types.Cluster, dict]]):
1140-
The request object. A resizable group of nodes in a
1141-
particular cloud location, capable of serving all
1140+
The request object. A resizable group of nodes in a particular cloud
1141+
location, capable of serving all
11421142
[Tables][google.bigtable.admin.v2.Table] in the parent
11431143
[Instance][google.bigtable.admin.v2.Instance].
11441144
retry (google.api_core.retry.Retry): Designation of what errors, if any,
@@ -1880,8 +1880,7 @@ async def get_iam_policy(
18801880
18811881
Args:
18821882
request (Optional[Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]]):
1883-
The request object. Request message for `GetIamPolicy`
1884-
method.
1883+
The request object. Request message for ``GetIamPolicy`` method.
18851884
resource (:class:`str`):
18861885
REQUIRED: The resource for which the
18871886
policy is being requested. See the
@@ -2030,8 +2029,7 @@ async def set_iam_policy(
20302029
20312030
Args:
20322031
request (Optional[Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]]):
2033-
The request object. Request message for `SetIamPolicy`
2034-
method.
2032+
The request object. Request message for ``SetIamPolicy`` method.
20352033
resource (:class:`str`):
20362034
REQUIRED: The resource for which the
20372035
policy is being specified. See the
@@ -2171,8 +2169,7 @@ async def test_iam_permissions(
21712169
21722170
Args:
21732171
request (Optional[Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]]):
2174-
The request object. Request message for
2175-
`TestIamPermissions` method.
2172+
The request object. Request message for ``TestIamPermissions`` method.
21762173
resource (:class:`str`):
21772174
REQUIRED: The resource for which the
21782175
policy detail is being requested. See

‎google/cloud/bigtable_admin_v2/services/bigtable_instance_admin/client.py‎

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1400,8 +1400,8 @@ def update_cluster(
14001400
14011401
Args:
14021402
request (Union[google.cloud.bigtable_admin_v2.types.Cluster, dict]):
1403-
The request object. A resizable group of nodes in a
1404-
particular cloud location, capable of serving all
1403+
The request object. A resizable group of nodes in a particular cloud
1404+
location, capable of serving all
14051405
[Tables][google.bigtable.admin.v2.Table] in the parent
14061406
[Instance][google.bigtable.admin.v2.Instance].
14071407
retry (google.api_core.retry.Retry): Designation of what errors, if any,
@@ -2104,8 +2104,7 @@ def get_iam_policy(
21042104
21052105
Args:
21062106
request (Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]):
2107-
The request object. Request message for `GetIamPolicy`
2108-
method.
2107+
The request object. Request message for ``GetIamPolicy`` method.
21092108
resource (str):
21102109
REQUIRED: The resource for which the
21112110
policy is being requested. See the
@@ -2241,8 +2240,7 @@ def set_iam_policy(
22412240
22422241
Args:
22432242
request (Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]):
2244-
The request object. Request message for `SetIamPolicy`
2245-
method.
2243+
The request object. Request message for ``SetIamPolicy`` method.
22462244
resource (str):
22472245
REQUIRED: The resource for which the
22482246
policy is being specified. See the
@@ -2379,8 +2377,7 @@ def test_iam_permissions(
23792377
23802378
Args:
23812379
request (Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]):
2382-
The request object. Request message for
2383-
`TestIamPermissions` method.
2380+
The request object. Request message for ``TestIamPermissions`` method.
23842381
resource (str):
23852382
REQUIRED: The resource for which the
23862383
policy detail is being requested. See

‎google/cloud/bigtable_admin_v2/services/bigtable_instance_admin/transports/rest.py‎

Lines changed: 0 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -874,7 +874,6 @@ def __call__(
874874
request (~.bigtable_instance_admin.CreateAppProfileRequest):
875875
The request object. Request message for
876876
BigtableInstanceAdmin.CreateAppProfile.
877-
878877
retry (google.api_core.retry.Retry): Designation of what errors, if any,
879878
should be retried.
880879
timeout (float): The timeout for this request.
@@ -978,7 +977,6 @@ def __call__(
978977
request (~.bigtable_instance_admin.CreateClusterRequest):
979978
The request object. Request message for
980979
BigtableInstanceAdmin.CreateCluster.
981-
982980
retry (google.api_core.retry.Retry): Designation of what errors, if any,
983981
should be retried.
984982
timeout (float): The timeout for this request.
@@ -1076,7 +1074,6 @@ def __call__(
10761074
request (~.bigtable_instance_admin.CreateInstanceRequest):
10771075
The request object. Request message for
10781076
BigtableInstanceAdmin.CreateInstance.
1079-
10801077
retry (google.api_core.retry.Retry): Designation of what errors, if any,
10811078
should be retried.
10821079
timeout (float): The timeout for this request.
@@ -1176,7 +1173,6 @@ def __call__(
11761173
request (~.bigtable_instance_admin.DeleteAppProfileRequest):
11771174
The request object. Request message for
11781175
BigtableInstanceAdmin.DeleteAppProfile.
1179-
11801176
retry (google.api_core.retry.Retry): Designation of what errors, if any,
11811177
should be retried.
11821178
timeout (float): The timeout for this request.
@@ -1254,7 +1250,6 @@ def __call__(
12541250
request (~.bigtable_instance_admin.DeleteClusterRequest):
12551251
The request object. Request message for
12561252
BigtableInstanceAdmin.DeleteCluster.
1257-
12581253
retry (google.api_core.retry.Retry): Designation of what errors, if any,
12591254
should be retried.
12601255
timeout (float): The timeout for this request.
@@ -1330,7 +1325,6 @@ def __call__(
13301325
request (~.bigtable_instance_admin.DeleteInstanceRequest):
13311326
The request object. Request message for
13321327
BigtableInstanceAdmin.DeleteInstance.
1333-
13341328
retry (google.api_core.retry.Retry): Designation of what errors, if any,
13351329
should be retried.
13361330
timeout (float): The timeout for this request.
@@ -1406,7 +1400,6 @@ def __call__(
14061400
request (~.bigtable_instance_admin.GetAppProfileRequest):
14071401
The request object. Request message for
14081402
BigtableInstanceAdmin.GetAppProfile.
1409-
14101403
retry (google.api_core.retry.Retry): Designation of what errors, if any,
14111404
should be retried.
14121405
timeout (float): The timeout for this request.
@@ -1497,7 +1490,6 @@ def __call__(
14971490
request (~.bigtable_instance_admin.GetClusterRequest):
14981491
The request object. Request message for
14991492
BigtableInstanceAdmin.GetCluster.
1500-
15011493
retry (google.api_core.retry.Retry): Designation of what errors, if any,
15021494
should be retried.
15031495
timeout (float): The timeout for this request.
@@ -1759,7 +1751,6 @@ def __call__(
17591751
request (~.bigtable_instance_admin.GetInstanceRequest):
17601752
The request object. Request message for
17611753
BigtableInstanceAdmin.GetInstance.
1762-
17631754
retry (google.api_core.retry.Retry): Designation of what errors, if any,
17641755
should be retried.
17651756
timeout (float): The timeout for this request.
@@ -1853,7 +1844,6 @@ def __call__(
18531844
request (~.bigtable_instance_admin.ListAppProfilesRequest):
18541845
The request object. Request message for
18551846
BigtableInstanceAdmin.ListAppProfiles.
1856-
18571847
retry (google.api_core.retry.Retry): Designation of what errors, if any,
18581848
should be retried.
18591849
timeout (float): The timeout for this request.
@@ -1945,7 +1935,6 @@ def __call__(
19451935
request (~.bigtable_instance_admin.ListClustersRequest):
19461936
The request object. Request message for
19471937
BigtableInstanceAdmin.ListClusters.
1948-
19491938
retry (google.api_core.retry.Retry): Designation of what errors, if any,
19501939
should be retried.
19511940
timeout (float): The timeout for this request.
@@ -2035,7 +2024,6 @@ def __call__(
20352024
request (~.bigtable_instance_admin.ListHotTabletsRequest):
20362025
The request object. Request message for
20372026
BigtableInstanceAdmin.ListHotTablets.
2038-
20392027
retry (google.api_core.retry.Retry): Designation of what errors, if any,
20402028
should be retried.
20412029
timeout (float): The timeout for this request.
@@ -2127,7 +2115,6 @@ def __call__(
21272115
request (~.bigtable_instance_admin.ListInstancesRequest):
21282116
The request object. Request message for
21292117
BigtableInstanceAdmin.ListInstances.
2130-
21312118
retry (google.api_core.retry.Retry): Designation of what errors, if any,
21322119
should be retried.
21332120
timeout (float): The timeout for this request.
@@ -2219,7 +2206,6 @@ def __call__(
22192206
request (~.bigtable_instance_admin.PartialUpdateClusterRequest):
22202207
The request object. Request message for
22212208
BigtableInstanceAdmin.PartialUpdateCluster.
2222-
22232209
retry (google.api_core.retry.Retry): Designation of what errors, if any,
22242210
should be retried.
22252211
timeout (float): The timeout for this request.
@@ -2321,7 +2307,6 @@ def __call__(
23212307
request (~.bigtable_instance_admin.PartialUpdateInstanceRequest):
23222308
The request object. Request message for
23232309
BigtableInstanceAdmin.PartialUpdateInstance.
2324-
23252310
retry (google.api_core.retry.Retry): Designation of what errors, if any,
23262311
should be retried.
23272312
timeout (float): The timeout for this request.
@@ -2692,7 +2677,6 @@ def __call__(
26922677
request (~.bigtable_instance_admin.UpdateAppProfileRequest):
26932678
The request object. Request message for
26942679
BigtableInstanceAdmin.UpdateAppProfile.
2695-
26962680
retry (google.api_core.retry.Retry): Designation of what errors, if any,
26972681
should be retried.
26982682
timeout (float): The timeout for this request.
@@ -2784,7 +2768,6 @@ def __call__(
27842768
location, capable of serving all
27852769
[Tables][google.bigtable.admin.v2.Table] in the parent
27862770
[Instance][google.bigtable.admin.v2.Instance].
2787-
27882771
retry (google.api_core.retry.Retry): Designation of what errors, if any,
27892772
should be retried.
27902773
timeout (float): The timeout for this request.
@@ -2885,7 +2868,6 @@ def __call__(
28852868
served from all
28862869
[Clusters][google.bigtable.admin.v2.Cluster] in the
28872870
instance.
2888-
28892871
retry (google.api_core.retry.Retry): Designation of what errors, if any,
28902872
should be retried.
28912873
timeout (float): The timeout for this request.

‎google/cloud/bigtable_admin_v2/services/bigtable_table_admin/async_client.py‎

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -369,6 +369,7 @@ async def create_table_from_snapshot(
369369
request (Optional[Union[google.cloud.bigtable_admin_v2.types.CreateTableFromSnapshotRequest, dict]]):
370370
The request object. Request message for
371371
[google.bigtable.admin.v2.BigtableTableAdmin.CreateTableFromSnapshot][google.bigtable.admin.v2.BigtableTableAdmin.CreateTableFromSnapshot]
372+
372373
Note: This is a private alpha release of Cloud Bigtable
373374
snapshots. This feature is not currently available to
374375
most Cloud Bigtable customers. This feature might be
@@ -1300,6 +1301,7 @@ async def snapshot_table(
13001301
request (Optional[Union[google.cloud.bigtable_admin_v2.types.SnapshotTableRequest, dict]]):
13011302
The request object. Request message for
13021303
[google.bigtable.admin.v2.BigtableTableAdmin.SnapshotTable][google.bigtable.admin.v2.BigtableTableAdmin.SnapshotTable]
1304+
13031305
Note: This is a private alpha release of Cloud Bigtable
13041306
snapshots. This feature is not currently available to
13051307
most Cloud Bigtable customers. This feature might be
@@ -1437,6 +1439,7 @@ async def get_snapshot(
14371439
request (Optional[Union[google.cloud.bigtable_admin_v2.types.GetSnapshotRequest, dict]]):
14381440
The request object. Request message for
14391441
[google.bigtable.admin.v2.BigtableTableAdmin.GetSnapshot][google.bigtable.admin.v2.BigtableTableAdmin.GetSnapshot]
1442+
14401443
Note: This is a private alpha release of Cloud Bigtable
14411444
snapshots. This feature is not currently available to
14421445
most Cloud Bigtable customers. This feature might be
@@ -1549,6 +1552,7 @@ async def list_snapshots(
15491552
request (Optional[Union[google.cloud.bigtable_admin_v2.types.ListSnapshotsRequest, dict]]):
15501553
The request object. Request message for
15511554
[google.bigtable.admin.v2.BigtableTableAdmin.ListSnapshots][google.bigtable.admin.v2.BigtableTableAdmin.ListSnapshots]
1555+
15521556
Note: This is a private alpha release of Cloud Bigtable
15531557
snapshots. This feature is not currently available to
15541558
most Cloud Bigtable customers. This feature might be
@@ -1672,6 +1676,7 @@ async def delete_snapshot(
16721676
request (Optional[Union[google.cloud.bigtable_admin_v2.types.DeleteSnapshotRequest, dict]]):
16731677
The request object. Request message for
16741678
[google.bigtable.admin.v2.BigtableTableAdmin.DeleteSnapshot][google.bigtable.admin.v2.BigtableTableAdmin.DeleteSnapshot]
1679+
16751680
Note: This is a private alpha release of Cloud Bigtable
16761681
snapshots. This feature is not currently available to
16771682
most Cloud Bigtable customers. This feature might be
@@ -2290,8 +2295,7 @@ async def get_iam_policy(
22902295
22912296
Args:
22922297
request (Optional[Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]]):
2293-
The request object. Request message for `GetIamPolicy`
2294-
method.
2298+
The request object. Request message for ``GetIamPolicy`` method.
22952299
resource (:class:`str`):
22962300
REQUIRED: The resource for which the
22972301
policy is being requested. See the
@@ -2440,8 +2444,7 @@ async def set_iam_policy(
24402444
24412445
Args:
24422446
request (Optional[Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]]):
2443-
The request object. Request message for `SetIamPolicy`
2444-
method.
2447+
The request object. Request message for ``SetIamPolicy`` method.
24452448
resource (:class:`str`):
24462449
REQUIRED: The resource for which the
24472450
policy is being specified. See the
@@ -2581,8 +2584,7 @@ async def test_iam_permissions(
25812584
25822585
Args:
25832586
request (Optional[Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]]):
2584-
The request object. Request message for
2585-
`TestIamPermissions` method.
2587+
The request object. Request message for ``TestIamPermissions`` method.
25862588
resource (:class:`str`):
25872589
REQUIRED: The resource for which the
25882590
policy detail is being requested. See

‎google/cloud/bigtable_admin_v2/services/bigtable_table_admin/client.py‎

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -696,6 +696,7 @@ def create_table_from_snapshot(
696696
request (Union[google.cloud.bigtable_admin_v2.types.CreateTableFromSnapshotRequest, dict]):
697697
The request object. Request message for
698698
[google.bigtable.admin.v2.BigtableTableAdmin.CreateTableFromSnapshot][google.bigtable.admin.v2.BigtableTableAdmin.CreateTableFromSnapshot]
699+
699700
Note: This is a private alpha release of Cloud Bigtable
700701
snapshots. This feature is not currently available to
701702
most Cloud Bigtable customers. This feature might be
@@ -1594,6 +1595,7 @@ def snapshot_table(
15941595
request (Union[google.cloud.bigtable_admin_v2.types.SnapshotTableRequest, dict]):
15951596
The request object. Request message for
15961597
[google.bigtable.admin.v2.BigtableTableAdmin.SnapshotTable][google.bigtable.admin.v2.BigtableTableAdmin.SnapshotTable]
1598+
15971599
Note: This is a private alpha release of Cloud Bigtable
15981600
snapshots. This feature is not currently available to
15991601
most Cloud Bigtable customers. This feature might be
@@ -1731,6 +1733,7 @@ def get_snapshot(
17311733
request (Union[google.cloud.bigtable_admin_v2.types.GetSnapshotRequest, dict]):
17321734
The request object. Request message for
17331735
[google.bigtable.admin.v2.BigtableTableAdmin.GetSnapshot][google.bigtable.admin.v2.BigtableTableAdmin.GetSnapshot]
1736+
17341737
Note: This is a private alpha release of Cloud Bigtable
17351738
snapshots. This feature is not currently available to
17361739
most Cloud Bigtable customers. This feature might be
@@ -1833,6 +1836,7 @@ def list_snapshots(
18331836
request (Union[google.cloud.bigtable_admin_v2.types.ListSnapshotsRequest, dict]):
18341837
The request object. Request message for
18351838
[google.bigtable.admin.v2.BigtableTableAdmin.ListSnapshots][google.bigtable.admin.v2.BigtableTableAdmin.ListSnapshots]
1839+
18361840
Note: This is a private alpha release of Cloud Bigtable
18371841
snapshots. This feature is not currently available to
18381842
most Cloud Bigtable customers. This feature might be
@@ -1946,6 +1950,7 @@ def delete_snapshot(
19461950
request (Union[google.cloud.bigtable_admin_v2.types.DeleteSnapshotRequest, dict]):
19471951
The request object. Request message for
19481952
[google.bigtable.admin.v2.BigtableTableAdmin.DeleteSnapshot][google.bigtable.admin.v2.BigtableTableAdmin.DeleteSnapshot]
1953+
19491954
Note: This is a private alpha release of Cloud Bigtable
19501955
snapshots. This feature is not currently available to
19511956
most Cloud Bigtable customers. This feature might be
@@ -2545,8 +2550,7 @@ def get_iam_policy(
25452550
25462551
Args:
25472552
request (Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]):
2548-
The request object. Request message for `GetIamPolicy`
2549-
method.
2553+
The request object. Request message for ``GetIamPolicy`` method.
25502554
resource (str):
25512555
REQUIRED: The resource for which the
25522556
policy is being requested. See the
@@ -2682,8 +2686,7 @@ def set_iam_policy(
26822686
26832687
Args:
26842688
request (Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]):
2685-
The request object. Request message for `SetIamPolicy`
2686-
method.
2689+
The request object. Request message for ``SetIamPolicy`` method.
26872690
resource (str):
26882691
REQUIRED: The resource for which the
26892692
policy is being specified. See the
@@ -2820,8 +2823,7 @@ def test_iam_permissions(
28202823
28212824
Args:
28222825
request (Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]):
2823-
The request object. Request message for
2824-
`TestIamPermissions` method.
2826+
The request object. Request message for ``TestIamPermissions`` method.
28252827
resource (str):
28262828
REQUIRED: The resource for which the
28272829
policy detail is being requested. See

0 commit comments

Comments
 (0)