Skip to content

Commit

Permalink
docs: Minor formatting (#757)
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>
Co-authored-by: Victor Chudnovsky <vchudnov@google.com>
Co-authored-by: Daniel Sanche <sanche@google.com>
  • Loading branch information
4 people committed Sep 19, 2023
1 parent d0d3054 commit 41b5ea0
Show file tree
Hide file tree
Showing 23 changed files with 61 additions and 15 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@
from google.cloud.firestore_admin_v1.types import index as gfa_index
from google.cloud.firestore_admin_v1.types import operation as gfa_operation
from google.cloud.location import locations_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 google.protobuf import field_mask_pb2 # type: ignore
from .transports.base import FirestoreAdminTransport, DEFAULT_CLIENT_INFO
Expand Down Expand Up @@ -1453,6 +1453,7 @@ async def sample_create_database():
database, which will become the final
component of the database's resource
name.
The value must be set to "(default)".
This corresponds to the ``database_id`` field
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@
from google.cloud.firestore_admin_v1.types import index as gfa_index
from google.cloud.firestore_admin_v1.types import operation as gfa_operation
from google.cloud.location import locations_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 google.protobuf import field_mask_pb2 # type: ignore
from .transports.base import FirestoreAdminTransport, DEFAULT_CLIENT_INFO
Expand Down Expand Up @@ -1684,6 +1684,7 @@ def sample_create_database():
database, which will become the final
component of the database's resource
name.
The value must be set to "(default)".
This corresponds to the ``database_id`` field
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@
from google.cloud.firestore_admin_v1.types import firestore_admin
from google.cloud.firestore_admin_v1.types import index
from google.cloud.location import locations_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.firestore_admin_v1.types import firestore_admin
from google.cloud.firestore_admin_v1.types import index
from google.cloud.location import locations_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 FirestoreAdminTransport, DEFAULT_CLIENT_INFO
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@
from google.cloud.firestore_admin_v1.types import firestore_admin
from google.cloud.firestore_admin_v1.types import index
from google.cloud.location import locations_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 FirestoreAdminTransport, DEFAULT_CLIENT_INFO
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@
from google.protobuf import json_format
from google.api_core import operations_v1
from google.cloud.location import locations_pb2 # type: ignore
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.firestore_admin_v1.types import field
from google.cloud.firestore_admin_v1.types import firestore_admin
from google.cloud.firestore_admin_v1.types import index
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 (
FirestoreAdminTransport,
Expand Down
2 changes: 2 additions & 0 deletions google/cloud/firestore_admin_v1/types/database.py
Original file line number Diff line number Diff line change
Expand Up @@ -104,12 +104,14 @@ class ConcurrencyMode(proto.Enum):
Use pessimistic concurrency control by
default. This mode is available for Cloud
Firestore databases.
This is the default setting for Cloud Firestore.
OPTIMISTIC_WITH_ENTITY_GROUPS (3):
Use optimistic concurrency control with
entity groups by default.
This is the only available mode for Cloud
Datastore.
This mode is also available for Cloud Firestore
with Datastore Mode but is not recommended.
"""
Expand Down
1 change: 1 addition & 0 deletions google/cloud/firestore_admin_v1/types/field.py
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@

class Field(proto.Message):
r"""Represents a single field in the database.
Fields are grouped by their "Collection Group", which represent
all collections in the database with the same id.
Expand Down
1 change: 1 addition & 0 deletions google/cloud/firestore_admin_v1/types/firestore_admin.py
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,7 @@ class CreateDatabaseRequest(proto.Message):
Required. The ID to use for the database,
which will become the final component of the
database's resource name.
The value must be set to "(default)".
"""

Expand Down
1 change: 1 addition & 0 deletions google/cloud/firestore_admin_v1/types/index.py
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ class Index(proto.Message):
that is the child of a specific document,
specified at query time, and that has the same
collection id.
Indexes with a collection group query scope
specified allow queries against all collections
descended from a specific document, specified at
Expand Down
9 changes: 8 additions & 1 deletion google/cloud/firestore_v1/services/firestore/async_client.py
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@
from google.cloud.firestore_v1.types import query
from google.cloud.firestore_v1.types import write as gf_write
from google.cloud.location import locations_pb2 # type: ignore
from google.longrunning import operations_pb2
from google.longrunning import operations_pb2 # type: ignore
from google.protobuf import timestamp_pb2 # type: ignore
from google.rpc import status_pb2 # type: ignore
from .transports.base import FirestoreTransport, DEFAULT_CLIENT_INFO
Expand All @@ -64,6 +64,7 @@

class FirestoreAsyncClient:
"""The Cloud Firestore service.
Cloud Firestore is a fast, fully managed, serverless,
cloud-native NoSQL document database that simplifies storing,
syncing, and querying data for your mobile, web, and IoT apps at
Expand Down Expand Up @@ -276,6 +277,7 @@ async def sample_get_document():
Returns:
google.cloud.firestore_v1.types.Document:
A Firestore document.
Must not exceed 1 MiB - 4 bytes.
"""
Expand Down Expand Up @@ -483,6 +485,7 @@ async def sample_update_document():
The fields to update.
None of the field paths in the mask may
contain a reserved name.
If the document exists on the server and
has fields not referenced in the mask,
they are left unchanged.
Expand All @@ -502,6 +505,7 @@ async def sample_update_document():
Returns:
google.cloud.firestore_v1.types.Document:
A Firestore document.
Must not exceed 1 MiB - 4 bytes.
"""
Expand Down Expand Up @@ -673,6 +677,7 @@ def batch_get_documents(
metadata: Sequence[Tuple[str, str]] = (),
) -> Awaitable[AsyncIterable[firestore.BatchGetDocumentsResponse]]:
r"""Gets multiple documents.
Documents returned by this method are not guaranteed to
be returned in the same order that they were requested.
Expand Down Expand Up @@ -926,6 +931,7 @@ async def sample_commit():
should not be set.
writes (:class:`MutableSequence[google.cloud.firestore_v1.types.Write]`):
The writes to apply.
Always executed atomically and in order.
This corresponds to the ``writes`` field
Expand Down Expand Up @@ -1906,6 +1912,7 @@ async def sample_create_document():
Returns:
google.cloud.firestore_v1.types.Document:
A Firestore document.
Must not exceed 1 MiB - 4 bytes.
"""
Expand Down
9 changes: 8 additions & 1 deletion google/cloud/firestore_v1/services/firestore/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@
from google.cloud.firestore_v1.types import query
from google.cloud.firestore_v1.types import write as gf_write
from google.cloud.location import locations_pb2 # type: ignore
from google.longrunning import operations_pb2
from google.longrunning import operations_pb2 # type: ignore
from google.protobuf import timestamp_pb2 # type: ignore
from google.rpc import status_pb2 # type: ignore
from .transports.base import FirestoreTransport, DEFAULT_CLIENT_INFO
Expand Down Expand Up @@ -103,6 +103,7 @@ def get_transport_class(

class FirestoreClient(metaclass=FirestoreClientMeta):
"""The Cloud Firestore service.
Cloud Firestore is a fast, fully managed, serverless,
cloud-native NoSQL document database that simplifies storing,
syncing, and querying data for your mobile, web, and IoT apps at
Expand Down Expand Up @@ -488,6 +489,7 @@ def sample_get_document():
Returns:
google.cloud.firestore_v1.types.Document:
A Firestore document.
Must not exceed 1 MiB - 4 bytes.
"""
Expand Down Expand Up @@ -673,6 +675,7 @@ def sample_update_document():
The fields to update.
None of the field paths in the mask may
contain a reserved name.
If the document exists on the server and
has fields not referenced in the mask,
they are left unchanged.
Expand All @@ -692,6 +695,7 @@ def sample_update_document():
Returns:
google.cloud.firestore_v1.types.Document:
A Firestore document.
Must not exceed 1 MiB - 4 bytes.
"""
Expand Down Expand Up @@ -841,6 +845,7 @@ def batch_get_documents(
metadata: Sequence[Tuple[str, str]] = (),
) -> Iterable[firestore.BatchGetDocumentsResponse]:
r"""Gets multiple documents.
Documents returned by this method are not guaranteed to
be returned in the same order that they were requested.
Expand Down Expand Up @@ -1071,6 +1076,7 @@ def sample_commit():
should not be set.
writes (MutableSequence[google.cloud.firestore_v1.types.Write]):
The writes to apply.
Always executed atomically and in order.
This corresponds to the ``writes`` field
Expand Down Expand Up @@ -1954,6 +1960,7 @@ def sample_create_document():
Returns:
google.cloud.firestore_v1.types.Document:
A Firestore document.
Must not exceed 1 MiB - 4 bytes.
"""
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
from google.cloud.firestore_v1.types import document as gf_document
from google.cloud.firestore_v1.types import firestore
from google.cloud.location import locations_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

DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
from google.cloud.firestore_v1.types import document as gf_document
from google.cloud.firestore_v1.types import firestore
from google.cloud.location import locations_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 FirestoreTransport, DEFAULT_CLIENT_INFO

Expand All @@ -37,6 +37,7 @@ class FirestoreGrpcTransport(FirestoreTransport):
"""gRPC backend transport for Firestore.
The Cloud Firestore service.
Cloud Firestore is a fast, fully managed, serverless,
cloud-native NoSQL document database that simplifies storing,
syncing, and querying data for your mobile, web, and IoT apps at
Expand Down Expand Up @@ -354,6 +355,7 @@ def batch_get_documents(
r"""Return a callable for the batch get documents method over gRPC.
Gets multiple documents.
Documents returned by this method are not guaranteed to
be returned in the same order that they were requested.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
from google.cloud.firestore_v1.types import document as gf_document
from google.cloud.firestore_v1.types import firestore
from google.cloud.location import locations_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 FirestoreTransport, DEFAULT_CLIENT_INFO
from .grpc import FirestoreGrpcTransport
Expand All @@ -38,6 +38,7 @@ class FirestoreGrpcAsyncIOTransport(FirestoreTransport):
"""gRPC AsyncIO backend transport for Firestore.
The Cloud Firestore service.
Cloud Firestore is a fast, fully managed, serverless,
cloud-native NoSQL document database that simplifies storing,
syncing, and querying data for your mobile, web, and IoT apps at
Expand Down Expand Up @@ -360,6 +361,7 @@ def batch_get_documents(
r"""Return a callable for the batch get documents method over gRPC.
Gets multiple documents.
Documents returned by this method are not guaranteed to
be returned in the same order that they were requested.
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.cloud.location import locations_pb2 # type: ignore
from google.longrunning import operations_pb2
from requests import __version__ as requests_version
import dataclasses
import re
Expand All @@ -45,6 +44,7 @@
from google.cloud.firestore_v1.types import document as gf_document
from google.cloud.firestore_v1.types import firestore
from google.protobuf import empty_pb2 # type: ignore
from google.longrunning import operations_pb2 # type: ignore

from .base import FirestoreTransport, DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO

Expand Down Expand Up @@ -567,6 +567,7 @@ class FirestoreRestTransport(FirestoreTransport):
"""REST backend transport for Firestore.
The Cloud Firestore service.
Cloud Firestore is a fast, fully managed, serverless,
cloud-native NoSQL document database that simplifies storing,
syncing, and querying data for your mobile, web, and IoT apps at
Expand Down Expand Up @@ -1091,6 +1092,7 @@ def __call__(
Returns:
~.document.Document:
A Firestore document.
Must not exceed 1 MiB - 4 bytes.
"""
Expand Down Expand Up @@ -1264,6 +1266,7 @@ def __call__(
Returns:
~.document.Document:
A Firestore document.
Must not exceed 1 MiB - 4 bytes.
"""
Expand Down Expand Up @@ -1958,6 +1961,7 @@ def __call__(
Returns:
~.gf_document.Document:
A Firestore document.
Must not exceed 1 MiB - 4 bytes.
"""
Expand Down
1 change: 1 addition & 0 deletions google/cloud/firestore_v1/types/common.py
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,7 @@ class ReadOnly(proto.Message):
Attributes:
read_time (google.protobuf.timestamp_pb2.Timestamp):
Reads documents at the given time.
This must be a microsecond precision timestamp
within the past one hour, or if Point-in-Time
Recovery is enabled, can additionally be a whole
Expand Down
5 changes: 5 additions & 0 deletions google/cloud/firestore_v1/types/document.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@

class Document(proto.Message):
r"""A Firestore document.
Must not exceed 1 MiB - 4 bytes.
Attributes:
Expand Down Expand Up @@ -137,12 +138,14 @@ class Value(proto.Message):
This field is a member of `oneof`_ ``value_type``.
timestamp_value (google.protobuf.timestamp_pb2.Timestamp):
A timestamp value.
Precise only to microseconds. When stored, any
additional precision is rounded down.
This field is a member of `oneof`_ ``value_type``.
string_value (str):
A string value.
The string, represented as UTF-8, must not
exceed 1 MiB - 89 bytes. Only the first 1,500
bytes of the UTF-8 representation are considered
Expand All @@ -151,6 +154,7 @@ class Value(proto.Message):
This field is a member of `oneof`_ ``value_type``.
bytes_value (bytes):
A bytes value.
Must not exceed 1 MiB - 89 bytes.
Only the first 1,500 bytes are considered by
queries.
Expand All @@ -168,6 +172,7 @@ class Value(proto.Message):
This field is a member of `oneof`_ ``value_type``.
array_value (google.cloud.firestore_v1.types.ArrayValue):
An array value.
Cannot directly contain another array value,
though can contain an map which contains another
array.
Expand Down
Loading

0 comments on commit 41b5ea0

Please sign in to comment.