Skip to content

Commit

Permalink
docs: Minor formatting (#1006)
Browse files Browse the repository at this point in the history
* docs: Minor formatting
chore: Update gapic-generator-python to v1.11.5
build: Update rules_python to 0.24.0

PiperOrigin-RevId: 563436317

Source-Link: googleapis/googleapis@42fd37b

Source-Link: googleapis/googleapis-gen@280264c
Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiMjgwMjY0Y2EwMmZiOTMxNmI0MjM3YTk2ZDBhZjFhMjM0M2E4MWE1NiJ9

* 🦉 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] authored Sep 19, 2023
1 parent 43d7aec commit 498dba2
Show file tree
Hide file tree
Showing 24 changed files with 59 additions and 37 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@
from google.cloud.spanner_admin_database_v1.types import spanner_database_admin
from google.iam.v1 import iam_policy_pb2 # type: ignore
from google.iam.v1 import policy_pb2 # type: ignore
from google.longrunning import operations_pb2
from google.longrunning import operations_pb2 # type: ignore
from google.longrunning import operations_pb2 # type: ignore
from google.protobuf import empty_pb2 # type: ignore
from google.protobuf import field_mask_pb2 # type: ignore
Expand Down Expand Up @@ -1257,8 +1257,8 @@ async def sample_set_iam_policy():
The request object. Request message for ``SetIamPolicy`` method.
resource (:class:`str`):
REQUIRED: The resource for which the
policy is being specified.
See the operation documentation for the
policy is being specified. See the
operation documentation for the
appropriate value for this field.
This corresponds to the ``resource`` field
Expand Down Expand Up @@ -1400,8 +1400,8 @@ async def sample_get_iam_policy():
The request object. Request message for ``GetIamPolicy`` method.
resource (:class:`str`):
REQUIRED: The resource for which the
policy is being requested.
See the operation documentation for the
policy is being requested. See the
operation documentation for the
appropriate value for this field.
This corresponds to the ``resource`` field
Expand Down Expand Up @@ -1555,8 +1555,8 @@ async def sample_test_iam_permissions():
The request object. Request message for ``TestIamPermissions`` method.
resource (:class:`str`):
REQUIRED: The resource for which the
policy detail is being requested.
See the operation documentation for the
policy detail is being requested. See
the operation documentation for the
appropriate value for this field.
This corresponds to the ``resource`` field
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@
from google.cloud.spanner_admin_database_v1.types import spanner_database_admin
from google.iam.v1 import iam_policy_pb2 # type: ignore
from google.iam.v1 import policy_pb2 # type: ignore
from google.longrunning import operations_pb2
from google.longrunning import operations_pb2 # type: ignore
from google.longrunning import operations_pb2 # type: ignore
from google.protobuf import empty_pb2 # type: ignore
from google.protobuf import field_mask_pb2 # type: ignore
Expand Down Expand Up @@ -1523,8 +1523,8 @@ def sample_set_iam_policy():
The request object. Request message for ``SetIamPolicy`` method.
resource (str):
REQUIRED: The resource for which the
policy is being specified.
See the operation documentation for the
policy is being specified. See the
operation documentation for the
appropriate value for this field.
This corresponds to the ``resource`` field
Expand Down Expand Up @@ -1663,8 +1663,8 @@ def sample_get_iam_policy():
The request object. Request message for ``GetIamPolicy`` method.
resource (str):
REQUIRED: The resource for which the
policy is being requested.
See the operation documentation for the
policy is being requested. See the
operation documentation for the
appropriate value for this field.
This corresponds to the ``resource`` field
Expand Down Expand Up @@ -1805,8 +1805,8 @@ def sample_test_iam_permissions():
The request object. Request message for ``TestIamPermissions`` method.
resource (str):
REQUIRED: The resource for which the
policy detail is being requested.
See the operation documentation for the
policy detail is being requested. See
the operation documentation for the
appropriate value for this field.
This corresponds to the ``resource`` field
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@
from google.cloud.spanner_admin_database_v1.types import spanner_database_admin
from google.iam.v1 import iam_policy_pb2 # type: ignore
from google.iam.v1 import policy_pb2 # type: ignore
from google.longrunning import operations_pb2
from google.longrunning import operations_pb2 # type: ignore
from google.protobuf import empty_pb2 # type: ignore

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@
from google.cloud.spanner_admin_database_v1.types import spanner_database_admin
from google.iam.v1 import iam_policy_pb2 # type: ignore
from google.iam.v1 import policy_pb2 # type: ignore
from google.longrunning import operations_pb2
from google.longrunning import operations_pb2 # type: ignore
from google.protobuf import empty_pb2 # type: ignore
from .base import DatabaseAdminTransport, DEFAULT_CLIENT_INFO
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@
from google.cloud.spanner_admin_database_v1.types import spanner_database_admin
from google.iam.v1 import iam_policy_pb2 # type: ignore
from google.iam.v1 import policy_pb2 # type: ignore
from google.longrunning import operations_pb2
from google.longrunning import operations_pb2 # type: ignore
from google.protobuf import empty_pb2 # type: ignore
from .base import DatabaseAdminTransport, DEFAULT_CLIENT_INFO
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,6 @@

from google.protobuf import json_format
from google.api_core import operations_v1
from google.longrunning import operations_pb2
from requests import __version__ as requests_version
import dataclasses
import re
Expand All @@ -46,8 +45,8 @@
from google.cloud.spanner_admin_database_v1.types import spanner_database_admin
from google.iam.v1 import iam_policy_pb2 # type: ignore
from google.iam.v1 import policy_pb2 # type: ignore
from google.longrunning import operations_pb2 # type: ignore
from google.protobuf import empty_pb2 # type: ignore
from google.longrunning import operations_pb2 # type: ignore

from .base import (
DatabaseAdminTransport,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,7 @@ class Database(proto.Message):
the encryption information for the database,
such as encryption state and the Cloud KMS key
versions that are in use.
For databases that are using Google default or
other types of encryption, this field is empty.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,10 +58,12 @@

class InstanceAdminAsyncClient:
"""Cloud Spanner Instance Admin API
The Cloud Spanner Instance Admin API can be used to create,
delete, modify and list instances. Instances are dedicated Cloud
Spanner serving and storage resources to be used by Cloud
Spanner databases.
Each instance has a "configuration", which dictates where the
serving resources for the Cloud Spanner instance are located
(e.g., US-central, Europe). Configurations are created by Google
Expand Down Expand Up @@ -1879,8 +1881,8 @@ async def sample_set_iam_policy():
The request object. Request message for ``SetIamPolicy`` method.
resource (:class:`str`):
REQUIRED: The resource for which the
policy is being specified.
See the operation documentation for the
policy is being specified. See the
operation documentation for the
appropriate value for this field.
This corresponds to the ``resource`` field
Expand Down Expand Up @@ -2018,8 +2020,8 @@ async def sample_get_iam_policy():
The request object. Request message for ``GetIamPolicy`` method.
resource (:class:`str`):
REQUIRED: The resource for which the
policy is being requested.
See the operation documentation for the
policy is being requested. See the
operation documentation for the
appropriate value for this field.
This corresponds to the ``resource`` field
Expand Down Expand Up @@ -2170,8 +2172,8 @@ async def sample_test_iam_permissions():
The request object. Request message for ``TestIamPermissions`` method.
resource (:class:`str`):
REQUIRED: The resource for which the
policy detail is being requested.
See the operation documentation for the
policy detail is being requested. See
the operation documentation for the
appropriate value for this field.
This corresponds to the ``resource`` field
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -98,10 +98,12 @@ def get_transport_class(

class InstanceAdminClient(metaclass=InstanceAdminClientMeta):
"""Cloud Spanner Instance Admin API
The Cloud Spanner Instance Admin API can be used to create,
delete, modify and list instances. Instances are dedicated Cloud
Spanner serving and storage resources to be used by Cloud
Spanner databases.
Each instance has a "configuration", which dictates where the
serving resources for the Cloud Spanner instance are located
(e.g., US-central, Europe). Configurations are created by Google
Expand Down Expand Up @@ -2073,8 +2075,8 @@ def sample_set_iam_policy():
The request object. Request message for ``SetIamPolicy`` method.
resource (str):
REQUIRED: The resource for which the
policy is being specified.
See the operation documentation for the
policy is being specified. See the
operation documentation for the
appropriate value for this field.
This corresponds to the ``resource`` field
Expand Down Expand Up @@ -2209,8 +2211,8 @@ def sample_get_iam_policy():
The request object. Request message for ``GetIamPolicy`` method.
resource (str):
REQUIRED: The resource for which the
policy is being requested.
See the operation documentation for the
policy is being requested. See the
operation documentation for the
appropriate value for this field.
This corresponds to the ``resource`` field
Expand Down Expand Up @@ -2348,8 +2350,8 @@ def sample_test_iam_permissions():
The request object. Request message for ``TestIamPermissions`` method.
resource (str):
REQUIRED: The resource for which the
policy detail is being requested.
See the operation documentation for the
policy detail is being requested. See
the operation documentation for the
appropriate value for this field.
This corresponds to the ``resource`` field
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,12 @@ class InstanceAdminGrpcTransport(InstanceAdminTransport):
"""gRPC backend transport for InstanceAdmin.
Cloud Spanner Instance Admin API
The Cloud Spanner Instance Admin API can be used to create,
delete, modify and list instances. Instances are dedicated Cloud
Spanner serving and storage resources to be used by Cloud
Spanner databases.
Each instance has a "configuration", which dictates where the
serving resources for the Cloud Spanner instance are located
(e.g., US-central, Europe). Configurations are created by Google
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,10 +38,12 @@ class InstanceAdminGrpcAsyncIOTransport(InstanceAdminTransport):
"""gRPC AsyncIO backend transport for InstanceAdmin.
Cloud Spanner Instance Admin API
The Cloud Spanner Instance Admin API can be used to create,
delete, modify and list instances. Instances are dedicated Cloud
Spanner serving and storage resources to be used by Cloud
Spanner databases.
Each instance has a "configuration", which dictates where the
serving resources for the Cloud Spanner instance are located
(e.g., US-central, Europe). Configurations are created by Google
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,8 @@
from google.cloud.spanner_admin_instance_v1.types import spanner_instance_admin
from google.iam.v1 import iam_policy_pb2 # type: ignore
from google.iam.v1 import policy_pb2 # type: ignore
from google.longrunning import operations_pb2 # type: ignore
from google.protobuf import empty_pb2 # type: ignore
from google.longrunning import operations_pb2 # type: ignore

from .base import (
InstanceAdminTransport,
Expand Down Expand Up @@ -505,10 +505,12 @@ class InstanceAdminRestTransport(InstanceAdminTransport):
"""REST backend transport for InstanceAdmin.
Cloud Spanner Instance Admin API
The Cloud Spanner Instance Admin API can be used to create,
delete, modify and list instances. Instances are dedicated Cloud
Spanner serving and storage resources to be used by Cloud
Spanner databases.
Each instance has a "configuration", which dictates where the
serving resources for the Cloud Spanner instance are located
(e.g., US-central, Europe). Configurations are created by Google
Expand Down
2 changes: 2 additions & 0 deletions google/cloud/spanner_v1/services/spanner/async_client.py
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@

class SpannerAsyncClient:
"""Cloud Spanner API
The Cloud Spanner API can be used to manage sessions and execute
transactions on data stored in Cloud Spanner databases.
"""
Expand Down Expand Up @@ -357,6 +358,7 @@ async def batch_create_sessions(
metadata: Sequence[Tuple[str, str]] = (),
) -> spanner.BatchCreateSessionsResponse:
r"""Creates multiple new sessions.
This API can be used to initialize a session cache on
the clients. See https://goo.gl/TgSFN2 for best
practices on session cache management.
Expand Down
2 changes: 2 additions & 0 deletions google/cloud/spanner_v1/services/spanner/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,7 @@ def get_transport_class(

class SpannerClient(metaclass=SpannerClientMeta):
"""Cloud Spanner API
The Cloud Spanner API can be used to manage sessions and execute
transactions on data stored in Cloud Spanner databases.
"""
Expand Down Expand Up @@ -604,6 +605,7 @@ def batch_create_sessions(
metadata: Sequence[Tuple[str, str]] = (),
) -> spanner.BatchCreateSessionsResponse:
r"""Creates multiple new sessions.
This API can be used to initialize a session cache on
the clients. See https://goo.gl/TgSFN2 for best
practices on session cache management.
Expand Down
2 changes: 2 additions & 0 deletions google/cloud/spanner_v1/services/spanner/transports/grpc.py
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ class SpannerGrpcTransport(SpannerTransport):
"""gRPC backend transport for Spanner.
Cloud Spanner API
The Cloud Spanner API can be used to manage sessions and execute
transactions on data stored in Cloud Spanner databases.
Expand Down Expand Up @@ -288,6 +289,7 @@ def batch_create_sessions(
r"""Return a callable for the batch create sessions method over gRPC.
Creates multiple new sessions.
This API can be used to initialize a session cache on
the clients. See https://goo.gl/TgSFN2 for best
practices on session cache management.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ class SpannerGrpcAsyncIOTransport(SpannerTransport):
"""gRPC AsyncIO backend transport for Spanner.
Cloud Spanner API
The Cloud Spanner API can be used to manage sessions and execute
transactions on data stored in Cloud Spanner databases.
Expand Down Expand Up @@ -292,6 +293,7 @@ def batch_create_sessions(
r"""Return a callable for the batch create sessions method over gRPC.
Creates multiple new sessions.
This API can be used to initialize a session cache on
the clients. See https://goo.gl/TgSFN2 for best
practices on session cache management.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -493,6 +493,7 @@ class SpannerRestTransport(SpannerTransport):
"""REST backend transport for Spanner.
Cloud Spanner API
The Cloud Spanner API can be used to manage sessions and execute
transactions on data stored in Cloud Spanner databases.
Expand Down
3 changes: 3 additions & 0 deletions google/cloud/spanner_v1/types/spanner.py
Original file line number Diff line number Diff line change
Expand Up @@ -390,6 +390,7 @@ class ExecuteSqlRequest(proto.Message):
should be performed.
transaction (google.cloud.spanner_v1.types.TransactionSelector):
The transaction to use.
For queries, if none is provided, the default is
a temporary read-only transaction with strong
concurrency.
Expand All @@ -399,6 +400,7 @@ class ExecuteSqlRequest(proto.Message):
single-use transactions are not supported. The
caller must either supply an existing
transaction ID or begin a new transaction.
Partitioned DML requires an existing Partitioned
DML transaction ID.
sql (str):
Expand Down Expand Up @@ -469,6 +471,7 @@ class ExecuteSqlRequest(proto.Message):
sequence number, the transaction may be aborted.
Replays of previously handled requests will
yield the same response as the first execution.
Required for DML statements. Ignored for
queries.
query_options (google.cloud.spanner_v1.types.ExecuteSqlRequest.QueryOptions):
Expand Down
3 changes: 3 additions & 0 deletions google/cloud/spanner_v1/types/transaction.py
Original file line number Diff line number Diff line change
Expand Up @@ -417,13 +417,16 @@ class ReadLockMode(proto.Enum):
Values:
READ_LOCK_MODE_UNSPECIFIED (0):
Default value.
If the value is not specified, the pessimistic
read lock is used.
PESSIMISTIC (1):
Pessimistic lock mode.
Read locks are acquired immediately on read.
OPTIMISTIC (2):
Optimistic lock mode.
Locks for reads within the transaction are not
acquired on read. Instead the locks are acquired
on a commit to validate that read/queried data
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
],
"language": "PYTHON",
"name": "google-cloud-spanner-admin-database",
"version": "3.40.1"
"version": "0.1.0"
},
"snippets": [
{
Expand Down
Loading

0 comments on commit 498dba2

Please sign in to comment.