10000 docs: Minor formatting by gcf-owl-bot[bot] · Pull Request #476 · googleapis/python-datastore · GitHub
[go: up one dir, main page]

Skip to content

docs: Minor formatting #476

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 13, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Origina 8000 l file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
from google.cloud.datastore_admin_v1.services.datastore_admin import pagers
from google.cloud.datastore_admin_v1.types import datastore_admin
from google.cloud.datastore_admin_v1.types import index
from google.longrunning import operations_pb2
from google.longrunning import operations_pb2 # type: ignore
from google.protobuf import empty_pb2 # type: ignore
from .transports.base import DatastoreAdminTransport, DEFAULT_CLIENT_INFO
from .transports.grpc_asyncio import DatastoreAdminGrpcAsyncIOTransport
Expand All @@ -56,13 +56,16 @@

class DatastoreAdminAsyncClient:
"""Google Cloud Datastore Admin API

The Datastore Admin API provides several admin services for
Cloud Datastore.

Concepts: Project, namespace, kind, and entity as defined in the
Google Cloud Datastore API.

Operation: An Operation represents work being performed in the
background.

EntityFilter: Allows specifying a subset of entities in a
project. This is specified as a combination of kinds and
namespaces (either or both of which may be all).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@
from google.cloud.datastore_admin_v1.services.datastore_admin import pagers
from google.cloud.datastore_admin_v1.types import datastore_admin
from google.cloud.datastore_admin_v1.types import index
from google.longrunning import operations_pb2
from google.longrunning import operations_pb2 # type: ignore
from google.protobuf import empty_pb2 # type: ignore
from .transports.base import DatastoreAdminTransport, DEFAULT_CLIENT_INFO
from .transports.grpc import DatastoreAdminGrpcTransport
Expand Down Expand Up @@ -98,13 +98,16 @@ def get_transport_class(

class DatastoreAdminClient(metaclass=DatastoreAdminClientMeta):
"""Google Cloud Datastore Admin API

The Datastore Admin API provides several admin services for
Cloud Datastore.

Concepts: Project, namespace, kind, and entity as defined in the
Google Cloud Datastore API.

Operation: An Operation represents work being performed in the
background.

EntityFilter: Allows specifying a subset of entities in a
project. This is specified as a combination of kinds and
namespaces (either or both of which may be all).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@

from google.cloud.datastore_admin_v1.types import datastore_admin
from google.cloud.datastore_admin_v1.types import index
from google.longrunning import operations_pb2
from google.longrunning import operations_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 @@ -27,7 +27,6 @@

from google.cloud.datastore_admin_v1.types import datastore_admin
from google.cloud.datastore_admin_v1.types import index
from google.longrunning import operations_pb2
from google.longrunning import operations_pb2 # type: ignore
from .base import DatastoreAdminTransport, DEFAULT_CLIENT_INFO

Expand All @@ -36,13 +35,16 @@ class DatastoreAdminGrpcTransport(DatastoreAdminTransport):
"""gRPC backend transport for DatastoreAdmin.

Google Cloud Datastore Admin API

The Datastore Admin API provides several admin services for
Cloud Datastore.

Concepts: Project, namespace, kind, and entity as defined in the
Google Cloud Datastore API.

Operation: An Operation represents work being performed in the
background.

EntityFilter: Allows specifying a subset of entities in a
project. This is specified as a combination of kinds and
namespaces (either or both of which may be all).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@

from google.cloud.datastore_admin_v1.types import datastore_admin
from google.cloud.datastore_admin_v1.types import index
from google.longrunning import operations_pb2
from google.longrunning import operations_pb2 # type: ignore
from .base import DatastoreAdminTransport, DEFAULT_CLIENT_INFO
from .grpc import DatastoreAdminGrpcTransport
Expand All @@ -37,13 +36,16 @@ class DatastoreAdminGrpcAsyncIOTransport(DatastoreAdminTransport):
"""gRPC AsyncIO backend transport for DatastoreAdmin.

Google Cloud Datastore Admin API

The Datastore Admin API provides several admin services for
Cloud Datastore.

Concepts: Project, namespace, kind, and entity as defined in the
Google Cloud Datastore API.

Operation: An Operation represents work being performed in the
background.

EntityFilter: Allows specifying a subset of entities in a
project. This is specified as a combination of kinds and
namespaces (either or both of which may be all).
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 Down Expand Up @@ -363,13 +362,16 @@ class DatastoreAdminRestTransport(DatastoreAdminTransport):
"""REST backend transport for DatastoreAdmin.

Google Cloud Datastore Admin API

The Datastore Admin API provides several admin services for
Cloud Datastore.

Concepts: Project, namespace, kind, and entity as defined in the
Google Cloud Datastore API.

Operation: An Operation represents work being performed in the
background.

EntityFilter: Allows specifying a subset of entities in a
project. This is specified as a combination of kinds and
namespaces (either or both of which may be all).
Expand Down
1 change: 1 addition & 0 deletions google/cloud/datastore_admin_v1/types/datastore_admin.py
Original file line number Diff line number Diff line change
Expand Up @@ -429,6 +429,7 @@ class EntityFilter(proto.Message):
An empty list represents all namespaces. This
is the preferred usage for projects that don't
use namespaces.

An empty string element represents the default
namespace. This should be used if the project
has data in non-default namespaces, but doesn't
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@
from google.cloud.datastore_v1.types import datastore
from google.cloud.datastore_v1.types import entity
from google.cloud.datastore_v1.types import query
from google.longrunning import operations_pb2
from google.longrunning import operations_pb2 # type: ignore
from google.protobuf import timestamp_pb2 # type: ignore
from .transports.base import DatastoreTransport, DEFAULT_CLIENT_INFO
from .transports.grpc_asyncio import DatastoreGrpcAsyncIOTransport
Expand Down
2 changes: 1 addition & 1 deletion google/cloud/datastore_v1/services/datastore/client.py
10000
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@
from google.cloud.datastore_v1.types import datastore
from google.cloud.datastore_v1.types import entity
from google.cloud.datastore_v1.types import query
from google.longrunning import operations_pb2
from google.longrunning import operations_pb2 # type: ignore
from google.protobuf import timestamp_pb2 # type: ignore
from .transports.base import DatastoreTransport, DEFAULT_CLIENT_INFO
from .transports.grpc import DatastoreGrpcTransport
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
from google.oauth2 import service_account # type: ignore

from google.cloud.datastore_v1.types import datastore
from google.longrunning import operations_pb2
from google.longrunning import operations_pb2 # type: ignore

DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(
gapic_version=package_version.__version__
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
import grpc # type: ignore

from google.cloud.datastore_v1.types import datastore
from google.longrunning import operations_pb2
from google.longrunning import operations_pb2 # type: ignore
from .base import DatastoreTransport, DEFAULT_CLIENT_INFO


Expand Down
F987
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
from grpc.experimental import aio # type: ignore

from google.cloud.datastore_v1.types import datastore
from google.longrunning import operations_pb2
from google.longrunning import operations_pb2 # type: ignore
from .base import DatastoreTransport, DEFAULT_CLIENT_INFO
from .grpc import DatastoreGrpcTransport

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@
from google.api_core import gapic_v1

from google.protobuf import json_format
from google.longrunning import operations_pb2
from requests import __version__ as requests_version
import dataclasses
import re
Expand All @@ -41,6 +40,7 @@


from google.cloud.datastore_v1.types import datastore
from google.longrunning import operations_pb2 # type: ignore

from .base import DatastoreTransport, DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO

Expand Down
1 change: 1 addition & 0 deletions google/cloud/datastore_v1/types/aggregation_result.py
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@ class AggregationResultBatch(proto.Message):
``NO_MORE_RESULTS``.
read_time (google.protobuf.timestamp_pb2.Timestamp):
Read timestamp this batch was returned from.

In a single transaction, subsequent query result
batches for the same query can have a greater
timestamp. Each batch's read timestamp is valid
Expand Down
2 changes: 2 additions & 0 deletions google/cloud/datastore_v1/types/datastore.py
Original file line number Diff line number Diff line change
Expand Up @@ -861,6 +861,7 @@ class ReadOptions(proto.Message):
Reads entities as they were at the given
time. This value is only supported for Cloud
Firestore in Datastore mode.

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 Expand Up @@ -957,6 +958,7 @@ class ReadOnly(proto.Message):
Attributes:
read_time (google.protobuf.timestamp_pb2.Timestamp):
Reads entities 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
4 changes: 4 additions & 0 deletions google/cloud/datastore_v1/types/entity.py
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,7 @@ class Key(proto.Message):

class PathElement(proto.Message):
r"""A (kind, ID/name) pair used to construct a key path.

If either name or ID is set, the element is complete. If neither
is set, the element is incomplete.

Expand All @@ -143,6 +144,7 @@ class PathElement(proto.Message):
base-64 encoding of the bytes.
id (int):
The auto-allocated ID of the entity.

Never equal to zero. Values less than zero are
discouraged and may not be supported in the
future.
Expand Down Expand Up @@ -264,6 +266,7 @@ class Value(proto.Message):
This field is a member of `oneof`_ ``value_type``.
entity_value (google.cloud.datastore_v1.types.Entity):
An entity value.

- May have no key.
- May have a key with an incomplete key path.
- May have a reserved/read-only key.
Expand Down Expand Up @@ -356,6 +359,7 @@ class Value(proto.Message):

class Entity(proto.Message):
r"""A Datastore data object.

Must not exceed 1 MiB - 4 bytes.

Attributes:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@
from google.cloud.datastore_admin_v1.services.datastore_admin import transports
from google.cloud.datastore_admin_v1.types import datastore_admin
from google.cloud.datastore_admin_v1.types import index
from google.longrunning import operations_pb2
from google.longrunning import operations_pb2 # type: ignore
from google.oauth2 import service_account
from google.protobuf import empty_pb2 # type: ignore
import google.auth
Expand Down
2 changes: 1 addition & 1 deletion tests/unit/gapic/datastore_v1/test_datastore.py
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@
from google.cloud.datastore_v1.types import datastore
from google.cloud.datastore_v1.types import entity
from google.cloud.datastore_v1.types import query
from google.longrunning import operations_pb2
from google.longrunning import operations_pb2 # type: ignore
from google.oauth2 import service_account
from google.protobuf import struct_pb2 # type: ignore
from google.protobuf import timestamp_pb2 # type: ignore
Expand Down
0