Package Methods (2.21.0) (original) (raw)

Summary of entries of Methods for datastore.

google.cloud.datastore.helpers.entity_from_protobuf

google.cloud.datastore.helpers.entity_to_protobuf

entity_to_protobuf(entity)

google.cloud.datastore.helpers.get_read_options

get_read_options(
    eventual, transaction_id, read_time=None, new_transaction_options=None
)

google.cloud.datastore.helpers.get_transaction_options

get_transaction_options(transaction)

google.cloud.datastore.helpers.key_from_protobuf

google.cloud.datastore.helpers.set_database_id_to_request

set_database_id_to_request(request, database_id=None)

google.cloud.datastore.aggregation.AggregationQuery.add_aggregation

add_aggregation(aggregation)

google.cloud.datastore.aggregation.AggregationQuery.add_aggregations

add_aggregations(aggregations)

google.cloud.datastore.aggregation.AggregationQuery.avg

avg(property_ref, alias=None)

google.cloud.datastore.aggregation.AggregationQuery.count

google.cloud.datastore.aggregation.AggregationQuery.fetch

fetch(
    client=None, limit=None, eventual=False, retry=None, timeout=None, read_time=None
)

google.cloud.datastore.aggregation.AggregationQuery.sum

sum(property_ref, alias=None)

google.cloud.datastore.batch.Batch.begin

google.cloud.datastore.batch.Batch.commit

commit(retry=None, timeout=None)

google.cloud.datastore.batch.Batch.current

google.cloud.datastore.batch.Batch.delete

google.cloud.datastore.batch.Batch.put

google.cloud.datastore.batch.Batch.rollback

google.cloud.datastore.client.Client.aggregation_query

aggregation_query(query, **kwargs)

google.cloud.datastore.client.Client.allocate_ids

allocate_ids(incomplete_key, num_ids, retry=None, timeout=None)

google.cloud.datastore.client.Client.batch

google.cloud.datastore.client.Client.delete

delete(key, retry=None, timeout=None)

google.cloud.datastore.client.Client.delete_multi

delete_multi(keys, retry=None, timeout=None)

google.cloud.datastore.client.Client.entity

entity(key=None, exclude_from_indexes=())

google.cloud.datastore.client.Client.get

get(
    key,
    missing=None,
    deferred=None,
    transaction=None,
    eventual=False,
    retry=None,
    timeout=None,
    read_time=None,
)

google.cloud.datastore.client.Client.get_multi

get_multi(
    keys,
    missing=None,
    deferred=None,
    transaction=None,
    eventual=False,
    retry=None,
    timeout=None,
    read_time=None,
)

google.cloud.datastore.client.Client.key

key(*path_args, **kwargs)

google.cloud.datastore.client.Client.put

put(entity, retry=None, timeout=None)

google.cloud.datastore.client.Client.put_multi

put_multi(entities, retry=None, timeout=None)

google.cloud.datastore.client.Client.query

google.cloud.datastore.client.Client.reserve_ids

reserve_ids(complete_key, num_ids, retry=None, timeout=None)

google.cloud.datastore.client.Client.reserve_ids_multi

reserve_ids_multi(complete_keys, retry=None, timeout=None)

google.cloud.datastore.client.Client.reserve_ids_sequential

reserve_ids_sequential(complete_key, num_ids, retry=None, timeout=None)

google.cloud.datastore.client.Client.transaction

google.cloud.datastore.entity.Entity.__eq__

google.cloud.datastore.entity.Entity.__ne__

google.cloud.datastore.helpers.GeoPoint.__eq__

google.cloud.datastore.helpers.GeoPoint.__ne__

google.cloud.datastore.helpers.GeoPoint.to_protobuf

google.cloud.datastore.key.Key.__eq__

google.cloud.datastore.key.Key.__hash__

google.cloud.datastore.key.Key.__ne__

google.cloud.datastore.key.Key.__repr__

google.cloud.datastore.key.Key.completed_key

completed_key(id_or_name)

google.cloud.datastore.key.Key.from_legacy_urlsafe

from_legacy_urlsafe(urlsafe)

google.cloud.datastore.key.Key.to_legacy_urlsafe

to_legacy_urlsafe(location_prefix=None)

google.cloud.datastore.key.Key.to_protobuf

google.cloud.datastore.query.BaseCompositeFilter.build_pb

build_pb(container_pb=None)

google.cloud.datastore.query.BaseFilter.build_pb

build_pb(container_pb=None)

google.cloud.datastore.query.PropertyFilter.build_pb

build_pb(container_pb=None)

google.cloud.datastore.query.Query.add_filter

add_filter(property_name=None, operator=None, value=None, *, filter=None)

google.cloud.datastore.query.Query.fetch

fetch(
    limit=None,
    offset=0,
    start_cursor=None,
    end_cursor=None,
    client=None,
    eventual=False,
    retry=None,
    timeout=None,
    read_time=None,
)

google.cloud.datastore.query.Query.key_filter

key_filter(key, operator="=")

google.cloud.datastore.query.Query.keys_only

google.cloud.datastore.transaction.Transaction.begin

begin(retry=None, timeout=None)

google.cloud.datastore.transaction.Transaction.commit

commit(retry=None, timeout=None)

google.cloud.datastore.transaction.Transaction.current

google.cloud.datastore.transaction.Transaction.delete

google.cloud.datastore.transaction.Transaction.put

google.cloud.datastore.transaction.Transaction.rollback

rollback(retry=None, timeout=None)

google.cloud.datastore_admin_v1.services.datastore_admin.client.DatastoreAdminClient

DatastoreAdminClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.datastore_admin_v1.services.datastore_admin.transports.base.DatastoreAdminTransport, typing.Callable[[...], google.cloud.datastore_admin_v1.services.datastore_admin.transports.base.DatastoreAdminTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = 

google.cloud.datastore_admin_v1.services.datastore_admin.client.DatastoreAdminClient.__exit__

__exit__(type, value, traceback)

google.cloud.datastore_admin_v1.services.datastore_admin.client.DatastoreAdminClient.cancel_operation

cancel_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.CancelOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

google.cloud.datastore_admin_v1.services.datastore_admin.client.DatastoreAdminClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

google.cloud.datastore_admin_v1.services.datastore_admin.client.DatastoreAdminClient.common_folder_path

common_folder_path(folder: str) -> str

google.cloud.datastore_admin_v1.services.datastore_admin.client.DatastoreAdminClient.common_location_path

common_location_path(project: str, location: str) -> str

google.cloud.datastore_admin_v1.services.datastore_admin.client.DatastoreAdminClient.common_organization_path

common_organization_path(organization: str) -> str

google.cloud.datastore_admin_v1.services.datastore_admin.client.DatastoreAdminClient.common_project_path

common_project_path(project: str) -> str

google.cloud.datastore_admin_v1.services.datastore_admin.client.DatastoreAdminClient.create_index

create_index(
    request: typing.Optional[
        typing.Union[
            google.cloud.datastore_admin_v1.types.datastore_admin.CreateIndexRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

google.cloud.datastore_admin_v1.services.datastore_admin.client.DatastoreAdminClient.delete_index

delete_index(
    request: typing.Optional[
        typing.Union[
            google.cloud.datastore_admin_v1.types.datastore_admin.DeleteIndexRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

google.cloud.datastore_admin_v1.services.datastore_admin.client.DatastoreAdminClient.delete_operation

delete_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.DeleteOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

google.cloud.datastore_admin_v1.services.datastore_admin.client.DatastoreAdminClient.export_entities

export_entities(
    request: typing.Optional[
        typing.Union[
            google.cloud.datastore_admin_v1.types.datastore_admin.ExportEntitiesRequest,
            dict,
        ]
    ] = None,
    *,
    project_id: typing.Optional[str] = None,
    labels: typing.Optional[typing.MutableMapping[str, str]] = None,
    entity_filter: typing.Optional[
        google.cloud.datastore_admin_v1.types.datastore_admin.EntityFilter
    ] = None,
    output_url_prefix: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

google.cloud.datastore_admin_v1.services.datastore_admin.client.DatastoreAdminClient.from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

google.cloud.datastore_admin_v1.services.datastore_admin.client.DatastoreAdminClient.from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

google.cloud.datastore_admin_v1.services.datastore_admin.client.DatastoreAdminClient.from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

google.cloud.datastore_admin_v1.services.datastore_admin.client.DatastoreAdminClient.get_index

get_index(
    request: typing.Optional[
        typing.Union[
            google.cloud.datastore_admin_v1.types.datastore_admin.GetIndexRequest, dict
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.datastore_admin_v1.types.index.Index

google.cloud.datastore_admin_v1.services.datastore_admin.client.DatastoreAdminClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

google.cloud.datastore_admin_v1.services.datastore_admin.client.DatastoreAdminClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.Operation

google.cloud.datastore_admin_v1.services.datastore_admin.client.DatastoreAdminClient.import_entities

import_entities(
    request: typing.Optional[
        typing.Union[
            google.cloud.datastore_admin_v1.types.datastore_admin.ImportEntitiesRequest,
            dict,
        ]
    ] = None,
    *,
    project_id: typing.Optional[str] = None,
    labels: typing.Optional[typing.MutableMapping[str, str]] = None,
    input_url: typing.Optional[str] = None,
    entity_filter: typing.Optional[
        google.cloud.datastore_admin_v1.types.datastore_admin.EntityFilter
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

google.cloud.datastore_admin_v1.services.datastore_admin.client.DatastoreAdminClient.list_indexes

list_indexes(
    request: typing.Optional[
        typing.Union[
            google.cloud.datastore_admin_v1.types.datastore_admin.ListIndexesRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.datastore_admin_v1.services.datastore_admin.pagers.ListIndexesPager

google.cloud.datastore_admin_v1.services.datastore_admin.client.DatastoreAdminClient.list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

google.cloud.datastore_admin_v1.services.datastore_admin.client.DatastoreAdminClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

google.cloud.datastore_admin_v1.services.datastore_admin.client.DatastoreAdminClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

google.cloud.datastore_admin_v1.services.datastore_admin.client.DatastoreAdminClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

google.cloud.datastore_admin_v1.services.datastore_admin.client.DatastoreAdminClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

google.cloud.datastore_admin_v1.services.datastore_admin.client.DatastoreAdminClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]