Skip to content

Commit

Permalink
docs: Fix formatting of request arg in docstring (googleapis#918)
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: 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>
  • Loading branch information
gcf-owl-bot[bot] and gcf-owl-bot[bot] committed Mar 23, 2023
1 parent 428aa1e commit c022bf8
Show file tree
Hide file tree
Showing 9 changed files with 40 additions and 94 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -688,19 +688,19 @@ async def sample_update_database_ddl():
Args:
request (Optional[Union[google.cloud.spanner_admin_database_v1.types.UpdateDatabaseDdlRequest, dict]]):
The request object. Enqueues the given DDL statements to
be applied, in order but not necessarily all at once, to
the database schema at some point (or points) in the
future. The server checks that the statements are
executable (syntactically valid, name tables that exist,
etc.) before enqueueing them, but they may still fail
upon
The request object. Enqueues the given DDL statements to be applied, in
order but not necessarily all at once, to the database
schema at some point (or points) in the future. The
server checks that the statements are executable
(syntactically valid, name tables that exist, etc.)
before enqueueing them, but they may still fail upon
later execution (e.g., if a statement from another batch
of statements is applied first and it conflicts in some
way, or if there is some data-related problem like a
`NULL` value in a column to which `NOT NULL` would be
added). If a statement fails, all subsequent statements
in the batch are automatically cancelled.
``NULL`` value in a column to which ``NOT NULL`` would
be added). If a statement fails, all subsequent
statements in the batch are automatically cancelled.
Each batch of statements is assigned a name which can be
used with the
[Operations][google.longrunning.Operations] API to
Expand Down Expand Up @@ -1072,8 +1072,7 @@ async def sample_set_iam_policy():
Args:
request (Optional[Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]]):
The request object. Request message for `SetIamPolicy`
method.
The request object. Request message for ``SetIamPolicy`` method.
resource (:class:`str`):
REQUIRED: The resource for which the
policy is being specified. See the
Expand Down Expand Up @@ -1247,8 +1246,7 @@ async def sample_get_iam_policy():
Args:
request (Optional[Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]]):
The request object. Request message for `GetIamPolicy`
method.
The request object. Request message for ``GetIamPolicy`` method.
resource (:class:`str`):
REQUIRED: The resource for which the
policy is being requested. See the
Expand Down Expand Up @@ -1434,8 +1432,7 @@ async def sample_test_iam_permissions():
Args:
request (Optional[Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]]):
The request object. Request message for
`TestIamPermissions` method.
The request object. Request message for ``TestIamPermissions`` method.
resource (:class:`str`):
REQUIRED: The resource for which the
policy detail is being requested. See
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -994,19 +994,19 @@ def sample_update_database_ddl():
Args:
request (Union[google.cloud.spanner_admin_database_v1.types.UpdateDatabaseDdlRequest, dict]):
The request object. Enqueues the given DDL statements to
be applied, in order but not necessarily all at once, to
the database schema at some point (or points) in the
future. The server checks that the statements are
executable (syntactically valid, name tables that exist,
etc.) before enqueueing them, but they may still fail
upon
The request object. Enqueues the given DDL statements to be applied, in
order but not necessarily all at once, to the database
schema at some point (or points) in the future. The
server checks that the statements are executable
(syntactically valid, name tables that exist, etc.)
before enqueueing them, but they may still fail upon
later execution (e.g., if a statement from another batch
of statements is applied first and it conflicts in some
way, or if there is some data-related problem like a
`NULL` value in a column to which `NOT NULL` would be
added). If a statement fails, all subsequent statements
in the batch are automatically cancelled.
``NULL`` value in a column to which ``NOT NULL`` would
be added). If a statement fails, all subsequent
statements in the batch are automatically cancelled.
Each batch of statements is assigned a name which can be
used with the
[Operations][google.longrunning.Operations] API to
Expand Down Expand Up @@ -1348,8 +1348,7 @@ def sample_set_iam_policy():
Args:
request (Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]):
The request object. Request message for `SetIamPolicy`
method.
The request object. Request message for ``SetIamPolicy`` method.
resource (str):
REQUIRED: The resource for which the
policy is being specified. See the
Expand Down Expand Up @@ -1520,8 +1519,7 @@ def sample_get_iam_policy():
Args:
request (Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]):
The request object. Request message for `GetIamPolicy`
method.
The request object. Request message for ``GetIamPolicy`` method.
resource (str):
REQUIRED: The resource for which the
policy is being requested. See the
Expand Down Expand Up @@ -1694,8 +1692,7 @@ def sample_test_iam_permissions():
Args:
request (Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]):
The request object. Request message for
`TestIamPermissions` method.
The request object. Request message for ``TestIamPermissions`` method.
resource (str):
REQUIRED: The resource for which the
policy detail is being requested. See
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -955,7 +955,6 @@ def __call__(
request (~.backup.CopyBackupRequest):
The request object. The request for
[CopyBackup][google.spanner.admin.database.v1.DatabaseAdmin.CopyBackup].
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 +1054,6 @@ def __call__(
request (~.gsad_backup.CreateBackupRequest):
The request object. The request for
[CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup].
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 @@ -1153,7 +1151,6 @@ def __call__(
request (~.spanner_database_admin.CreateDatabaseRequest):
The request object. The request for
[CreateDatabase][google.spanner.admin.database.v1.DatabaseAdmin.CreateDatabase].
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 @@ -1251,7 +1248,6 @@ def __call__(
request (~.backup.DeleteBackupRequest):
The request object. The request for
[DeleteBackup][google.spanner.admin.database.v1.DatabaseAdmin.DeleteBackup].
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 @@ -1327,7 +1323,6 @@ def __call__(
request (~.spanner_database_admin.DropDatabaseRequest):
The request object. The request for
[DropDatabase][google.spanner.admin.database.v1.DatabaseAdmin.DropDatabase].
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 @@ -1403,7 +1398,6 @@ def __call__(
request (~.backup.GetBackupRequest):
The request object. The request for
[GetBackup][google.spanner.admin.database.v1.DatabaseAdmin.GetBackup].
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 @@ -1491,7 +1485,6 @@ def __call__(
request (~.spanner_database_admin.GetDatabaseRequest):
The request object. The request for
[GetDatabase][google.spanner.admin.database.v1.DatabaseAdmin.GetDatabase].
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 @@ -1579,7 +1572,6 @@ def __call__(
request (~.spanner_database_admin.GetDatabaseDdlRequest):
The request object. The request for
[GetDatabaseDdl][google.spanner.admin.database.v1.DatabaseAdmin.GetDatabaseDdl].
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 @@ -1846,7 +1838,6 @@ def __call__(
request (~.backup.ListBackupOperationsRequest):
The request object. The request for
[ListBackupOperations][google.spanner.admin.database.v1.DatabaseAdmin.ListBackupOperations].
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 @@ -1938,7 +1929,6 @@ def __call__(
request (~.backup.ListBackupsRequest):
The request object. The request for
[ListBackups][google.spanner.admin.database.v1.DatabaseAdmin.ListBackups].
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 @@ -2028,7 +2018,6 @@ def __call__(
request (~.spanner_database_admin.ListDatabaseOperationsRequest):
The request object. The request for
[ListDatabaseOperations][google.spanner.admin.database.v1.DatabaseAdmin.ListDatabaseOperations].
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 @@ -2122,7 +2111,6 @@ def __call__(
request (~.spanner_database_admin.ListDatabaseRolesRequest):
The request object. The request for
[ListDatabaseRoles][google.spanner.admin.database.v1.DatabaseAdmin.ListDatabaseRoles].
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 @@ -2214,7 +2202,6 @@ def __call__(
request (~.spanner_database_admin.ListDatabasesRequest):
The request object. The request for
[ListDatabases][google.spanner.admin.database.v1.DatabaseAdmin.ListDatabases].
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 @@ -2304,7 +2291,6 @@ def __call__(
request (~.spanner_database_admin.RestoreDatabaseRequest):
The request object. The request for
[RestoreDatabase][google.spanner.admin.database.v1.DatabaseAdmin.RestoreDatabase].
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 @@ -2688,7 +2674,6 @@ def __call__(
request (~.gsad_backup.UpdateBackupRequest):
The request object. The request for
[UpdateBackup][google.spanner.admin.database.v1.DatabaseAdmin.UpdateBackup].
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 @@ -2802,7 +2787,6 @@ def __call__(
monitor progress. See the
[operation_id][google.spanner.admin.database.v1.UpdateDatabaseDdlRequest.operation_id]
field for more details.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1876,8 +1876,7 @@ async def sample_set_iam_policy():
Args:
request (Optional[Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]]):
The request object. Request message for `SetIamPolicy`
method.
The request object. Request message for ``SetIamPolicy`` method.
resource (:class:`str`):
REQUIRED: The resource for which the
policy is being specified. See the
Expand Down Expand Up @@ -2047,8 +2046,7 @@ async def sample_get_iam_policy():
Args:
request (Optional[Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]]):
The request object. Request message for `GetIamPolicy`
method.
The request object. Request message for ``GetIamPolicy`` method.
resource (:class:`str`):
REQUIRED: The resource for which the
policy is being requested. See the
Expand Down Expand Up @@ -2231,8 +2229,7 @@ async def sample_test_iam_permissions():
Args:
request (Optional[Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]]):
The request object. Request message for
`TestIamPermissions` method.
The request object. Request message for ``TestIamPermissions`` method.
resource (:class:`str`):
REQUIRED: The resource for which the
policy detail is being requested. See
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2070,8 +2070,7 @@ def sample_set_iam_policy():
Args:
request (Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]):
The request object. Request message for `SetIamPolicy`
method.
The request object. Request message for ``SetIamPolicy`` method.
resource (str):
REQUIRED: The resource for which the
policy is being specified. See the
Expand Down Expand Up @@ -2238,8 +2237,7 @@ def sample_get_iam_policy():
Args:
request (Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]):
The request object. Request message for `GetIamPolicy`
method.
The request object. Request message for ``GetIamPolicy`` method.
resource (str):
REQUIRED: The resource for which the
policy is being requested. See the
Expand Down Expand Up @@ -2409,8 +2407,7 @@ def sample_test_iam_permissions():
Args:
request (Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]):
The request object. Request message for
`TestIamPermissions` method.
The request object. Request message for ``TestIamPermissions`` method.
resource (str):
REQUIRED: The resource for which the
policy detail is being requested. See
Expand Down

0 comments on commit c022bf8

Please sign in to comment.