Skip to content

Commit c022bf8

Browse files
docs: Fix formatting of request arg in docstring (#918)
* 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 428aa1e commit c022bf8

File tree

9 files changed

+40
-94
lines changed

9 files changed

+40
-94
lines changed

google/cloud/spanner_admin_database_v1/services/database_admin/async_client.py

Lines changed: 13 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -688,19 +688,19 @@ async def sample_update_database_ddl():
688688
689689
Args:
690690
request (Optional[Union[google.cloud.spanner_admin_database_v1.types.UpdateDatabaseDdlRequest, dict]]):
691-
The request object. Enqueues the given DDL statements to
692-
be applied, in order but not necessarily all at once, to
693-
the database schema at some point (or points) in the
694-
future. The server checks that the statements are
695-
executable (syntactically valid, name tables that exist,
696-
etc.) before enqueueing them, but they may still fail
697-
upon
691+
The request object. Enqueues the given DDL statements to be applied, in
692+
order but not necessarily all at once, to the database
693+
schema at some point (or points) in the future. The
694+
server checks that the statements are executable
695+
(syntactically valid, name tables that exist, etc.)
696+
before enqueueing them, but they may still fail upon
698697
later execution (e.g., if a statement from another batch
699698
of statements is applied first and it conflicts in some
700699
way, or if there is some data-related problem like a
701-
`NULL` value in a column to which `NOT NULL` would be
702-
added). If a statement fails, all subsequent statements
703-
in the batch are automatically cancelled.
700+
``NULL`` value in a column to which ``NOT NULL`` would
701+
be added). If a statement fails, all subsequent
702+
statements in the batch are automatically cancelled.
703+
704704
Each batch of statements is assigned a name which can be
705705
used with the
706706
[Operations][google.longrunning.Operations] API to
@@ -1072,8 +1072,7 @@ async def sample_set_iam_policy():
10721072
10731073
Args:
10741074
request (Optional[Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]]):
1075-
The request object. Request message for `SetIamPolicy`
1076-
method.
1075+
The request object. Request message for ``SetIamPolicy`` method.
10771076
resource (:class:`str`):
10781077
REQUIRED: The resource for which the
10791078
policy is being specified. See the
@@ -1247,8 +1246,7 @@ async def sample_get_iam_policy():
12471246
12481247
Args:
12491248
request (Optional[Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]]):
1250-
The request object. Request message for `GetIamPolicy`
1251-
method.
1249+
The request object. Request message for ``GetIamPolicy`` method.
12521250
resource (:class:`str`):
12531251
REQUIRED: The resource for which the
12541252
policy is being requested. See the
@@ -1434,8 +1432,7 @@ async def sample_test_iam_permissions():
14341432
14351433
Args:
14361434
request (Optional[Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]]):
1437-
The request object. Request message for
1438-
`TestIamPermissions` method.
1435+
The request object. Request message for ``TestIamPermissions`` method.
14391436
resource (:class:`str`):
14401437
REQUIRED: The resource for which the
14411438
policy detail is being requested. See

google/cloud/spanner_admin_database_v1/services/database_admin/client.py

Lines changed: 13 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -994,19 +994,19 @@ def sample_update_database_ddl():
994994
995995
Args:
996996
request (Union[google.cloud.spanner_admin_database_v1.types.UpdateDatabaseDdlRequest, dict]):
997-
The request object. Enqueues the given DDL statements to
998-
be applied, in order but not necessarily all at once, to
999-
the database schema at some point (or points) in the
1000-
future. The server checks that the statements are
1001-
executable (syntactically valid, name tables that exist,
1002-
etc.) before enqueueing them, but they may still fail
1003-
upon
997+
The request object. Enqueues the given DDL statements to be applied, in
998+
order but not necessarily all at once, to the database
999+
schema at some point (or points) in the future. The
1000+
server checks that the statements are executable
1001+
(syntactically valid, name tables that exist, etc.)
1002+
before enqueueing them, but they may still fail upon
10041003
later execution (e.g., if a statement from another batch
10051004
of statements is applied first and it conflicts in some
10061005
way, or if there is some data-related problem like a
1007-
`NULL` value in a column to which `NOT NULL` would be
1008-
added). If a statement fails, all subsequent statements
1009-
in the batch are automatically cancelled.
1006+
``NULL`` value in a column to which ``NOT NULL`` would
1007+
be added). If a statement fails, all subsequent
1008+
statements in the batch are automatically cancelled.
1009+
10101010
Each batch of statements is assigned a name which can be
10111011
used with the
10121012
[Operations][google.longrunning.Operations] API to
@@ -1348,8 +1348,7 @@ def sample_set_iam_policy():
13481348
13491349
Args:
13501350
request (Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]):
1351-
The request object. Request message for `SetIamPolicy`
1352-
method.
1351+
The request object. Request message for ``SetIamPolicy`` method.
13531352
resource (str):
13541353
REQUIRED: The resource for which the
13551354
policy is being specified. See the
@@ -1520,8 +1519,7 @@ def sample_get_iam_policy():
15201519
15211520
Args:
15221521
request (Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]):
1523-
The request object. Request message for `GetIamPolicy`
1524-
method.
1522+
The request object. Request message for ``GetIamPolicy`` method.
15251523
resource (str):
15261524
REQUIRED: The resource for which the
15271525
policy is being requested. See the
@@ -1694,8 +1692,7 @@ def sample_test_iam_permissions():
16941692
16951693
Args:
16961694
request (Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]):
1697-
The request object. Request message for
1698-
`TestIamPermissions` method.
1695+
The request object. Request message for ``TestIamPermissions`` method.
16991696
resource (str):
17001697
REQUIRED: The resource for which the
17011698
policy detail is being requested. See

google/cloud/spanner_admin_database_v1/services/database_admin/transports/rest.py

Lines changed: 0 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -955,7 +955,6 @@ def __call__(
955955
request (~.backup.CopyBackupRequest):
956956
The request object. The request for
957957
[CopyBackup][google.spanner.admin.database.v1.DatabaseAdmin.CopyBackup].
958-
959958
retry (google.api_core.retry.Retry): Designation of what errors, if any,
960959
should be retried.
961960
timeout (float): The timeout for this request.
@@ -1055,7 +1054,6 @@ def __call__(
10551054
request (~.gsad_backup.CreateBackupRequest):
10561055
The request object. The request for
10571056
[CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup].
1058-
10591057
retry (google.api_core.retry.Retry): Designation of what errors, if any,
10601058
should be retried.
10611059
timeout (float): The timeout for this request.
@@ -1153,7 +1151,6 @@ def __call__(
11531151
request (~.spanner_database_admin.CreateDatabaseRequest):
11541152
The request object. The request for
11551153
[CreateDatabase][google.spanner.admin.database.v1.DatabaseAdmin.CreateDatabase].
1156-
11571154
retry (google.api_core.retry.Retry): Designation of what errors, if any,
11581155
should be retried.
11591156
timeout (float): The timeout for this request.
@@ -1251,7 +1248,6 @@ def __call__(
12511248
request (~.backup.DeleteBackupRequest):
12521249
The request object. The request for
12531250
[DeleteBackup][google.spanner.admin.database.v1.DatabaseAdmin.DeleteBackup].
1254-
12551251
retry (google.api_core.retry.Retry): Designation of what errors, if any,
12561252
should be retried.
12571253
timeout (float): The timeout for this request.
@@ -1327,7 +1323,6 @@ def __call__(
13271323
request (~.spanner_database_admin.DropDatabaseRequest):
13281324
The request object. The request for
13291325
[DropDatabase][google.spanner.admin.database.v1.DatabaseAdmin.DropDatabase].
1330-
13311326
retry (google.api_core.retry.Retry): Designation of what errors, if any,
13321327
should be retried.
13331328
timeout (float): The timeout for this request.
@@ -1403,7 +1398,6 @@ def __call__(
14031398
request (~.backup.GetBackupRequest):
14041399
The request object. The request for
14051400
[GetBackup][google.spanner.admin.database.v1.DatabaseAdmin.GetBackup].
1406-
14071401
retry (google.api_core.retry.Retry): Designation of what errors, if any,
14081402
should be retried.
14091403
timeout (float): The timeout for this request.
@@ -1491,7 +1485,6 @@ def __call__(
14911485
request (~.spanner_database_admin.GetDatabaseRequest):
14921486
The request object. The request for
14931487
[GetDatabase][google.spanner.admin.database.v1.DatabaseAdmin.GetDatabase].
1494-
14951488
retry (google.api_core.retry.Retry): Designation of what errors, if any,
14961489
should be retried.
14971490
timeout (float): The timeout for this request.
@@ -1579,7 +1572,6 @@ def __call__(
15791572
request (~.spanner_database_admin.GetDatabaseDdlRequest):
15801573
The request object. The request for
15811574
[GetDatabaseDdl][google.spanner.admin.database.v1.DatabaseAdmin.GetDatabaseDdl].
1582-
15831575
retry (google.api_core.retry.Retry): Designation of what errors, if any,
15841576
should be retried.
15851577
timeout (float): The timeout for this request.
@@ -1846,7 +1838,6 @@ def __call__(
18461838
request (~.backup.ListBackupOperationsRequest):
18471839
The request object. The request for
18481840
[ListBackupOperations][google.spanner.admin.database.v1.DatabaseAdmin.ListBackupOperations].
1849-
18501841
retry (google.api_core.retry.Retry): Designation of what errors, if any,
18511842
should be retried.
18521843
timeout (float): The timeout for this request.
@@ -1938,7 +1929,6 @@ def __call__(
19381929
request (~.backup.ListBackupsRequest):
19391930
The request object. The request for
19401931
[ListBackups][google.spanner.admin.database.v1.DatabaseAdmin.ListBackups].
1941-
19421932
retry (google.api_core.retry.Retry): Designation of what errors, if any,
19431933
should be retried.
19441934
timeout (float): The timeout for this request.
@@ -2028,7 +2018,6 @@ def __call__(
20282018
request (~.spanner_database_admin.ListDatabaseOperationsRequest):
20292019
The request object. The request for
20302020
[ListDatabaseOperations][google.spanner.admin.database.v1.DatabaseAdmin.ListDatabaseOperations].
2031-
20322021
retry (google.api_core.retry.Retry): Designation of what errors, if any,
20332022
should be retried.
20342023
timeout (float): The timeout for this request.
@@ -2122,7 +2111,6 @@ def __call__(
21222111
request (~.spanner_database_admin.ListDatabaseRolesRequest):
21232112
The request object. The request for
21242113
[ListDatabaseRoles][google.spanner.admin.database.v1.DatabaseAdmin.ListDatabaseRoles].
2125-
21262114
retry (google.api_core.retry.Retry): Designation of what errors, if any,
21272115
should be retried.
21282116
timeout (float): The timeout for this request.
@@ -2214,7 +2202,6 @@ def __call__(
22142202
request (~.spanner_database_admin.ListDatabasesRequest):
22152203
The request object. The request for
22162204
[ListDatabases][google.spanner.admin.database.v1.DatabaseAdmin.ListDatabases].
2217-
22182205
retry (google.api_core.retry.Retry): Designation of what errors, if any,
22192206
should be retried.
22202207
timeout (float): The timeout for this request.
@@ -2304,7 +2291,6 @@ def __call__(
23042291
request (~.spanner_database_admin.RestoreDatabaseRequest):
23052292
The request object. The request for
23062293
[RestoreDatabase][google.spanner.admin.database.v1.DatabaseAdmin.RestoreDatabase].
2307-
23082294
retry (google.api_core.retry.Retry): Designation of what errors, if any,
23092295
should be retried.
23102296
timeout (float): The timeout for this request.
@@ -2688,7 +2674,6 @@ def __call__(
26882674
request (~.gsad_backup.UpdateBackupRequest):
26892675
The request object. The request for
26902676
[UpdateBackup][google.spanner.admin.database.v1.DatabaseAdmin.UpdateBackup].
2691-
26922677
retry (google.api_core.retry.Retry): Designation of what errors, if any,
26932678
should be retried.
26942679
timeout (float): The timeout for this request.
@@ -2802,7 +2787,6 @@ def __call__(
28022787
monitor progress. See the
28032788
[operation_id][google.spanner.admin.database.v1.UpdateDatabaseDdlRequest.operation_id]
28042789
field for more details.
2805-
28062790
retry (google.api_core.retry.Retry): Designation of what errors, if any,
28072791
should be retried.
28082792
timeout (float): The timeout for this request.

google/cloud/spanner_admin_instance_v1/services/instance_admin/async_client.py

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1876,8 +1876,7 @@ async def sample_set_iam_policy():
18761876
18771877
Args:
18781878
request (Optional[Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]]):
1879-
The request object. Request message for `SetIamPolicy`
1880-
method.
1879+
The request object. Request message for ``SetIamPolicy`` method.
18811880
resource (:class:`str`):
18821881
REQUIRED: The resource for which the
18831882
policy is being specified. See the
@@ -2047,8 +2046,7 @@ async def sample_get_iam_policy():
20472046
20482047
Args:
20492048
request (Optional[Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]]):
2050-
The request object. Request message for `GetIamPolicy`
2051-
method.
2049+
The request object. Request message for ``GetIamPolicy`` method.
20522050
resource (:class:`str`):
20532051
REQUIRED: The resource for which the
20542052
policy is being requested. See the
@@ -2231,8 +2229,7 @@ async def sample_test_iam_permissions():
22312229
22322230
Args:
22332231
request (Optional[Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]]):
2234-
The request object. Request message for
2235-
`TestIamPermissions` method.
2232+
The request object. Request message for ``TestIamPermissions`` method.
22362233
resource (:class:`str`):
22372234
REQUIRED: The resource for which the
22382235
policy detail is being requested. See

google/cloud/spanner_admin_instance_v1/services/instance_admin/client.py

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2070,8 +2070,7 @@ def sample_set_iam_policy():
20702070
20712071
Args:
20722072
request (Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]):
2073-
The request object. Request message for `SetIamPolicy`
2074-
method.
2073+
The request object. Request message for ``SetIamPolicy`` method.
20752074
resource (str):
20762075
REQUIRED: The resource for which the
20772076
policy is being specified. See the
@@ -2238,8 +2237,7 @@ def sample_get_iam_policy():
22382237
22392238
Args:
22402239
request (Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]):
2241-
The request object. Request message for `GetIamPolicy`
2242-
method.
2240+
The request object. Request message for ``GetIamPolicy`` method.
22432241
resource (str):
22442242
REQUIRED: The resource for which the
22452243
policy is being requested. See the
@@ -2409,8 +2407,7 @@ def sample_test_iam_permissions():
24092407
24102408
Args:
24112409
request (Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]):
2412-
The request object. Request message for
2413-
`TestIamPermissions` method.
2410+
The request object. Request message for ``TestIamPermissions`` method.
24142411
resource (str):
24152412
REQUIRED: The resource for which the
24162413
policy detail is being requested. See

0 commit comments

Comments
 (0)