Google - API Cloud Datastore

Google / Cloud Datastore

Cloud Datastore

Accesses the schemaless NoSQL database to provide fully managed, robust, scalable storage for your application.

License: Creative Commons Attribution 3.0

Resources

projects

DELETE

/v1/projects/{projectId}/indexes/{indexId}

Deletes an existing index. An index can only be deleted if it is in a READY or ERROR state. On successful execution of the request, the index will be in a DELETING state. And on completion of the returned google.longrunning.Operation, the index will be removed.

During index deletion, the process could result in an error, in which case the index will move to the ERROR state. The process can be recovered by fixing the data that caused the error, followed by calling delete again.

Request

Path

Name	Data Type	Description
`indexId`	string	The resource ID of the index to delete.
`projectId`	string	Project ID against which to make the request.

Responses

200Successful response

Body

Name Data Type Description

GoogleLongrunningOperation


                        GoogleLongrunningOperation

object

This resource represents a long-running operation that is the result of a network API call.

Properties


                        response

object

The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.


                        name

string

The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.


                        metadata

object

Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.


                        error

Status

The error result of the operation in case of failure or cancellation.


                        Status

object

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details.

You can find out more about this error model and how to work with it in the API Design Guide.

Properties

`message`	string	A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
`details`	array [object]	A list of messages that carry the error details. There is a common set of message types for APIs to use.
`code`	integer	The status code, which should be an enum value of google.rpc.Code.


                        done

boolean

If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.

GET

/v1/projects/{projectId}/indexes/{indexId}

Gets an index.

Request

Path

Name	Data Type	Description
`indexId`	string	The resource ID of the index to get.
`projectId`	string	Project ID against which to make the request.

Responses

200Successful response

Body

Name Data Type Description

GoogleDatastoreAdminV1Index


                        GoogleDatastoreAdminV1Index

object

A minimal index definition.

Properties


                        state

string
Allowed values:
- STATE_UNSPECIFIED
- CREATING
- READY
- DELETING
- ERROR

Output only. The state of the index.


                        properties

array [GoogleDatastoreAdminV1IndexedProperty]

Required. An ordered sequence of property names and their index attributes.


                        GoogleDatastoreAdminV1IndexedProperty

object

A property of an index.

Properties

`name`	string	Required. The property name to index.
`direction`	string Allowed values: - `DIRECTION_UNSPECIFIED` - `ASCENDING` - `DESCENDING`	Required. The indexed property's direction. Must not be DIRECTION_UNSPECIFIED.


                        projectId

string

Output only. Project ID.


                        kind

string

Required. The entity kind to which this index applies.


                        indexId

string

Output only. The resource ID of the index.


                        ancestor

string
Allowed values:
- ANCESTOR_MODE_UNSPECIFIED
- NONE
- ALL_ANCESTORS

Required. The index's ancestor mode. Must not be ANCESTOR_MODE_UNSPECIFIED.

GET

/v1/projects/{projectId}/indexes

Lists the indexes that match the specified filters. Datastore uses an eventually consistent query to fetch the list of indexes and may occasionally return stale results.

Request

Path

Name	Data Type	Description
`projectId`	string	Project ID against which to make the request.

Query

Name	Data Type	Description
`pageToken`	string	The next_page_token value returned from a previous List request, if any.
`pageSize`	integer	The maximum number of items to return. If zero, then all results will be returned.
`filter`	string

Responses

200Successful response

Body

Name Data Type Description

GoogleDatastoreAdminV1ListIndexesResponse


                        GoogleDatastoreAdminV1ListIndexesResponse

object

The response for google.datastore.admin.v1.DatastoreAdmin.ListIndexes.

Properties


                        nextPageToken

string

The standard List next-page token.


                        indexes

array [GoogleDatastoreAdminV1Index]

The indexes.


                        GoogleDatastoreAdminV1Index

object

A minimal index definition.

Properties

`state`	string Allowed values: - `STATE_UNSPECIFIED` - `CREATING` - `READY` - `DELETING` - `ERROR`	Output only. The state of the index.
`properties`	array [GoogleDatastoreAdminV1IndexedProperty]	Required. An ordered sequence of property names and their index attributes.
`projectId`	string	Output only. Project ID.
`kind`	string	Required. The entity kind to which this index applies.
`indexId`	string	Output only. The resource ID of the index.
`ancestor`	string Allowed values: - `ANCESTOR_MODE_UNSPECIFIED` - `NONE` - `ALL_ANCESTORS`	Required. The index's ancestor mode. Must not be ANCESTOR_MODE_UNSPECIFIED.

POST

/v1/projects/{projectId}/indexes

Creates the specified index. A newly created index's initial state is CREATING. On completion of the returned google.longrunning.Operation, the state will be READY. If the index already exists, the call will return an ALREADY_EXISTS status.

During index creation, the process could result in an error, in which case the index will move to the ERROR state. The process can be recovered by fixing the data that caused the error, removing the index with delete, then re-creating the index with create.

Indexes with a single property cannot be created.

Request

Path

Name	Data Type	Description
`projectId`	string	Project ID against which to make the request.

Body

Name Data Type Description

GoogleDatastoreAdminV1Index


                        GoogleDatastoreAdminV1Index

object

A minimal index definition.

Properties


                        state

string
Allowed values:
- STATE_UNSPECIFIED
- CREATING
- READY
- DELETING
- ERROR

Output only. The state of the index.


                        properties

array [GoogleDatastoreAdminV1IndexedProperty]

Required. An ordered sequence of property names and their index attributes.


                        GoogleDatastoreAdminV1IndexedProperty

object

A property of an index.

Properties

`name`	string	Required. The property name to index.
`direction`	string Allowed values: - `DIRECTION_UNSPECIFIED` - `ASCENDING` - `DESCENDING`	Required. The indexed property's direction. Must not be DIRECTION_UNSPECIFIED.


                        projectId

string

Output only. Project ID.


                        kind

string

Required. The entity kind to which this index applies.


                        indexId

string

Output only. The resource ID of the index.


                        ancestor

string
Allowed values:
- ANCESTOR_MODE_UNSPECIFIED
- NONE
- ALL_ANCESTORS

Required. The index's ancestor mode. Must not be ANCESTOR_MODE_UNSPECIFIED.

Responses

200Successful response

Body

Name Data Type Description

GoogleLongrunningOperation


                        GoogleLongrunningOperation

object

This resource represents a long-running operation that is the result of a network API call.

Properties


                        response

object


                        name

string


                        metadata

object


                        error

Status

The error result of the operation in case of failure or cancellation.


                        Status

object

You can find out more about this error model and how to work with it in the API Design Guide.

Properties

`message`	string	A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
`details`	array [object]	A list of messages that carry the error details. There is a common set of message types for APIs to use.
`code`	integer	The status code, which should be an enum value of google.rpc.Code.


                        done

boolean

If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.

POST

/v1/projects/{projectId}:allocateIds

Allocates IDs for the given keys, which is useful for referencing an entity before it is inserted.

Request

Path

Name	Data Type	Description
`projectId`	string	Required. The ID of the project against which to make the request.

Body

Name Data Type Description

AllocateIdsRequest


                        AllocateIdsRequest

object

The request for Datastore.AllocateIds.

Properties


                        keys

array [Key]

Required. A list of keys with incomplete key paths for which to allocate IDs. No key may be reserved/read-only.

Key

object

A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts.

Properties

`path`	array [PathElement]	The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: all of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements.
`partitionId`	PartitionId	Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.

Responses

200Successful response

Body

Name Data Type Description

AllocateIdsResponse


                        AllocateIdsResponse

object

The response for Datastore.AllocateIds.

Properties


                        keys

array [Key]

The keys specified in the request (in the same order), each with its key path completed with a newly allocated ID.

Key

object

Properties

`path`	array [PathElement]	The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: all of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements.
`partitionId`	PartitionId	Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.

POST

/v1/projects/{projectId}:beginTransaction

Begins a new transaction.

Request

Path

Name	Data Type	Description
`projectId`	string	Required. The ID of the project against which to make the request.

Body

Name Data Type Description

BeginTransactionRequest


                        BeginTransactionRequest

object

The request for Datastore.BeginTransaction.

Properties


                        transactionOptions

TransactionOptions

Options for a new transaction.


                        TransactionOptions

object

Options for beginning a new transaction.

Transactions can be created explicitly with calls to Datastore.BeginTransaction or implicitly by setting ReadOptions.new_transaction in read requests.

Properties

`readWrite`	ReadWrite	The transaction should allow both reads and writes.
`readOnly`	ReadOnly	The transaction should only allow reads.

Responses

200Successful response

Body

Name Data Type Description

BeginTransactionResponse


                        BeginTransactionResponse

object

The response for Datastore.BeginTransaction.

Properties


                        transaction

byte

The transaction identifier (always present).

POST

/v1/projects/{projectId}:commit

Commits a transaction, optionally creating, deleting or modifying some entities.

Request

Path

Name	Data Type	Description
`projectId`	string	Required. The ID of the project against which to make the request.

Body

Name Data Type Description

CommitRequest


                        CommitRequest

object

The request for Datastore.Commit.

Properties


                        transaction

byte

The identifier of the transaction associated with the commit. A transaction identifier is returned by a call to Datastore.BeginTransaction.


                        mutations

array [Mutation]

The mutations to perform.

When mode is TRANSACTIONAL, mutations affecting a single entity are applied in order. The following sequences of mutations affecting a single entity are not permitted in a single Commit request:

insert followed by insert
update followed by insert
upsert followed by insert
delete followed by update

When mode is NON_TRANSACTIONAL, no two mutations may affect a single entity.


                        Mutation

object

A mutation to apply to an entity.

Properties

`upsert`	Entity	The entity to upsert. The entity may or may not already exist. The entity key's final path element may be incomplete.
`update`	Entity	The entity to update. The entity must already exist. Must have a complete key path.
`insert`	Entity	The entity to insert. The entity must not already exist. The entity key's final path element may be incomplete.
`delete`	Key	The key of the entity to delete. The entity may or may not already exist. Must have a complete key path and must not be reserved/read-only.
`baseVersion`	string	The version of the entity that this mutation is being applied to. If this does not match the current version on the server, the mutation conflicts.


                        mode

string
Allowed values:
- MODE_UNSPECIFIED
- TRANSACTIONAL
- NON_TRANSACTIONAL

The type of commit to perform. Defaults to TRANSACTIONAL.

Responses

200Successful response

Body

Name Data Type Description

CommitResponse


                        CommitResponse

object

The response for Datastore.Commit.

Properties


                        mutationResults

array [MutationResult]

The result of performing the mutations. The i-th mutation result corresponds to the i-th mutation in the request.


                        MutationResult

object

The result of applying a mutation.

Properties

`version`	string	The version of the entity on the server after processing the mutation. If the mutation doesn't change anything on the server, then the version will be the version of the current entity or, if no entity is present, a version that is strictly greater than the version of any previous entity and less than the version of any possible future entity.
`key`	Key	The automatically allocated key. Set only when the mutation allocated a key.
`conflictDetected`	boolean	Whether a conflict was detected for this mutation. Always false when a conflict detection strategy field is not set in the mutation.


                        indexUpdates

integer

The number of index entries updated during the commit, or zero if none were updated.

POST

/v1/projects/{projectId}:export

Exports a copy of all or a subset of entities from Google Cloud Datastore to another storage system, such as Google Cloud Storage. Recent updates to entities may not be reflected in the export. The export occurs in the background and its progress can be monitored and managed via the Operation resource that is created. The output of an export may only be used once the associated operation is done. If an export operation is cancelled before completion it may leave partial data behind in Google Cloud Storage.

Request

Path

Name	Data Type	Description
`projectId`	string	Required. Project ID against which to make the request.

Body

Name Data Type Description

GoogleDatastoreAdminV1ExportEntitiesRequest


                        GoogleDatastoreAdminV1ExportEntitiesRequest

object

The request for google.datastore.admin.v1.DatastoreAdmin.ExportEntities.

Properties


                        outputUrlPrefix

string

Required. Location for the export metadata and data files.

The full resource URL of the external storage location. Currently, only Google Cloud Storage is supported. So output_url_prefix should be of the form: gs://BUCKET_NAME[/NAMESPACE_PATH], where BUCKET_NAME is the name of the Cloud Storage bucket and NAMESPACE_PATH is an optional Cloud Storage namespace path (this is not a Cloud Datastore namespace). For more information about Cloud Storage namespace paths, see Object name considerations.

The resulting files will be nested deeper than the specified URL prefix. The final output URL will be provided in the google.datastore.admin.v1.ExportEntitiesResponse.output_url field. That value should be used for subsequent ImportEntities operations.

By nesting the data files deeper, the same Cloud Storage bucket can be used in multiple ExportEntities operations without conflict.


                        labels

object

Client-assigned labels.


                        entityFilter

GoogleDatastoreAdminV1EntityFilter

Description of what data from the project is included in the export.


                        GoogleDatastoreAdminV1EntityFilter

object

Identifies a subset of entities in a project. This is specified as combinations of kinds and namespaces (either or both of which may be all, as described in the following examples). Example usage:

Entire project: kinds=[], namespace_ids=[]

Kinds Foo and Bar in all namespaces: kinds=['Foo', 'Bar'], namespace_ids=[]

Kinds Foo and Bar only in the default namespace: kinds=['Foo', 'Bar'], namespace_ids=['']

Kinds Foo and Bar in both the default and Baz namespaces: kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz']

The entire Baz namespace: kinds=[], namespace_ids=['Baz']

Properties

`namespaceIds`	array [string]	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 want to include them. Each namespace in this list must be unique.
`kinds`	array [string]	If empty, then this represents all kinds.

Responses

200Successful response

Body

Name Data Type Description

GoogleLongrunningOperation


                        GoogleLongrunningOperation

object

This resource represents a long-running operation that is the result of a network API call.

Properties


                        response

object


                        name

string


                        metadata

object


                        error

Status

The error result of the operation in case of failure or cancellation.


                        Status

object

You can find out more about this error model and how to work with it in the API Design Guide.

Properties

`message`	string	A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
`details`	array [object]	A list of messages that carry the error details. There is a common set of message types for APIs to use.
`code`	integer	The status code, which should be an enum value of google.rpc.Code.


                        done

boolean

If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.

POST

/v1/projects/{projectId}:import

Imports entities into Google Cloud Datastore. Existing entities with the same key are overwritten. The import occurs in the background and its progress can be monitored and managed via the Operation resource that is created. If an ImportEntities operation is cancelled, it is possible that a subset of the data has already been imported to Cloud Datastore.

Request

Path

Name	Data Type	Description
`projectId`	string	Required. Project ID against which to make the request.

Body

Name Data Type Description

GoogleDatastoreAdminV1ImportEntitiesRequest


                        GoogleDatastoreAdminV1ImportEntitiesRequest

object

The request for google.datastore.admin.v1.DatastoreAdmin.ImportEntities.

Properties


                        labels

object

Client-assigned labels.


                        inputUrl

string

Required. The full resource URL of the external storage location. Currently, only Google Cloud Storage is supported. So input_url should be of the form: gs://BUCKET_NAME[/NAMESPACE_PATH]/OVERALL_EXPORT_METADATA_FILE, where BUCKET_NAME is the name of the Cloud Storage bucket, NAMESPACE_PATH is an optional Cloud Storage namespace path (this is not a Cloud Datastore namespace), and OVERALL_EXPORT_METADATA_FILE is the metadata file written by the ExportEntities operation. For more information about Cloud Storage namespace paths, see Object name considerations.

For more information, see google.datastore.admin.v1.ExportEntitiesResponse.output_url.


                        entityFilter

GoogleDatastoreAdminV1EntityFilter

Optionally specify which kinds/namespaces are to be imported. If provided, the list must be a subset of the EntityFilter used in creating the export, otherwise a FAILED_PRECONDITION error will be returned. If no filter is specified then all entities from the export are imported.


                        GoogleDatastoreAdminV1EntityFilter

object

Identifies a subset of entities in a project. This is specified as combinations of kinds and namespaces (either or both of which may be all, as described in the following examples). Example usage:

Entire project: kinds=[], namespace_ids=[]

Kinds Foo and Bar in all namespaces: kinds=['Foo', 'Bar'], namespace_ids=[]

Kinds Foo and Bar only in the default namespace: kinds=['Foo', 'Bar'], namespace_ids=['']

Kinds Foo and Bar in both the default and Baz namespaces: kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz']

The entire Baz namespace: kinds=[], namespace_ids=['Baz']

Properties

`namespaceIds`	array [string]	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 want to include them. Each namespace in this list must be unique.
`kinds`	array [string]	If empty, then this represents all kinds.

Responses

200Successful response

Body

Name Data Type Description

GoogleLongrunningOperation


                        GoogleLongrunningOperation

object

This resource represents a long-running operation that is the result of a network API call.

Properties


                        response

object


                        name

string


                        metadata

object


                        error

Status

The error result of the operation in case of failure or cancellation.


                        Status

object

You can find out more about this error model and how to work with it in the API Design Guide.

Properties

`message`	string	A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
`details`	array [object]	A list of messages that carry the error details. There is a common set of message types for APIs to use.
`code`	integer	The status code, which should be an enum value of google.rpc.Code.


                        done

boolean

If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.

POST

/v1/projects/{projectId}:lookup

Looks up entities by key.

Request

Path

Name	Data Type	Description
`projectId`	string	Required. The ID of the project against which to make the request.

Body

Name Data Type Description

LookupRequest


                        LookupRequest

object

The request for Datastore.Lookup.

Properties


                        readOptions

ReadOptions

The options for this lookup request.


                        ReadOptions

object

The options shared by read requests.

Properties

`transaction`	byte	The identifier of the transaction in which to read. A transaction identifier is returned by a call to Datastore.BeginTransaction.
`readConsistency`	string Allowed values: - `READ_CONSISTENCY_UNSPECIFIED` - `STRONG` - `EVENTUAL`	The non-transactional read consistency to use. Cannot be set to `STRONG` for global queries.


                        keys

array [Key]

Required. Keys of entities to look up.

Key

object

Properties

`path`	array [PathElement]	The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: all of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements.
`partitionId`	PartitionId	Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.

Responses

200Successful response

Body

Name Data Type Description

LookupResponse


                        LookupResponse

object

The response for Datastore.Lookup.

Properties


                        missing

array [EntityResult]

Entities not found as ResultType.KEY_ONLY entities. The order of results in this field is undefined and has no relation to the order of the keys in the input.


                        EntityResult

object

The result of fetching an entity from Datastore.

Properties

`version`	string	The version of the entity, a strictly positive number that monotonically increases with changes to the entity. This field is set for `FULL` entity results. For missing entities in `LookupResponse`, this is the version of the snapshot that was used to look up the entity, and it is always set except for eventually consistent reads.
`entity`	Entity	The resulting entity.
`cursor`	byte	A cursor that points to the position after the result entity. Set only when the `EntityResult` is part of a `QueryResultBatch` message.


                        found

array [EntityResult]

Entities found as ResultType.FULL entities. The order of results in this field is undefined and has no relation to the order of the keys in the input.


                        EntityResult

object

The result of fetching an entity from Datastore.

Properties

`version`	string	The version of the entity, a strictly positive number that monotonically increases with changes to the entity. This field is set for `FULL` entity results. For missing entities in `LookupResponse`, this is the version of the snapshot that was used to look up the entity, and it is always set except for eventually consistent reads.
`entity`	Entity	The resulting entity.
`cursor`	byte	A cursor that points to the position after the result entity. Set only when the `EntityResult` is part of a `QueryResultBatch` message.


                        deferred

array [Key]

A list of keys that were not looked up due to resource constraints. The order of results in this field is undefined and has no relation to the order of the keys in the input.

Key

object

Properties

`path`	array [PathElement]	The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: all of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements.
`partitionId`	PartitionId	Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.

POST

/v1/projects/{projectId}:reserveIds

Prevents the supplied keys' IDs from being auto-allocated by Cloud Datastore.

Request

Path

Name	Data Type	Description
`projectId`	string	Required. The ID of the project against which to make the request.

Body

Name Data Type Description

ReserveIdsRequest


                        ReserveIdsRequest

object

The request for Datastore.ReserveIds.

Properties


                        keys

array [Key]

Required. A list of keys with complete key paths whose numeric IDs should not be auto-allocated.

Key

object

Properties

`path`	array [PathElement]	The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: all of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements.
`partitionId`	PartitionId	Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.


                        databaseId

string

If not empty, the ID of the database against which to make the request.

Responses

200Successful response

Body

Name Data Type Description

ReserveIdsResponse


                        ReserveIdsResponse

object

The response for Datastore.ReserveIds.

POST

/v1/projects/{projectId}:rollback

Rolls back a transaction.

Request

Path

Name	Data Type	Description
`projectId`	string	Required. The ID of the project against which to make the request.

Body

Name Data Type Description

RollbackRequest


                        RollbackRequest

object

The request for Datastore.Rollback.

Properties


                        transaction

byte

Required. The transaction identifier, returned by a call to Datastore.BeginTransaction.

Responses

200Successful response

Body

Name Data Type Description

RollbackResponse


                        RollbackResponse

object

The response for Datastore.Rollback. (an empty message).

POST

/v1/projects/{projectId}:runQuery

Queries for entities.

Request

Path

Name	Data Type	Description
`projectId`	string	Required. The ID of the project against which to make the request.

Body

Name Data Type Description

RunQueryRequest


                        RunQueryRequest

object

The request for Datastore.RunQuery.

Properties


                        readOptions

ReadOptions

The options for this query.


                        ReadOptions

object

The options shared by read requests.

Properties

`transaction`	byte	The identifier of the transaction in which to read. A transaction identifier is returned by a call to Datastore.BeginTransaction.
`readConsistency`	string Allowed values: - `READ_CONSISTENCY_UNSPECIFIED` - `STRONG` - `EVENTUAL`	The non-transactional read consistency to use. Cannot be set to `STRONG` for global queries.


                        query

Query

The query to run.


                        Query

object

A query for entities.

Properties

`startCursor`	byte	A starting point for the query results. Query cursors are returned in query result batches and can only be used to continue the same query.
`projection`	array [Projection]	The projection to return. Defaults to returning all properties.
`order`	array [PropertyOrder]	The order to apply to the query results (if empty, order is unspecified).
`offset`	integer	The number of results to skip. Applies before limit, but after all other constraints. Optional. Must be >= 0 if specified.
`limit`	integer	The maximum number of results to return. Applies after all other constraints. Optional. Unspecified is interpreted as no limit. Must be >= 0 if specified.
`kind`	array [KindExpression]	The kinds to query (if empty, returns entities of all kinds). Currently at most 1 kind may be specified.
`filter`	Filter	The filter to apply.
`endCursor`	byte	An ending point for the query results. Query cursors are returned in query result batches and can only be used to limit the same query.
`distinctOn`	array [PropertyReference]	The properties to make distinct. The query results will contain the first result for each distinct combination of values for the given properties (if empty, all results are returned).


                        partitionId

PartitionId

Entities are partitioned into subsets, identified by a partition ID. Queries are scoped to a single partition. This partition ID is normalized with the standard default context partition ID.


                        PartitionId

object

A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty.

A partition ID contains several dimensions: project ID and namespace ID.

Partition dimensions:

May be "".
Must be valid UTF-8 bytes.
Must have values that match regex [A-Za-z\d\.\-_]{1,100} If the value of any dimension matches regex __.*__, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts.

Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state.

Properties

`projectId`	string	The ID of the project to which the entities belong.
`namespaceId`	string	If not empty, the ID of the namespace to which the entities belong.


                        gqlQuery

GqlQuery

The GQL query to run.


                        GqlQuery

object

A GQL query.

Properties

`queryString`	string	A string of the format described here.
`positionalBindings`	array [GqlQueryParameter]	Numbered binding site @1 references the first numbered parameter, effectively using 1-based indexing, rather than the usual 0. For each binding site numbered i in `query_string`, there must be an i-th numbered parameter. The inverse must also be true.
`namedBindings`	object	For each non-reserved named binding site in the query string, there must be a named parameter with that name, but not necessarily the inverse. Key must match regex `A-Za-z_$`, must not match regex `__.__`, and must not be `""`.
`allowLiterals`	boolean	When false, the query string must not contain any literals and instead must bind all values. For example, `SELECT * FROM Kind WHERE a = 'string literal'` is not allowed, while `SELECT * FROM Kind WHERE a = @value` is.

Responses

200Successful response

Body

Name Data Type Description

RunQueryResponse


                        RunQueryResponse

object

The response for Datastore.RunQuery.

Properties


                        query

Query

The parsed form of the GqlQuery from the request, if it was set.


                        Query

object

A query for entities.

Properties

`startCursor`	byte	A starting point for the query results. Query cursors are returned in query result batches and can only be used to continue the same query.
`projection`	array [Projection]	The projection to return. Defaults to returning all properties.
`order`	array [PropertyOrder]	The order to apply to the query results (if empty, order is unspecified).
`offset`	integer	The number of results to skip. Applies before limit, but after all other constraints. Optional. Must be >= 0 if specified.
`limit`	integer	The maximum number of results to return. Applies after all other constraints. Optional. Unspecified is interpreted as no limit. Must be >= 0 if specified.
`kind`	array [KindExpression]	The kinds to query (if empty, returns entities of all kinds). Currently at most 1 kind may be specified.
`filter`	Filter	The filter to apply.
`endCursor`	byte	An ending point for the query results. Query cursors are returned in query result batches and can only be used to limit the same query.
`distinctOn`	array [PropertyReference]	The properties to make distinct. The query results will contain the first result for each distinct combination of values for the given properties (if empty, all results are returned).


                        batch

QueryResultBatch

A batch of query results (always present).


                        QueryResultBatch

object

A batch of results produced by a query.

Properties

`snapshotVersion`	string	The version number of the snapshot this batch was returned from. This applies to the range of results from the query's `start_cursor` (or the beginning of the query if no cursor was given) to this batch's `end_cursor` (not the query's `end_cursor`). In a single transaction, subsequent query result batches for the same query can have a greater snapshot version number. Each batch's snapshot version is valid for all preceding batches. The value will be zero for eventually consistent queries.
`skippedResults`	integer	The number of results skipped, typically because of an offset.
`skippedCursor`	byte	A cursor that points to the position after the last skipped result. Will be set when `skipped_results` != 0.
`moreResults`	string Allowed values: - `MORE_RESULTS_TYPE_UNSPECIFIED` - `NOT_FINISHED` - `MORE_RESULTS_AFTER_LIMIT` - `MORE_RESULTS_AFTER_CURSOR` - `NO_MORE_RESULTS`	The state of the query after the current batch.
`entityResults`	array [EntityResult]	The results for this batch.
`entityResultType`	string Allowed values: - `RESULT_TYPE_UNSPECIFIED` - `FULL` - `PROJECTION` - `KEY_ONLY`	The result type for every entity in `entity_results`.
`endCursor`	byte	A cursor that points to the position after the last result in the batch.

GET

/v1/{name}/operations

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.

Request

Path

Name	Data Type	Description
`name`	string	The name of the operation's parent resource.

Query

Name	Data Type	Description
`pageToken`	string	The standard list page token.
`pageSize`	integer	The standard list page size.
`filter`	string	The standard list filter.

Responses

200Successful response

Body

Name Data Type Description

GoogleLongrunningListOperationsResponse


                        GoogleLongrunningListOperationsResponse

object

The response message for Operations.ListOperations.

Properties


                        operations

array [GoogleLongrunningOperation]

A list of operations that matches the specified filter in the request.


                        GoogleLongrunningOperation

object

This resource represents a long-running operation that is the result of a network API call.

Properties

`response`	object	The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
`name`	string	The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
`metadata`	object	Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
`error`	Status	The error result of the operation in case of failure or cancellation.
`done`	boolean	If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.


                        nextPageToken

string

The standard List next-page token.

POST

/v1/{name}:cancel

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Request

Path

Name	Data Type	Description
`name`	string	The name of the operation resource to be cancelled.

Responses

200Successful response

Body

Name Data Type Description

Empty


                        Empty

object

A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:

service Foo {
  rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
}

The JSON representation for Empty is empty JSON object {}.

DELETE

/v1/{name}

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Request

Path

Name	Data Type	Description
`name`	string	The name of the operation resource to be deleted.

Responses

200Successful response

Body

Name Data Type Description

Empty


                        Empty

object

service Foo {
  rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
}

The JSON representation for Empty is empty JSON object {}.

GET

/v1/{name}

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Request

Path

Name	Data Type	Description
`name`	string	The name of the operation resource.

Responses

200Successful response

Body

Name Data Type Description

GoogleLongrunningOperation


                        GoogleLongrunningOperation

object

This resource represents a long-running operation that is the result of a network API call.

Properties


                        response

object


                        name

string


                        metadata

object


                        error

Status

The error result of the operation in case of failure or cancellation.


                        Status

object

You can find out more about this error model and how to work with it in the API Design Guide.

Properties

`message`	string	A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
`details`	array [object]	A list of messages that carry the error details. There is a common set of message types for APIs to use.
`code`	integer	The status code, which should be an enum value of google.rpc.Code.


                        done

boolean

If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.

Models

AllocateIdsRequest

The request for Datastore.AllocateIds.

Properties

Name Data Type Description


                        keys

array [Key]

Required. A list of keys with incomplete key paths for which to allocate IDs. No key may be reserved/read-only.

Key

object

Properties


                        path

array [PathElement]

The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors.

An entity path is always fully complete: all of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of Mutation.insert may have no identifier.

A path can never be empty, and a path can have at most 100 elements.


                        PathElement

object

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.

Properties

`name`	string	The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
`kind`	string	The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
`id`	string	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.


                        partitionId

PartitionId

Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.


                        PartitionId

object

A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty.

A partition ID contains several dimensions: project ID and namespace ID.

Partition dimensions:

May be "".
Must be valid UTF-8 bytes.
Must have values that match regex [A-Za-z\d\.\-_]{1,100} If the value of any dimension matches regex __.*__, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts.

Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state.

Properties

`projectId`	string	The ID of the project to which the entities belong.
`namespaceId`	string	If not empty, the ID of the namespace to which the entities belong.

AllocateIdsResponse

The response for Datastore.AllocateIds.

Properties

Name Data Type Description


                        keys

array [Key]

The keys specified in the request (in the same order), each with its key path completed with a newly allocated ID.

Key

object

Properties


                        path

array [PathElement]

A path can never be empty, and a path can have at most 100 elements.


                        PathElement

object

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.

Properties

`name`	string	The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
`kind`	string	The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
`id`	string	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.


                        partitionId

PartitionId

Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.


                        PartitionId

object

A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty.

A partition ID contains several dimensions: project ID and namespace ID.

Partition dimensions:

May be "".
Must be valid UTF-8 bytes.
Must have values that match regex [A-Za-z\d\.\-_]{1,100} If the value of any dimension matches regex __.*__, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts.

Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state.

Properties

`projectId`	string	The ID of the project to which the entities belong.
`namespaceId`	string	If not empty, the ID of the namespace to which the entities belong.

ArrayValue

An array value.

Properties

Name Data Type Description


                        values

array [Value]

Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'.


                        Value

object

A message that can hold any of the supported value types and associated metadata.

Properties


                        timestampValue

string

A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down.


                        stringValue

string

A UTF-8 encoded string value. When exclude_from_indexes is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at least 1,000,000 bytes.


                        nullValue

string
Allowed values:
- NULL_VALUE

A null value.


                        meaning

integer

The meaning field should only be populated for backwards compatibility.


                        keyValue

Key

A key value.

Key

object

Properties


                        path

array [PathElement]

A path can never be empty, and a path can have at most 100 elements.


                        PathElement

object

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.

Properties

`name`	string	The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
`kind`	string	The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
`id`	string	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.


                        partitionId

PartitionId

Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.


                        PartitionId

object

A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty.

A partition ID contains several dimensions: project ID and namespace ID.

Partition dimensions:

May be "".
Must be valid UTF-8 bytes.
Must have values that match regex [A-Za-z\d\.\-_]{1,100} If the value of any dimension matches regex __.*__, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts.

Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state.

Properties

`projectId`	string	The ID of the project to which the entities belong.
`namespaceId`	string	If not empty, the ID of the namespace to which the entities belong.


                        integerValue

string

An integer value.


                        geoPointValue

LatLng

A geo point value representing a point on the surface of Earth.


                        LatLng

object

An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges.

Properties

`longitude`	double	The longitude in degrees. It must be in the range [-180.0, +180.0].
`latitude`	double	The latitude in degrees. It must be in the range [-90.0, +90.0].


                        excludeFromIndexes

boolean

If the value should be excluded from all indexes including those defined explicitly.


                        entityValue

Entity

An entity value.

May have no key.
May have a key with an incomplete key path.
May have a reserved/read-only key.


                        Entity

object

A Datastore data object.

An entity is limited to 1 megabyte when stored. That roughly corresponds to a limit of 1 megabyte for the serialized form of this message.

Properties


                        properties

object

The entity's properties. The map's keys are property names. A property name matching regex __.*__ is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be "".

key

Key

The entity's key.

An entity must have a key, unless otherwise documented (for example, an entity in Value.entity_value may have no key). An entity's kind is its key path's last element's kind, or null if it has no key.

Key

object

Properties

`path`	array [PathElement]	The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: all of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements.
`partitionId`	PartitionId	Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.


                        doubleValue

double

A double value.


                        booleanValue

boolean

A boolean value.


                        blobValue

byte

A blob value. May have at most 1,000,000 bytes. When exclude_from_indexes is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded.


                        arrayValue

ArrayValue

An array value. Cannot contain another array value. A Value instance that sets field array_value must not set fields meaning or exclude_from_indexes.


                        ArrayValue

object

An array value.

Properties


                        values

array [Value]

Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'.


                        Value

object

A message that can hold any of the supported value types and associated metadata.

Properties

`timestampValue`	string	A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down.
`stringValue`	string	A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at least 1,000,000 bytes.
`nullValue`	string Allowed values: - `NULL_VALUE`	A null value.
`meaning`	integer	The `meaning` field should only be populated for backwards compatibility.
`keyValue`	Key	A key value.
`integerValue`	string	An integer value.
`geoPointValue`	LatLng	A geo point value representing a point on the surface of Earth.
`excludeFromIndexes`	boolean	If the value should be excluded from all indexes including those defined explicitly.
`entityValue`	Entity	An entity value. May have no key. May have a key with an incomplete key path. May have a reserved/read-only key.
`doubleValue`	double	A double value.
`booleanValue`	boolean	A boolean value.
`blobValue`	byte	A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded.
`arrayValue`	ArrayValue	An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`.

BeginTransactionRequest

The request for Datastore.BeginTransaction.

Properties

Name Data Type Description


                        transactionOptions

TransactionOptions

Options for a new transaction.


                        TransactionOptions

object

Options for beginning a new transaction.

Transactions can be created explicitly with calls to Datastore.BeginTransaction or implicitly by setting ReadOptions.new_transaction in read requests.

Properties


                        readWrite

ReadWrite

The transaction should allow both reads and writes.


                        ReadWrite

object

Options specific to read / write transactions.

Properties


                        previousTransaction

byte

The transaction identifier of the transaction being retried.


                        readOnly

ReadOnly

The transaction should only allow reads.


                        ReadOnly

object

Options specific to read-only transactions.

BeginTransactionResponse

CommitRequest

The request for Datastore.Commit.

Properties

Name Data Type Description


                        transaction

byte

The identifier of the transaction associated with the commit. A transaction identifier is returned by a call to Datastore.BeginTransaction.


                        mutations

array [Mutation]

The mutations to perform.

When mode is TRANSACTIONAL, mutations affecting a single entity are applied in order. The following sequences of mutations affecting a single entity are not permitted in a single Commit request:

insert followed by insert
update followed by insert
upsert followed by insert
delete followed by update

When mode is NON_TRANSACTIONAL, no two mutations may affect a single entity.


                        Mutation

object

A mutation to apply to an entity.

Properties


                        upsert

Entity

The entity to upsert. The entity may or may not already exist. The entity key's final path element may be incomplete.


                        Entity

object

A Datastore data object.

An entity is limited to 1 megabyte when stored. That roughly corresponds to a limit of 1 megabyte for the serialized form of this message.

Properties


                        properties

object

key

Key

The entity's key.

Key

object

Properties

`path`	array [PathElement]	The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: all of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements.
`partitionId`	PartitionId	Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.


                        update

Entity

The entity to update. The entity must already exist. Must have a complete key path.


                        Entity

object

A Datastore data object.

An entity is limited to 1 megabyte when stored. That roughly corresponds to a limit of 1 megabyte for the serialized form of this message.

Properties


                        properties

object

key

Key

The entity's key.

Key

object

Properties

`path`	array [PathElement]	The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: all of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements.
`partitionId`	PartitionId	Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.


                        insert

Entity

The entity to insert. The entity must not already exist. The entity key's final path element may be incomplete.


                        Entity

object

A Datastore data object.

An entity is limited to 1 megabyte when stored. That roughly corresponds to a limit of 1 megabyte for the serialized form of this message.

Properties


                        properties

object

key

Key

The entity's key.

Key

object

Properties

`path`	array [PathElement]	The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: all of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements.
`partitionId`	PartitionId	Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.


                        delete

Key

The key of the entity to delete. The entity may or may not already exist. Must have a complete key path and must not be reserved/read-only.

Key

object

Properties


                        path

array [PathElement]

A path can never be empty, and a path can have at most 100 elements.


                        PathElement

object

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.

Properties

`name`	string	The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
`kind`	string	The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
`id`	string	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.


                        partitionId

PartitionId

Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.


                        PartitionId

object

A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty.

A partition ID contains several dimensions: project ID and namespace ID.

Partition dimensions:

May be "".
Must be valid UTF-8 bytes.
Must have values that match regex [A-Za-z\d\.\-_]{1,100} If the value of any dimension matches regex __.*__, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts.

Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state.

Properties

`projectId`	string	The ID of the project to which the entities belong.
`namespaceId`	string	If not empty, the ID of the namespace to which the entities belong.


                        baseVersion

string

The version of the entity that this mutation is being applied to. If this does not match the current version on the server, the mutation conflicts.


                        mode

string
Allowed values:
- MODE_UNSPECIFIED
- TRANSACTIONAL
- NON_TRANSACTIONAL

The type of commit to perform. Defaults to TRANSACTIONAL.

CommitResponse

The response for Datastore.Commit.

Properties

Name Data Type Description


                        mutationResults

array [MutationResult]

The result of performing the mutations. The i-th mutation result corresponds to the i-th mutation in the request.


                        MutationResult

object

The result of applying a mutation.

Properties


                        version

string

The version of the entity on the server after processing the mutation. If the mutation doesn't change anything on the server, then the version will be the version of the current entity or, if no entity is present, a version that is strictly greater than the version of any previous entity and less than the version of any possible future entity.

key

Key

The automatically allocated key. Set only when the mutation allocated a key.

Key

object

Properties


                        path

array [PathElement]

A path can never be empty, and a path can have at most 100 elements.


                        PathElement

object

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.

Properties

`name`	string	The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
`kind`	string	The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
`id`	string	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.


                        partitionId

PartitionId

Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.


                        PartitionId

object

A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty.

A partition ID contains several dimensions: project ID and namespace ID.

Partition dimensions:

May be "".
Must be valid UTF-8 bytes.
Must have values that match regex [A-Za-z\d\.\-_]{1,100} If the value of any dimension matches regex __.*__, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts.

Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state.

Properties

`projectId`	string	The ID of the project to which the entities belong.
`namespaceId`	string	If not empty, the ID of the namespace to which the entities belong.


                        conflictDetected

boolean

Whether a conflict was detected for this mutation. Always false when a conflict detection strategy field is not set in the mutation.


                        indexUpdates

integer

The number of index entries updated during the commit, or zero if none were updated.

CompositeFilter

A filter that merges multiple other filters using the given operator.

Properties

Name Data Type Description

op

string
Allowed values:
- OPERATOR_UNSPECIFIED
- AND

The operator for combining multiple filters.


                        filters

array [Filter]

The list of filters to combine. Must contain at least one filter.


                        Filter

object

A holder for any type of filter.

Properties


                        propertyFilter

PropertyFilter

A filter on a property.


                        PropertyFilter

object

A filter on a specific property.

Properties


                        value

Value

The value to compare the property to.


                        Value

object

A message that can hold any of the supported value types and associated metadata.

Properties

`timestampValue`	string	A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down.
`stringValue`	string	A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at least 1,000,000 bytes.
`nullValue`	string Allowed values: - `NULL_VALUE`	A null value.
`meaning`	integer	The `meaning` field should only be populated for backwards compatibility.
`keyValue`	Key	A key value.
`integerValue`	string	An integer value.
`geoPointValue`	LatLng	A geo point value representing a point on the surface of Earth.
`excludeFromIndexes`	boolean	If the value should be excluded from all indexes including those defined explicitly.
`entityValue`	Entity	An entity value. May have no key. May have a key with an incomplete key path. May have a reserved/read-only key.
`doubleValue`	double	A double value.
`booleanValue`	boolean	A boolean value.
`blobValue`	byte	A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded.
`arrayValue`	ArrayValue	An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`.


                        property

PropertyReference

The property to filter by.


                        PropertyReference

object

A reference to a property relative to the kind expressions.

Properties


                        name

string

The name of the property. If name includes "."s, it may be interpreted as a property name path.

op

string
Allowed values:
- OPERATOR_UNSPECIFIED
- LESS_THAN
- LESS_THAN_OR_EQUAL
- GREATER_THAN
- GREATER_THAN_OR_EQUAL
- EQUAL
- HAS_ANCESTOR

The operator to filter by.


                        compositeFilter

CompositeFilter

A composite filter.


                        CompositeFilter

object

A filter that merges multiple other filters using the given operator.

Properties

op

string
Allowed values:
- OPERATOR_UNSPECIFIED
- AND

The operator for combining multiple filters.


                        filters

array [Filter]

The list of filters to combine. Must contain at least one filter.


                        Filter

object

A holder for any type of filter.

Properties

`propertyFilter`	PropertyFilter	A filter on a property.
`compositeFilter`	CompositeFilter	A composite filter.

Empty

service Foo {
  rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
}

The JSON representation for Empty is empty JSON object {}.

Name	Data Type	Description
`Empty`	object	A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: `service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }` The JSON representation for `Empty` is empty JSON object `{}`.

Entity

A Datastore data object.

An entity is limited to 1 megabyte when stored. That roughly corresponds to a limit of 1 megabyte for the serialized form of this message.

Properties

Name Data Type Description


                        properties

object

key

Key

The entity's key.

Key

object

Properties


                        path

array [PathElement]

A path can never be empty, and a path can have at most 100 elements.


                        PathElement

object

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.

Properties

`name`	string	The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
`kind`	string	The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
`id`	string	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.


                        partitionId

PartitionId

Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.


                        PartitionId

object

A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty.

A partition ID contains several dimensions: project ID and namespace ID.

Partition dimensions:

May be "".
Must be valid UTF-8 bytes.
Must have values that match regex [A-Za-z\d\.\-_]{1,100} If the value of any dimension matches regex __.*__, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts.

Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state.

Properties

`projectId`	string	The ID of the project to which the entities belong.
`namespaceId`	string	If not empty, the ID of the namespace to which the entities belong.

EntityResult

The result of fetching an entity from Datastore.

Properties

Name Data Type Description


                        version

string

The version of the entity, a strictly positive number that monotonically increases with changes to the entity.

This field is set for FULL entity results.

For missing entities in LookupResponse, this is the version of the snapshot that was used to look up the entity, and it is always set except for eventually consistent reads.


                        entity

Entity

The resulting entity.


                        Entity

object

A Datastore data object.

An entity is limited to 1 megabyte when stored. That roughly corresponds to a limit of 1 megabyte for the serialized form of this message.

Properties


                        properties

object

key

Key

The entity's key.

Key

object

Properties


                        path

array [PathElement]

A path can never be empty, and a path can have at most 100 elements.


                        PathElement

object

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.

Properties

`name`	string	The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
`kind`	string	The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
`id`	string	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.


                        partitionId

PartitionId

Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.


                        PartitionId

object

A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty.

A partition ID contains several dimensions: project ID and namespace ID.

Partition dimensions:

May be "".
Must be valid UTF-8 bytes.
Must have values that match regex [A-Za-z\d\.\-_]{1,100} If the value of any dimension matches regex __.*__, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts.

Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state.

Properties

`projectId`	string	The ID of the project to which the entities belong.
`namespaceId`	string	If not empty, the ID of the namespace to which the entities belong.


                        cursor

byte

A cursor that points to the position after the result entity. Set only when the EntityResult is part of a QueryResultBatch message.

Filter

A holder for any type of filter.

Properties

Name Data Type Description


                        propertyFilter

PropertyFilter

A filter on a property.


                        PropertyFilter

object

A filter on a specific property.

Properties


                        value

Value

The value to compare the property to.


                        Value

object

A message that can hold any of the supported value types and associated metadata.

Properties


                        timestampValue

string

A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down.


                        stringValue

string

A UTF-8 encoded string value. When exclude_from_indexes is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at least 1,000,000 bytes.


                        nullValue

string
Allowed values:
- NULL_VALUE

A null value.


                        meaning

integer

The meaning field should only be populated for backwards compatibility.


                        keyValue

Key

A key value.

Key

object

Properties

`path`	array [PathElement]	The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: all of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements.
`partitionId`	PartitionId	Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.


                        integerValue

string

An integer value.


                        geoPointValue

LatLng

A geo point value representing a point on the surface of Earth.


                        LatLng

object

Properties

`longitude`	double	The longitude in degrees. It must be in the range [-180.0, +180.0].
`latitude`	double	The latitude in degrees. It must be in the range [-90.0, +90.0].


                        excludeFromIndexes

boolean

If the value should be excluded from all indexes including those defined explicitly.


                        entityValue

Entity

An entity value.

May have no key.
May have a key with an incomplete key path.
May have a reserved/read-only key.


                        Entity

object

A Datastore data object.

An entity is limited to 1 megabyte when stored. That roughly corresponds to a limit of 1 megabyte for the serialized form of this message.

Properties

`properties`	object	The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`.
`key`	Key	The entity's key. An entity must have a key, unless otherwise documented (for example, an entity in `Value.entity_value` may have no key). An entity's kind is its key path's last element's kind, or null if it has no key.


                        doubleValue

double

A double value.


                        booleanValue

boolean

A boolean value.


                        blobValue

byte

A blob value. May have at most 1,000,000 bytes. When exclude_from_indexes is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded.


                        arrayValue

ArrayValue

An array value. Cannot contain another array value. A Value instance that sets field array_value must not set fields meaning or exclude_from_indexes.


                        ArrayValue

object

An array value.

Properties


                        values

array [Value]

Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'.


                        property

PropertyReference

The property to filter by.


                        PropertyReference

object

A reference to a property relative to the kind expressions.

Properties


                        name

string

The name of the property. If name includes "."s, it may be interpreted as a property name path.

op

string
Allowed values:
- OPERATOR_UNSPECIFIED
- LESS_THAN
- LESS_THAN_OR_EQUAL
- GREATER_THAN
- GREATER_THAN_OR_EQUAL
- EQUAL
- HAS_ANCESTOR

The operator to filter by.


                        compositeFilter

CompositeFilter

A composite filter.


                        CompositeFilter

object

A filter that merges multiple other filters using the given operator.

Properties

op

string
Allowed values:
- OPERATOR_UNSPECIFIED
- AND

The operator for combining multiple filters.


                        filters

array [Filter]

The list of filters to combine. Must contain at least one filter.


                        Filter

object

A holder for any type of filter.

Properties


                        propertyFilter

PropertyFilter

A filter on a property.


                        PropertyFilter

object

A filter on a specific property.

Properties

`value`	Value	The value to compare the property to.
`property`	PropertyReference	The property to filter by.
`op`	string Allowed values: - `OPERATOR_UNSPECIFIED` - `LESS_THAN` - `LESS_THAN_OR_EQUAL` - `GREATER_THAN` - `GREATER_THAN_OR_EQUAL` - `EQUAL` - `HAS_ANCESTOR`	The operator to filter by.


                        compositeFilter

CompositeFilter

A composite filter.


                        CompositeFilter

object

A filter that merges multiple other filters using the given operator.

Properties

`op`	string Allowed values: - `OPERATOR_UNSPECIFIED` - `AND`	The operator for combining multiple filters.
`filters`	array [Filter]	The list of filters to combine. Must contain at least one filter.

GoogleDatastoreAdminV1CommonMetadata

GoogleDatastoreAdminV1EntityFilter

GoogleDatastoreAdminV1ExportEntitiesMetadata

Metadata for ExportEntities operations.

Properties

Name Data Type Description


                        progressEntities

GoogleDatastoreAdminV1Progress

An estimate of the number of entities processed.


                        GoogleDatastoreAdminV1Progress

object

Measures the progress of a particular metric.

Properties

`workEstimated`	string	An estimate of how much work needs to be performed. May be zero if the work estimate is unavailable.
`workCompleted`	string	The amount of work that has been completed. Note that this may be greater than work_estimated.


                        progressBytes

GoogleDatastoreAdminV1Progress

An estimate of the number of bytes processed.


                        GoogleDatastoreAdminV1Progress

object

Measures the progress of a particular metric.

Properties

`workEstimated`	string	An estimate of how much work needs to be performed. May be zero if the work estimate is unavailable.
`workCompleted`	string	The amount of work that has been completed. Note that this may be greater than work_estimated.


                        outputUrlPrefix

string

Location for the export metadata and data files. This will be the same value as the google.datastore.admin.v1.ExportEntitiesRequest.output_url_prefix field. The final output location is provided in google.datastore.admin.v1.ExportEntitiesResponse.output_url.


                        entityFilter

GoogleDatastoreAdminV1EntityFilter

Description of which entities are being exported.


                        GoogleDatastoreAdminV1EntityFilter

object

Identifies a subset of entities in a project. This is specified as combinations of kinds and namespaces (either or both of which may be all, as described in the following examples). Example usage:

Entire project: kinds=[], namespace_ids=[]

Kinds Foo and Bar in all namespaces: kinds=['Foo', 'Bar'], namespace_ids=[]

Kinds Foo and Bar only in the default namespace: kinds=['Foo', 'Bar'], namespace_ids=['']

Kinds Foo and Bar in both the default and Baz namespaces: kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz']

The entire Baz namespace: kinds=[], namespace_ids=['Baz']

Properties

`namespaceIds`	array [string]	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 want to include them. Each namespace in this list must be unique.
`kinds`	array [string]	If empty, then this represents all kinds.


                        common

GoogleDatastoreAdminV1CommonMetadata

Metadata common to all Datastore Admin operations.


                        GoogleDatastoreAdminV1CommonMetadata

object

Metadata common to all Datastore Admin operations.

Properties

`state`	string Allowed values: - `STATE_UNSPECIFIED` - `INITIALIZING` - `PROCESSING` - `CANCELLING` - `FINALIZING` - `SUCCESSFUL` - `FAILED` - `CANCELLED`	The current state of the Operation.
`startTime`	string	The time that work began on the operation.
`operationType`	string Allowed values: - `OPERATION_TYPE_UNSPECIFIED` - `EXPORT_ENTITIES` - `IMPORT_ENTITIES` - `CREATE_INDEX` - `DELETE_INDEX`	The type of the operation. Can be used as a filter in ListOperationsRequest.
`labels`	object	The client-assigned labels which were provided when the operation was created. May also include additional labels.
`endTime`	string	The time the operation ended, either successfully or otherwise.

GoogleDatastoreAdminV1ExportEntitiesRequest

The request for google.datastore.admin.v1.DatastoreAdmin.ExportEntities.

Properties

Name Data Type Description


                        outputUrlPrefix

string

Required. Location for the export metadata and data files.

By nesting the data files deeper, the same Cloud Storage bucket can be used in multiple ExportEntities operations without conflict.


                        labels

object

Client-assigned labels.


                        entityFilter

GoogleDatastoreAdminV1EntityFilter

Description of what data from the project is included in the export.


                        GoogleDatastoreAdminV1EntityFilter

object

Identifies a subset of entities in a project. This is specified as combinations of kinds and namespaces (either or both of which may be all, as described in the following examples). Example usage:

Entire project: kinds=[], namespace_ids=[]

Kinds Foo and Bar in all namespaces: kinds=['Foo', 'Bar'], namespace_ids=[]

Kinds Foo and Bar only in the default namespace: kinds=['Foo', 'Bar'], namespace_ids=['']

Kinds Foo and Bar in both the default and Baz namespaces: kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz']

The entire Baz namespace: kinds=[], namespace_ids=['Baz']

Properties

`namespaceIds`	array [string]	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 want to include them. Each namespace in this list must be unique.
`kinds`	array [string]	If empty, then this represents all kinds.

GoogleDatastoreAdminV1ExportEntitiesResponse

GoogleDatastoreAdminV1ImportEntitiesMetadata

Metadata for ImportEntities operations.

Properties

Name Data Type Description


                        progressEntities

GoogleDatastoreAdminV1Progress

An estimate of the number of entities processed.


                        GoogleDatastoreAdminV1Progress

object

Measures the progress of a particular metric.

Properties

`workEstimated`	string	An estimate of how much work needs to be performed. May be zero if the work estimate is unavailable.
`workCompleted`	string	The amount of work that has been completed. Note that this may be greater than work_estimated.


                        progressBytes

GoogleDatastoreAdminV1Progress

An estimate of the number of bytes processed.


                        GoogleDatastoreAdminV1Progress

object

Measures the progress of a particular metric.

Properties

`workEstimated`	string	An estimate of how much work needs to be performed. May be zero if the work estimate is unavailable.
`workCompleted`	string	The amount of work that has been completed. Note that this may be greater than work_estimated.


                        inputUrl

string

The location of the import metadata file. This will be the same value as the google.datastore.admin.v1.ExportEntitiesResponse.output_url field.


                        entityFilter

GoogleDatastoreAdminV1EntityFilter

Description of which entities are being imported.


                        GoogleDatastoreAdminV1EntityFilter

object

Identifies a subset of entities in a project. This is specified as combinations of kinds and namespaces (either or both of which may be all, as described in the following examples). Example usage:

Entire project: kinds=[], namespace_ids=[]

Kinds Foo and Bar in all namespaces: kinds=['Foo', 'Bar'], namespace_ids=[]

Kinds Foo and Bar only in the default namespace: kinds=['Foo', 'Bar'], namespace_ids=['']

Kinds Foo and Bar in both the default and Baz namespaces: kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz']

The entire Baz namespace: kinds=[], namespace_ids=['Baz']

Properties

`namespaceIds`	array [string]	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 want to include them. Each namespace in this list must be unique.
`kinds`	array [string]	If empty, then this represents all kinds.


                        common

GoogleDatastoreAdminV1CommonMetadata

Metadata common to all Datastore Admin operations.


                        GoogleDatastoreAdminV1CommonMetadata

object

Metadata common to all Datastore Admin operations.

Properties

`state`	string Allowed values: - `STATE_UNSPECIFIED` - `INITIALIZING` - `PROCESSING` - `CANCELLING` - `FINALIZING` - `SUCCESSFUL` - `FAILED` - `CANCELLED`	The current state of the Operation.
`startTime`	string	The time that work began on the operation.
`operationType`	string Allowed values: - `OPERATION_TYPE_UNSPECIFIED` - `EXPORT_ENTITIES` - `IMPORT_ENTITIES` - `CREATE_INDEX` - `DELETE_INDEX`	The type of the operation. Can be used as a filter in ListOperationsRequest.
`labels`	object	The client-assigned labels which were provided when the operation was created. May also include additional labels.
`endTime`	string	The time the operation ended, either successfully or otherwise.

GoogleDatastoreAdminV1ImportEntitiesRequest

The request for google.datastore.admin.v1.DatastoreAdmin.ImportEntities.

Properties

Name Data Type Description


                        labels

object

Client-assigned labels.


                        inputUrl

string

For more information, see google.datastore.admin.v1.ExportEntitiesResponse.output_url.


                        entityFilter

GoogleDatastoreAdminV1EntityFilter


                        GoogleDatastoreAdminV1EntityFilter

object

Identifies a subset of entities in a project. This is specified as combinations of kinds and namespaces (either or both of which may be all, as described in the following examples). Example usage:

Entire project: kinds=[], namespace_ids=[]

Kinds Foo and Bar in all namespaces: kinds=['Foo', 'Bar'], namespace_ids=[]

Kinds Foo and Bar only in the default namespace: kinds=['Foo', 'Bar'], namespace_ids=['']

Kinds Foo and Bar in both the default and Baz namespaces: kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz']

The entire Baz namespace: kinds=[], namespace_ids=['Baz']

Properties

`namespaceIds`	array [string]	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 want to include them. Each namespace in this list must be unique.
`kinds`	array [string]	If empty, then this represents all kinds.

GoogleDatastoreAdminV1Index

A minimal index definition.

Properties

Name Data Type Description


                        state

string
Allowed values:
- STATE_UNSPECIFIED
- CREATING
- READY
- DELETING
- ERROR

Output only. The state of the index.


                        properties

array [GoogleDatastoreAdminV1IndexedProperty]

Required. An ordered sequence of property names and their index attributes.


                        GoogleDatastoreAdminV1IndexedProperty

object

A property of an index.

Properties

`name`	string	Required. The property name to index.
`direction`	string Allowed values: - `DIRECTION_UNSPECIFIED` - `ASCENDING` - `DESCENDING`	Required. The indexed property's direction. Must not be DIRECTION_UNSPECIFIED.


                        projectId

string

Output only. Project ID.


                        kind

string

Required. The entity kind to which this index applies.


                        indexId

string

Output only. The resource ID of the index.


                        ancestor

string
Allowed values:
- ANCESTOR_MODE_UNSPECIFIED
- NONE
- ALL_ANCESTORS

Required. The index's ancestor mode. Must not be ANCESTOR_MODE_UNSPECIFIED.

GoogleDatastoreAdminV1IndexOperationMetadata

Metadata for Index operations.

Properties

Name Data Type Description


                        progressEntities

GoogleDatastoreAdminV1Progress

An estimate of the number of entities processed.


                        GoogleDatastoreAdminV1Progress

object

Measures the progress of a particular metric.

Properties

`workEstimated`	string	An estimate of how much work needs to be performed. May be zero if the work estimate is unavailable.
`workCompleted`	string	The amount of work that has been completed. Note that this may be greater than work_estimated.


                        indexId

string

The index resource ID that this operation is acting on.


                        common

GoogleDatastoreAdminV1CommonMetadata

Metadata common to all Datastore Admin operations.


                        GoogleDatastoreAdminV1CommonMetadata

object

Metadata common to all Datastore Admin operations.

Properties

`state`	string Allowed values: - `STATE_UNSPECIFIED` - `INITIALIZING` - `PROCESSING` - `CANCELLING` - `FINALIZING` - `SUCCESSFUL` - `FAILED` - `CANCELLED`	The current state of the Operation.
`startTime`	string	The time that work began on the operation.
`operationType`	string Allowed values: - `OPERATION_TYPE_UNSPECIFIED` - `EXPORT_ENTITIES` - `IMPORT_ENTITIES` - `CREATE_INDEX` - `DELETE_INDEX`	The type of the operation. Can be used as a filter in ListOperationsRequest.
`labels`	object	The client-assigned labels which were provided when the operation was created. May also include additional labels.
`endTime`	string	The time the operation ended, either successfully or otherwise.

GoogleDatastoreAdminV1IndexedProperty

GoogleDatastoreAdminV1ListIndexesResponse

The response for google.datastore.admin.v1.DatastoreAdmin.ListIndexes.

Properties

Name Data Type Description


                        nextPageToken

string

The standard List next-page token.


                        indexes

array [GoogleDatastoreAdminV1Index]

The indexes.


                        GoogleDatastoreAdminV1Index

object

A minimal index definition.

Properties


                        state

string
Allowed values:
- STATE_UNSPECIFIED
- CREATING
- READY
- DELETING
- ERROR

Output only. The state of the index.


                        properties

array [GoogleDatastoreAdminV1IndexedProperty]

Required. An ordered sequence of property names and their index attributes.


                        GoogleDatastoreAdminV1IndexedProperty

object

A property of an index.

Properties

`name`	string	Required. The property name to index.
`direction`	string Allowed values: - `DIRECTION_UNSPECIFIED` - `ASCENDING` - `DESCENDING`	Required. The indexed property's direction. Must not be DIRECTION_UNSPECIFIED.


                        projectId

string

Output only. Project ID.


                        kind

string

Required. The entity kind to which this index applies.


                        indexId

string

Output only. The resource ID of the index.


                        ancestor

string
Allowed values:
- ANCESTOR_MODE_UNSPECIFIED
- NONE
- ALL_ANCESTORS

Required. The index's ancestor mode. Must not be ANCESTOR_MODE_UNSPECIFIED.

GoogleDatastoreAdminV1Progress

GoogleDatastoreAdminV1beta1CommonMetadata

GoogleDatastoreAdminV1beta1EntityFilter

GoogleDatastoreAdminV1beta1ExportEntitiesMetadata

Metadata for ExportEntities operations.

Properties

Name Data Type Description


                        progressEntities

GoogleDatastoreAdminV1beta1Progress

An estimate of the number of entities processed.


                        GoogleDatastoreAdminV1beta1Progress

object

Measures the progress of a particular metric.

Properties

`workEstimated`	string	An estimate of how much work needs to be performed. May be zero if the work estimate is unavailable.
`workCompleted`	string	The amount of work that has been completed. Note that this may be greater than work_estimated.


                        progressBytes

GoogleDatastoreAdminV1beta1Progress

An estimate of the number of bytes processed.


                        GoogleDatastoreAdminV1beta1Progress

object

Measures the progress of a particular metric.

Properties

`workEstimated`	string	An estimate of how much work needs to be performed. May be zero if the work estimate is unavailable.
`workCompleted`	string	The amount of work that has been completed. Note that this may be greater than work_estimated.


                        outputUrlPrefix

string

Location for the export metadata and data files. This will be the same value as the google.datastore.admin.v1beta1.ExportEntitiesRequest.output_url_prefix field. The final output location is provided in google.datastore.admin.v1beta1.ExportEntitiesResponse.output_url.


                        entityFilter

GoogleDatastoreAdminV1beta1EntityFilter

Description of which entities are being exported.


                        GoogleDatastoreAdminV1beta1EntityFilter

object

Identifies a subset of entities in a project. This is specified as combinations of kinds and namespaces (either or both of which may be all, as described in the following examples). Example usage:

Entire project: kinds=[], namespace_ids=[]

Kinds Foo and Bar in all namespaces: kinds=['Foo', 'Bar'], namespace_ids=[]

Kinds Foo and Bar only in the default namespace: kinds=['Foo', 'Bar'], namespace_ids=['']

Kinds Foo and Bar in both the default and Baz namespaces: kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz']

The entire Baz namespace: kinds=[], namespace_ids=['Baz']

Properties

`namespaceIds`	array [string]	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 want to include them. Each namespace in this list must be unique.
`kinds`	array [string]	If empty, then this represents all kinds.


                        common

GoogleDatastoreAdminV1beta1CommonMetadata

Metadata common to all Datastore Admin operations.


                        GoogleDatastoreAdminV1beta1CommonMetadata

object

Metadata common to all Datastore Admin operations.

Properties

`state`	string Allowed values: - `STATE_UNSPECIFIED` - `INITIALIZING` - `PROCESSING` - `CANCELLING` - `FINALIZING` - `SUCCESSFUL` - `FAILED` - `CANCELLED`	The current state of the Operation.
`startTime`	string	The time that work began on the operation.
`operationType`	string Allowed values: - `OPERATION_TYPE_UNSPECIFIED` - `EXPORT_ENTITIES` - `IMPORT_ENTITIES`	The type of the operation. Can be used as a filter in ListOperationsRequest.
`labels`	object	The client-assigned labels which were provided when the operation was created. May also include additional labels.
`endTime`	string	The time the operation ended, either successfully or otherwise.

GoogleDatastoreAdminV1beta1ExportEntitiesResponse

GoogleDatastoreAdminV1beta1ImportEntitiesMetadata

Metadata for ImportEntities operations.

Properties

Name Data Type Description


                        progressEntities

GoogleDatastoreAdminV1beta1Progress

An estimate of the number of entities processed.


                        GoogleDatastoreAdminV1beta1Progress

object

Measures the progress of a particular metric.

Properties

`workEstimated`	string	An estimate of how much work needs to be performed. May be zero if the work estimate is unavailable.
`workCompleted`	string	The amount of work that has been completed. Note that this may be greater than work_estimated.


                        progressBytes

GoogleDatastoreAdminV1beta1Progress

An estimate of the number of bytes processed.


                        GoogleDatastoreAdminV1beta1Progress

object

Measures the progress of a particular metric.

Properties

`workEstimated`	string	An estimate of how much work needs to be performed. May be zero if the work estimate is unavailable.
`workCompleted`	string	The amount of work that has been completed. Note that this may be greater than work_estimated.


                        inputUrl

string

The location of the import metadata file. This will be the same value as the google.datastore.admin.v1beta1.ExportEntitiesResponse.output_url field.


                        entityFilter

GoogleDatastoreAdminV1beta1EntityFilter

Description of which entities are being imported.


                        GoogleDatastoreAdminV1beta1EntityFilter

object

Identifies a subset of entities in a project. This is specified as combinations of kinds and namespaces (either or both of which may be all, as described in the following examples). Example usage:

Entire project: kinds=[], namespace_ids=[]

Kinds Foo and Bar in all namespaces: kinds=['Foo', 'Bar'], namespace_ids=[]

Kinds Foo and Bar only in the default namespace: kinds=['Foo', 'Bar'], namespace_ids=['']

Kinds Foo and Bar in both the default and Baz namespaces: kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz']

The entire Baz namespace: kinds=[], namespace_ids=['Baz']

Properties

`namespaceIds`	array [string]	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 want to include them. Each namespace in this list must be unique.
`kinds`	array [string]	If empty, then this represents all kinds.


                        common

GoogleDatastoreAdminV1beta1CommonMetadata

Metadata common to all Datastore Admin operations.


                        GoogleDatastoreAdminV1beta1CommonMetadata

object

Metadata common to all Datastore Admin operations.

Properties

`state`	string Allowed values: - `STATE_UNSPECIFIED` - `INITIALIZING` - `PROCESSING` - `CANCELLING` - `FINALIZING` - `SUCCESSFUL` - `FAILED` - `CANCELLED`	The current state of the Operation.
`startTime`	string	The time that work began on the operation.
`operationType`	string Allowed values: - `OPERATION_TYPE_UNSPECIFIED` - `EXPORT_ENTITIES` - `IMPORT_ENTITIES`	The type of the operation. Can be used as a filter in ListOperationsRequest.
`labels`	object	The client-assigned labels which were provided when the operation was created. May also include additional labels.
`endTime`	string	The time the operation ended, either successfully or otherwise.

GoogleDatastoreAdminV1beta1Progress

GoogleLongrunningListOperationsResponse

The response message for Operations.ListOperations.

Properties

Name Data Type Description


                        operations

array [GoogleLongrunningOperation]

A list of operations that matches the specified filter in the request.


                        GoogleLongrunningOperation

object

This resource represents a long-running operation that is the result of a network API call.

Properties


                        response

object


                        name

string


                        metadata

object


                        error

Status

The error result of the operation in case of failure or cancellation.


                        Status

object

You can find out more about this error model and how to work with it in the API Design Guide.

Properties

`message`	string	A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
`details`	array [object]	A list of messages that carry the error details. There is a common set of message types for APIs to use.
`code`	integer	The status code, which should be an enum value of google.rpc.Code.


                        done

boolean

If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.


                        nextPageToken

string

The standard List next-page token.

GoogleLongrunningOperation

This resource represents a long-running operation that is the result of a network API call.

Properties

Name Data Type Description


                        response

object


                        name

string


                        metadata

object


                        error

Status

The error result of the operation in case of failure or cancellation.


                        Status

object

You can find out more about this error model and how to work with it in the API Design Guide.

Properties

`message`	string	A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
`details`	array [object]	A list of messages that carry the error details. There is a common set of message types for APIs to use.
`code`	integer	The status code, which should be an enum value of google.rpc.Code.


                        done

boolean

If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.

GqlQuery

A GQL query.

Properties

Name Data Type Description


                        queryString

string

A string of the format described here.


                        positionalBindings

array [GqlQueryParameter]

Numbered binding site @1 references the first numbered parameter, effectively using 1-based indexing, rather than the usual 0.

For each binding site numbered i in query_string, there must be an i-th numbered parameter. The inverse must also be true.


                        GqlQueryParameter

object

A binding parameter for a GQL query.

Properties


                        value

Value

A value parameter.


                        Value

object

A message that can hold any of the supported value types and associated metadata.

Properties


                        timestampValue

string

A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down.


                        stringValue

string

A UTF-8 encoded string value. When exclude_from_indexes is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at least 1,000,000 bytes.


                        nullValue

string
Allowed values:
- NULL_VALUE

A null value.


                        meaning

integer

The meaning field should only be populated for backwards compatibility.


                        keyValue

Key

A key value.

Key

object

Properties

`path`	array [PathElement]	The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: all of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements.
`partitionId`	PartitionId	Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.


                        integerValue

string

An integer value.


                        geoPointValue

LatLng

A geo point value representing a point on the surface of Earth.


                        LatLng

object

Properties

`longitude`	double	The longitude in degrees. It must be in the range [-180.0, +180.0].
`latitude`	double	The latitude in degrees. It must be in the range [-90.0, +90.0].


                        excludeFromIndexes

boolean

If the value should be excluded from all indexes including those defined explicitly.


                        entityValue

Entity

An entity value.

May have no key.
May have a key with an incomplete key path.
May have a reserved/read-only key.


                        Entity

object

A Datastore data object.

An entity is limited to 1 megabyte when stored. That roughly corresponds to a limit of 1 megabyte for the serialized form of this message.

Properties

`properties`	object	The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`.
`key`	Key	The entity's key. An entity must have a key, unless otherwise documented (for example, an entity in `Value.entity_value` may have no key). An entity's kind is its key path's last element's kind, or null if it has no key.


                        doubleValue

double

A double value.


                        booleanValue

boolean

A boolean value.


                        blobValue

byte

A blob value. May have at most 1,000,000 bytes. When exclude_from_indexes is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded.


                        arrayValue

ArrayValue

An array value. Cannot contain another array value. A Value instance that sets field array_value must not set fields meaning or exclude_from_indexes.


                        ArrayValue

object

An array value.

Properties


                        values

array [Value]

Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'.


                        cursor

byte

A query cursor. Query cursors are returned in query result batches.


                        namedBindings

object

For each non-reserved named binding site in the query string, there must be a named parameter with that name, but not necessarily the inverse.

Key must match regex A-Za-z_$*, must not match regex __.*__, and must not be "".


                        allowLiterals

boolean

When false, the query string must not contain any literals and instead must bind all values. For example, SELECT * FROM Kind WHERE a = 'string literal' is not allowed, while SELECT * FROM Kind WHERE a = @value is.

GqlQueryParameter

A binding parameter for a GQL query.

Properties

Name Data Type Description


                        value

Value

A value parameter.


                        Value

object

A message that can hold any of the supported value types and associated metadata.

Properties


                        timestampValue

string

A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down.


                        stringValue

string

A UTF-8 encoded string value. When exclude_from_indexes is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at least 1,000,000 bytes.


                        nullValue

string
Allowed values:
- NULL_VALUE

A null value.


                        meaning

integer

The meaning field should only be populated for backwards compatibility.


                        keyValue

Key

A key value.

Key

object

Properties


                        path

array [PathElement]

A path can never be empty, and a path can have at most 100 elements.


                        PathElement

object

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.

Properties

`name`	string	The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
`kind`	string	The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
`id`	string	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.


                        partitionId

PartitionId

Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.


                        PartitionId

object

A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty.

A partition ID contains several dimensions: project ID and namespace ID.

Partition dimensions:

May be "".
Must be valid UTF-8 bytes.
Must have values that match regex [A-Za-z\d\.\-_]{1,100} If the value of any dimension matches regex __.*__, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts.

Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state.

Properties

`projectId`	string	The ID of the project to which the entities belong.
`namespaceId`	string	If not empty, the ID of the namespace to which the entities belong.


                        integerValue

string

An integer value.


                        geoPointValue

LatLng

A geo point value representing a point on the surface of Earth.


                        LatLng

object

Properties

`longitude`	double	The longitude in degrees. It must be in the range [-180.0, +180.0].
`latitude`	double	The latitude in degrees. It must be in the range [-90.0, +90.0].


                        excludeFromIndexes

boolean

If the value should be excluded from all indexes including those defined explicitly.


                        entityValue

Entity

An entity value.

May have no key.
May have a key with an incomplete key path.
May have a reserved/read-only key.


                        Entity

object

A Datastore data object.

An entity is limited to 1 megabyte when stored. That roughly corresponds to a limit of 1 megabyte for the serialized form of this message.

Properties


                        properties

object

key

Key

The entity's key.

Key

object

Properties

`path`	array [PathElement]	The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: all of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements.
`partitionId`	PartitionId	Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.


                        doubleValue

double

A double value.


                        booleanValue

boolean

A boolean value.


                        blobValue

byte

A blob value. May have at most 1,000,000 bytes. When exclude_from_indexes is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded.


                        arrayValue

ArrayValue

An array value. Cannot contain another array value. A Value instance that sets field array_value must not set fields meaning or exclude_from_indexes.


                        ArrayValue

object

An array value.

Properties


                        values

array [Value]

Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'.


                        Value

object

A message that can hold any of the supported value types and associated metadata.

Properties

`timestampValue`	string	A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down.
`stringValue`	string	A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at least 1,000,000 bytes.
`nullValue`	string Allowed values: - `NULL_VALUE`	A null value.
`meaning`	integer	The `meaning` field should only be populated for backwards compatibility.
`keyValue`	Key	A key value.
`integerValue`	string	An integer value.
`geoPointValue`	LatLng	A geo point value representing a point on the surface of Earth.
`excludeFromIndexes`	boolean	If the value should be excluded from all indexes including those defined explicitly.
`entityValue`	Entity	An entity value. May have no key. May have a key with an incomplete key path. May have a reserved/read-only key.
`doubleValue`	double	A double value.
`booleanValue`	boolean	A boolean value.
`blobValue`	byte	A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded.
`arrayValue`	ArrayValue	An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`.


                        cursor

byte

A query cursor. Query cursors are returned in query result batches.

Key

Properties

Name Data Type Description


                        path

array [PathElement]

A path can never be empty, and a path can have at most 100 elements.


                        PathElement

object

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.

Properties

`name`	string	The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
`kind`	string	The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
`id`	string	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.


                        partitionId

PartitionId

Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.


                        PartitionId

object

A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty.

A partition ID contains several dimensions: project ID and namespace ID.

Partition dimensions:

May be "".
Must be valid UTF-8 bytes.
Must have values that match regex [A-Za-z\d\.\-_]{1,100} If the value of any dimension matches regex __.*__, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts.

Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state.

Properties

`projectId`	string	The ID of the project to which the entities belong.
`namespaceId`	string	If not empty, the ID of the namespace to which the entities belong.

KindExpression

LatLng

LookupRequest

The request for Datastore.Lookup.

Properties

Name Data Type Description


                        readOptions

ReadOptions

The options for this lookup request.


                        ReadOptions

object

The options shared by read requests.

Properties

`transaction`	byte	The identifier of the transaction in which to read. A transaction identifier is returned by a call to Datastore.BeginTransaction.
`readConsistency`	string Allowed values: - `READ_CONSISTENCY_UNSPECIFIED` - `STRONG` - `EVENTUAL`	The non-transactional read consistency to use. Cannot be set to `STRONG` for global queries.


                        keys

array [Key]

Required. Keys of entities to look up.

Key

object

Properties


                        path

array [PathElement]

A path can never be empty, and a path can have at most 100 elements.


                        PathElement

object

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.

Properties

`name`	string	The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
`kind`	string	The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
`id`	string	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.


                        partitionId

PartitionId

Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.


                        PartitionId

object

A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty.

A partition ID contains several dimensions: project ID and namespace ID.

Partition dimensions:

May be "".
Must be valid UTF-8 bytes.
Must have values that match regex [A-Za-z\d\.\-_]{1,100} If the value of any dimension matches regex __.*__, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts.

Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state.

Properties

`projectId`	string	The ID of the project to which the entities belong.
`namespaceId`	string	If not empty, the ID of the namespace to which the entities belong.

LookupResponse

The response for Datastore.Lookup.

Properties

Name Data Type Description


                        missing

array [EntityResult]

Entities not found as ResultType.KEY_ONLY entities. The order of results in this field is undefined and has no relation to the order of the keys in the input.


                        EntityResult

object

The result of fetching an entity from Datastore.

Properties


                        version

string

The version of the entity, a strictly positive number that monotonically increases with changes to the entity.

This field is set for FULL entity results.

For missing entities in LookupResponse, this is the version of the snapshot that was used to look up the entity, and it is always set except for eventually consistent reads.


                        entity

Entity

The resulting entity.


                        Entity

object

A Datastore data object.

An entity is limited to 1 megabyte when stored. That roughly corresponds to a limit of 1 megabyte for the serialized form of this message.

Properties


                        properties

object

key

Key

The entity's key.

Key

object

Properties

`path`	array [PathElement]	The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: all of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements.
`partitionId`	PartitionId	Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.


                        cursor

byte

A cursor that points to the position after the result entity. Set only when the EntityResult is part of a QueryResultBatch message.


                        found

array [EntityResult]

Entities found as ResultType.FULL entities. The order of results in this field is undefined and has no relation to the order of the keys in the input.


                        EntityResult

object

The result of fetching an entity from Datastore.

Properties


                        version

string

The version of the entity, a strictly positive number that monotonically increases with changes to the entity.

This field is set for FULL entity results.

For missing entities in LookupResponse, this is the version of the snapshot that was used to look up the entity, and it is always set except for eventually consistent reads.


                        entity

Entity

The resulting entity.


                        Entity

object

A Datastore data object.

An entity is limited to 1 megabyte when stored. That roughly corresponds to a limit of 1 megabyte for the serialized form of this message.

Properties


                        properties

object

key

Key

The entity's key.

Key

object

Properties

`path`	array [PathElement]	The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: all of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements.
`partitionId`	PartitionId	Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.


                        cursor

byte

A cursor that points to the position after the result entity. Set only when the EntityResult is part of a QueryResultBatch message.


                        deferred

array [Key]

A list of keys that were not looked up due to resource constraints. The order of results in this field is undefined and has no relation to the order of the keys in the input.

Key

object

Properties


                        path

array [PathElement]

A path can never be empty, and a path can have at most 100 elements.


                        PathElement

object

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.

Properties

`name`	string	The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
`kind`	string	The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
`id`	string	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.


                        partitionId

PartitionId

Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.


                        PartitionId

object

A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty.

A partition ID contains several dimensions: project ID and namespace ID.

Partition dimensions:

May be "".
Must be valid UTF-8 bytes.
Must have values that match regex [A-Za-z\d\.\-_]{1,100} If the value of any dimension matches regex __.*__, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts.

Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state.

Properties

`projectId`	string	The ID of the project to which the entities belong.
`namespaceId`	string	If not empty, the ID of the namespace to which the entities belong.

Mutation

A mutation to apply to an entity.

Properties

Name Data Type Description


                        upsert

Entity

The entity to upsert. The entity may or may not already exist. The entity key's final path element may be incomplete.


                        Entity

object

A Datastore data object.

An entity is limited to 1 megabyte when stored. That roughly corresponds to a limit of 1 megabyte for the serialized form of this message.

Properties


                        properties

object

key

Key

The entity's key.

Key

object

Properties


                        path

array [PathElement]

A path can never be empty, and a path can have at most 100 elements.


                        PathElement

object

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.

Properties

`name`	string	The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
`kind`	string	The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
`id`	string	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.


                        partitionId

PartitionId

Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.


                        PartitionId

object

A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty.

A partition ID contains several dimensions: project ID and namespace ID.

Partition dimensions:

May be "".
Must be valid UTF-8 bytes.
Must have values that match regex [A-Za-z\d\.\-_]{1,100} If the value of any dimension matches regex __.*__, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts.

Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state.

Properties

`projectId`	string	The ID of the project to which the entities belong.
`namespaceId`	string	If not empty, the ID of the namespace to which the entities belong.


                        update

Entity

The entity to update. The entity must already exist. Must have a complete key path.


                        Entity

object

A Datastore data object.

An entity is limited to 1 megabyte when stored. That roughly corresponds to a limit of 1 megabyte for the serialized form of this message.

Properties


                        properties

object

key

Key

The entity's key.

Key

object

Properties


                        path

array [PathElement]

A path can never be empty, and a path can have at most 100 elements.


                        PathElement

object

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.

Properties

`name`	string	The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
`kind`	string	The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
`id`	string	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.


                        partitionId

PartitionId

Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.


                        PartitionId

object

A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty.

A partition ID contains several dimensions: project ID and namespace ID.

Partition dimensions:

May be "".
Must be valid UTF-8 bytes.
Must have values that match regex [A-Za-z\d\.\-_]{1,100} If the value of any dimension matches regex __.*__, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts.

Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state.

Properties

`projectId`	string	The ID of the project to which the entities belong.
`namespaceId`	string	If not empty, the ID of the namespace to which the entities belong.


                        insert

Entity

The entity to insert. The entity must not already exist. The entity key's final path element may be incomplete.


                        Entity

object

A Datastore data object.

An entity is limited to 1 megabyte when stored. That roughly corresponds to a limit of 1 megabyte for the serialized form of this message.

Properties


                        properties

object

key

Key

The entity's key.

Key

object

Properties


                        path

array [PathElement]

A path can never be empty, and a path can have at most 100 elements.


                        PathElement

object

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.

Properties

`name`	string	The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
`kind`	string	The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
`id`	string	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.


                        partitionId

PartitionId

Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.


                        PartitionId

object

A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty.

A partition ID contains several dimensions: project ID and namespace ID.

Partition dimensions:

May be "".
Must be valid UTF-8 bytes.
Must have values that match regex [A-Za-z\d\.\-_]{1,100} If the value of any dimension matches regex __.*__, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts.

Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state.

Properties

`projectId`	string	The ID of the project to which the entities belong.
`namespaceId`	string	If not empty, the ID of the namespace to which the entities belong.


                        delete

Key

The key of the entity to delete. The entity may or may not already exist. Must have a complete key path and must not be reserved/read-only.

Key

object

Properties


                        path

array [PathElement]

A path can never be empty, and a path can have at most 100 elements.


                        PathElement

object

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.

Properties

`name`	string	The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
`kind`	string	The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
`id`	string	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.


                        partitionId

PartitionId

Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.


                        PartitionId

object

A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty.

A partition ID contains several dimensions: project ID and namespace ID.

Partition dimensions:

May be "".
Must be valid UTF-8 bytes.
Must have values that match regex [A-Za-z\d\.\-_]{1,100} If the value of any dimension matches regex __.*__, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts.

Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state.

Properties

`projectId`	string	The ID of the project to which the entities belong.
`namespaceId`	string	If not empty, the ID of the namespace to which the entities belong.


                        baseVersion

string

The version of the entity that this mutation is being applied to. If this does not match the current version on the server, the mutation conflicts.

MutationResult

The result of applying a mutation.

Properties

Name Data Type Description


                        version

string

key

Key

The automatically allocated key. Set only when the mutation allocated a key.

Key

object

Properties


                        path

array [PathElement]

A path can never be empty, and a path can have at most 100 elements.


                        PathElement

object

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.

Properties

`name`	string	The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
`kind`	string	The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
`id`	string	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.


                        partitionId

PartitionId

Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.


                        PartitionId

object

A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty.

A partition ID contains several dimensions: project ID and namespace ID.

Partition dimensions:

May be "".
Must be valid UTF-8 bytes.
Must have values that match regex [A-Za-z\d\.\-_]{1,100} If the value of any dimension matches regex __.*__, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts.

Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state.

Properties

`projectId`	string	The ID of the project to which the entities belong.
`namespaceId`	string	If not empty, the ID of the namespace to which the entities belong.


                        conflictDetected

boolean

Whether a conflict was detected for this mutation. Always false when a conflict detection strategy field is not set in the mutation.

PartitionId

PathElement

Projection

PropertyFilter

A filter on a specific property.

Properties

Name Data Type Description


                        value

Value

The value to compare the property to.


                        Value

object

A message that can hold any of the supported value types and associated metadata.

Properties


                        timestampValue

string

A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down.


                        stringValue

string

A UTF-8 encoded string value. When exclude_from_indexes is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at least 1,000,000 bytes.


                        nullValue

string
Allowed values:
- NULL_VALUE

A null value.


                        meaning

integer

The meaning field should only be populated for backwards compatibility.


                        keyValue

Key

A key value.

Key

object

Properties


                        path

array [PathElement]

A path can never be empty, and a path can have at most 100 elements.


                        PathElement

object

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.

Properties

`name`	string	The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
`kind`	string	The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
`id`	string	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.


                        partitionId

PartitionId

Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.


                        PartitionId

object

A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty.

A partition ID contains several dimensions: project ID and namespace ID.

Partition dimensions:

May be "".
Must be valid UTF-8 bytes.
Must have values that match regex [A-Za-z\d\.\-_]{1,100} If the value of any dimension matches regex __.*__, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts.

Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state.

Properties

`projectId`	string	The ID of the project to which the entities belong.
`namespaceId`	string	If not empty, the ID of the namespace to which the entities belong.


                        integerValue

string

An integer value.


                        geoPointValue

LatLng

A geo point value representing a point on the surface of Earth.


                        LatLng

object

Properties

`longitude`	double	The longitude in degrees. It must be in the range [-180.0, +180.0].
`latitude`	double	The latitude in degrees. It must be in the range [-90.0, +90.0].


                        excludeFromIndexes

boolean

If the value should be excluded from all indexes including those defined explicitly.


                        entityValue

Entity

An entity value.

May have no key.
May have a key with an incomplete key path.
May have a reserved/read-only key.


                        Entity

object

A Datastore data object.

An entity is limited to 1 megabyte when stored. That roughly corresponds to a limit of 1 megabyte for the serialized form of this message.

Properties


                        properties

object

key

Key

The entity's key.

Key

object

Properties

`path`	array [PathElement]	The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: all of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements.
`partitionId`	PartitionId	Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.


                        doubleValue

double

A double value.


                        booleanValue

boolean

A boolean value.


                        blobValue

byte

A blob value. May have at most 1,000,000 bytes. When exclude_from_indexes is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded.


                        arrayValue

ArrayValue

An array value. Cannot contain another array value. A Value instance that sets field array_value must not set fields meaning or exclude_from_indexes.


                        ArrayValue

object

An array value.

Properties


                        values

array [Value]

Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'.


                        Value

object

A message that can hold any of the supported value types and associated metadata.

Properties

`timestampValue`	string	A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down.
`stringValue`	string	A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at least 1,000,000 bytes.
`nullValue`	string Allowed values: - `NULL_VALUE`	A null value.
`meaning`	integer	The `meaning` field should only be populated for backwards compatibility.
`keyValue`	Key	A key value.
`integerValue`	string	An integer value.
`geoPointValue`	LatLng	A geo point value representing a point on the surface of Earth.
`excludeFromIndexes`	boolean	If the value should be excluded from all indexes including those defined explicitly.
`entityValue`	Entity	An entity value. May have no key. May have a key with an incomplete key path. May have a reserved/read-only key.
`doubleValue`	double	A double value.
`booleanValue`	boolean	A boolean value.
`blobValue`	byte	A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded.
`arrayValue`	ArrayValue	An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`.


                        property

PropertyReference

The property to filter by.


                        PropertyReference

object

A reference to a property relative to the kind expressions.

Properties


                        name

string

The name of the property. If name includes "."s, it may be interpreted as a property name path.

op

string
Allowed values:
- OPERATOR_UNSPECIFIED
- LESS_THAN
- LESS_THAN_OR_EQUAL
- GREATER_THAN
- GREATER_THAN_OR_EQUAL
- EQUAL
- HAS_ANCESTOR

The operator to filter by.

PropertyOrder

PropertyReference

Query

A query for entities.

Properties

Name Data Type Description


                        startCursor

byte

A starting point for the query results. Query cursors are returned in query result batches and can only be used to continue the same query.


                        projection

array [Projection]

The projection to return. Defaults to returning all properties.


                        Projection

object

A representation of a property in a projection.

Properties


                        property

PropertyReference

The property to project.


                        PropertyReference

object

A reference to a property relative to the kind expressions.

Properties


                        name

string

The name of the property. If name includes "."s, it may be interpreted as a property name path.


                        order

array [PropertyOrder]

The order to apply to the query results (if empty, order is unspecified).


                        PropertyOrder

object

The desired order for a specific property.

Properties


                        property

PropertyReference

The property to order by.


                        PropertyReference

object

A reference to a property relative to the kind expressions.

Properties


                        name

string

The name of the property. If name includes "."s, it may be interpreted as a property name path.


                        direction

string
Allowed values:
- DIRECTION_UNSPECIFIED
- ASCENDING
- DESCENDING

The direction to order by. Defaults to ASCENDING.


                        offset

integer

The number of results to skip. Applies before limit, but after all other constraints. Optional. Must be >= 0 if specified.


                        limit

integer

The maximum number of results to return. Applies after all other constraints. Optional. Unspecified is interpreted as no limit. Must be >= 0 if specified.


                        kind

array [KindExpression]

The kinds to query (if empty, returns entities of all kinds). Currently at most 1 kind may be specified.


                        KindExpression

object

A representation of a kind.

Properties


                        name

string

The name of the kind.


                        filter

Filter

The filter to apply.


                        Filter

object

A holder for any type of filter.

Properties


                        propertyFilter

PropertyFilter

A filter on a property.


                        PropertyFilter

object

A filter on a specific property.

Properties


                        value

Value

The value to compare the property to.


                        Value

object

A message that can hold any of the supported value types and associated metadata.

Properties

`timestampValue`	string	A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down.
`stringValue`	string	A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at least 1,000,000 bytes.
`nullValue`	string Allowed values: - `NULL_VALUE`	A null value.
`meaning`	integer	The `meaning` field should only be populated for backwards compatibility.
`keyValue`	Key	A key value.
`integerValue`	string	An integer value.
`geoPointValue`	LatLng	A geo point value representing a point on the surface of Earth.
`excludeFromIndexes`	boolean	If the value should be excluded from all indexes including those defined explicitly.
`entityValue`	Entity	An entity value. May have no key. May have a key with an incomplete key path. May have a reserved/read-only key.
`doubleValue`	double	A double value.
`booleanValue`	boolean	A boolean value.
`blobValue`	byte	A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded.
`arrayValue`	ArrayValue	An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`.


                        property

PropertyReference

The property to filter by.


                        PropertyReference

object

A reference to a property relative to the kind expressions.

Properties


                        name

string

The name of the property. If name includes "."s, it may be interpreted as a property name path.

op

string
Allowed values:
- OPERATOR_UNSPECIFIED
- LESS_THAN
- LESS_THAN_OR_EQUAL
- GREATER_THAN
- GREATER_THAN_OR_EQUAL
- EQUAL
- HAS_ANCESTOR

The operator to filter by.


                        compositeFilter

CompositeFilter

A composite filter.


                        CompositeFilter

object

A filter that merges multiple other filters using the given operator.

Properties

op

string
Allowed values:
- OPERATOR_UNSPECIFIED
- AND

The operator for combining multiple filters.


                        filters

array [Filter]

The list of filters to combine. Must contain at least one filter.


                        Filter

object

A holder for any type of filter.

Properties

`propertyFilter`	PropertyFilter	A filter on a property.
`compositeFilter`	CompositeFilter	A composite filter.


                        endCursor

byte

An ending point for the query results. Query cursors are returned in query result batches and can only be used to limit the same query.


                        distinctOn

array [PropertyReference]

The properties to make distinct. The query results will contain the first result for each distinct combination of values for the given properties (if empty, all results are returned).


                        PropertyReference

object

A reference to a property relative to the kind expressions.

Properties


                        name

string

The name of the property. If name includes "."s, it may be interpreted as a property name path.

QueryResultBatch

A batch of results produced by a query.

Properties

Name Data Type Description


                        snapshotVersion

string

The version number of the snapshot this batch was returned from. This applies to the range of results from the query's start_cursor (or the beginning of the query if no cursor was given) to this batch's end_cursor (not the query's end_cursor).

In a single transaction, subsequent query result batches for the same query can have a greater snapshot version number. Each batch's snapshot version is valid for all preceding batches. The value will be zero for eventually consistent queries.


                        skippedResults

integer

The number of results skipped, typically because of an offset.


                        skippedCursor

byte

A cursor that points to the position after the last skipped result. Will be set when skipped_results != 0.


                        moreResults

string
Allowed values:
- MORE_RESULTS_TYPE_UNSPECIFIED
- NOT_FINISHED
- MORE_RESULTS_AFTER_LIMIT
- MORE_RESULTS_AFTER_CURSOR
- NO_MORE_RESULTS

The state of the query after the current batch.


                        entityResults

array [EntityResult]

The results for this batch.


                        EntityResult

object

The result of fetching an entity from Datastore.

Properties


                        version

string

The version of the entity, a strictly positive number that monotonically increases with changes to the entity.

This field is set for FULL entity results.

For missing entities in LookupResponse, this is the version of the snapshot that was used to look up the entity, and it is always set except for eventually consistent reads.


                        entity

Entity

The resulting entity.


                        Entity

object

A Datastore data object.

An entity is limited to 1 megabyte when stored. That roughly corresponds to a limit of 1 megabyte for the serialized form of this message.

Properties


                        properties

object

key

Key

The entity's key.

Key

object

Properties

`path`	array [PathElement]	The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: all of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements.
`partitionId`	PartitionId	Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.


                        cursor

byte

A cursor that points to the position after the result entity. Set only when the EntityResult is part of a QueryResultBatch message.


                        entityResultType

string
Allowed values:
- RESULT_TYPE_UNSPECIFIED
- FULL
- PROJECTION
- KEY_ONLY

The result type for every entity in entity_results.


                        endCursor

byte

A cursor that points to the position after the last result in the batch.

ReadOnly

ReadOptions

ReadWrite

ReserveIdsRequest

The request for Datastore.ReserveIds.

Properties

Name Data Type Description


                        keys

array [Key]

Required. A list of keys with complete key paths whose numeric IDs should not be auto-allocated.

Key

object

Properties


                        path

array [PathElement]

A path can never be empty, and a path can have at most 100 elements.


                        PathElement

object

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.

Properties

`name`	string	The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
`kind`	string	The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
`id`	string	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.


                        partitionId

PartitionId

Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.


                        PartitionId

object

A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty.

A partition ID contains several dimensions: project ID and namespace ID.

Partition dimensions:

May be "".
Must be valid UTF-8 bytes.
Must have values that match regex [A-Za-z\d\.\-_]{1,100} If the value of any dimension matches regex __.*__, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts.

Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state.

Properties

`projectId`	string	The ID of the project to which the entities belong.
`namespaceId`	string	If not empty, the ID of the namespace to which the entities belong.


                        databaseId

string

If not empty, the ID of the database against which to make the request.

ReserveIdsResponse

RollbackRequest

RollbackResponse

RunQueryRequest

The request for Datastore.RunQuery.

Properties

Name Data Type Description


                        readOptions

ReadOptions

The options for this query.


                        ReadOptions

object

The options shared by read requests.

Properties

`transaction`	byte	The identifier of the transaction in which to read. A transaction identifier is returned by a call to Datastore.BeginTransaction.
`readConsistency`	string Allowed values: - `READ_CONSISTENCY_UNSPECIFIED` - `STRONG` - `EVENTUAL`	The non-transactional read consistency to use. Cannot be set to `STRONG` for global queries.


                        query

Query

The query to run.


                        Query

object

A query for entities.

Properties


                        startCursor

byte

A starting point for the query results. Query cursors are returned in query result batches and can only be used to continue the same query.


                        projection

array [Projection]

The projection to return. Defaults to returning all properties.


                        Projection

object

A representation of a property in a projection.

Properties


                        property

PropertyReference

The property to project.


                        PropertyReference

object

A reference to a property relative to the kind expressions.

Properties


                        name

string

The name of the property. If name includes "."s, it may be interpreted as a property name path.


                        order

array [PropertyOrder]

The order to apply to the query results (if empty, order is unspecified).


                        PropertyOrder

object

The desired order for a specific property.

Properties


                        property

PropertyReference

The property to order by.


                        PropertyReference

object

A reference to a property relative to the kind expressions.

Properties


                        name

string

The name of the property. If name includes "."s, it may be interpreted as a property name path.


                        direction

string
Allowed values:
- DIRECTION_UNSPECIFIED
- ASCENDING
- DESCENDING

The direction to order by. Defaults to ASCENDING.


                        offset

integer

The number of results to skip. Applies before limit, but after all other constraints. Optional. Must be >= 0 if specified.


                        limit

integer

The maximum number of results to return. Applies after all other constraints. Optional. Unspecified is interpreted as no limit. Must be >= 0 if specified.


                        kind

array [KindExpression]

The kinds to query (if empty, returns entities of all kinds). Currently at most 1 kind may be specified.


                        KindExpression

object

A representation of a kind.

Properties


                        name

string

The name of the kind.


                        filter

Filter

The filter to apply.


                        Filter

object

A holder for any type of filter.

Properties


                        propertyFilter

PropertyFilter

A filter on a property.


                        PropertyFilter

object

A filter on a specific property.

Properties

`value`	Value	The value to compare the property to.
`property`	PropertyReference	The property to filter by.
`op`	string Allowed values: - `OPERATOR_UNSPECIFIED` - `LESS_THAN` - `LESS_THAN_OR_EQUAL` - `GREATER_THAN` - `GREATER_THAN_OR_EQUAL` - `EQUAL` - `HAS_ANCESTOR`	The operator to filter by.


                        compositeFilter

CompositeFilter

A composite filter.


                        CompositeFilter

object

A filter that merges multiple other filters using the given operator.

Properties

`op`	string Allowed values: - `OPERATOR_UNSPECIFIED` - `AND`	The operator for combining multiple filters.
`filters`	array [Filter]	The list of filters to combine. Must contain at least one filter.


                        endCursor

byte

An ending point for the query results. Query cursors are returned in query result batches and can only be used to limit the same query.


                        distinctOn

array [PropertyReference]

The properties to make distinct. The query results will contain the first result for each distinct combination of values for the given properties (if empty, all results are returned).


                        PropertyReference

object

A reference to a property relative to the kind expressions.

Properties


                        name

string

The name of the property. If name includes "."s, it may be interpreted as a property name path.


                        partitionId

PartitionId

Entities are partitioned into subsets, identified by a partition ID. Queries are scoped to a single partition. This partition ID is normalized with the standard default context partition ID.


                        PartitionId

object

A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty.

A partition ID contains several dimensions: project ID and namespace ID.

Partition dimensions:

May be "".
Must be valid UTF-8 bytes.
Must have values that match regex [A-Za-z\d\.\-_]{1,100} If the value of any dimension matches regex __.*__, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts.

Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state.

Properties

`projectId`	string	The ID of the project to which the entities belong.
`namespaceId`	string	If not empty, the ID of the namespace to which the entities belong.


                        gqlQuery

GqlQuery

The GQL query to run.


                        GqlQuery

object

A GQL query.

Properties


                        queryString

string

A string of the format described here.


                        positionalBindings

array [GqlQueryParameter]

Numbered binding site @1 references the first numbered parameter, effectively using 1-based indexing, rather than the usual 0.

For each binding site numbered i in query_string, there must be an i-th numbered parameter. The inverse must also be true.


                        GqlQueryParameter

object

A binding parameter for a GQL query.

Properties


                        value

Value

A value parameter.


                        Value

object

A message that can hold any of the supported value types and associated metadata.

Properties

`timestampValue`	string	A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down.
`stringValue`	string	A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at least 1,000,000 bytes.
`nullValue`	string Allowed values: - `NULL_VALUE`	A null value.
`meaning`	integer	The `meaning` field should only be populated for backwards compatibility.
`keyValue`	Key	A key value.
`integerValue`	string	An integer value.
`geoPointValue`	LatLng	A geo point value representing a point on the surface of Earth.
`excludeFromIndexes`	boolean	If the value should be excluded from all indexes including those defined explicitly.
`entityValue`	Entity	An entity value. May have no key. May have a key with an incomplete key path. May have a reserved/read-only key.
`doubleValue`	double	A double value.
`booleanValue`	boolean	A boolean value.
`blobValue`	byte	A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded.
`arrayValue`	ArrayValue	An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`.


                        cursor

byte

A query cursor. Query cursors are returned in query result batches.


                        namedBindings

object

For each non-reserved named binding site in the query string, there must be a named parameter with that name, but not necessarily the inverse.

Key must match regex A-Za-z_$*, must not match regex __.*__, and must not be "".


                        allowLiterals

boolean

RunQueryResponse

The response for Datastore.RunQuery.

Properties

Name Data Type Description


                        query

Query

The parsed form of the GqlQuery from the request, if it was set.


                        Query

object

A query for entities.

Properties


                        startCursor

byte

A starting point for the query results. Query cursors are returned in query result batches and can only be used to continue the same query.


                        projection

array [Projection]

The projection to return. Defaults to returning all properties.


                        Projection

object

A representation of a property in a projection.

Properties


                        property

PropertyReference

The property to project.


                        PropertyReference

object

A reference to a property relative to the kind expressions.

Properties


                        name

string

The name of the property. If name includes "."s, it may be interpreted as a property name path.


                        order

array [PropertyOrder]

The order to apply to the query results (if empty, order is unspecified).


                        PropertyOrder

object

The desired order for a specific property.

Properties


                        property

PropertyReference

The property to order by.


                        PropertyReference

object

A reference to a property relative to the kind expressions.

Properties


                        name

string

The name of the property. If name includes "."s, it may be interpreted as a property name path.


                        direction

string
Allowed values:
- DIRECTION_UNSPECIFIED
- ASCENDING
- DESCENDING

The direction to order by. Defaults to ASCENDING.


                        offset

integer

The number of results to skip. Applies before limit, but after all other constraints. Optional. Must be >= 0 if specified.


                        limit

integer

The maximum number of results to return. Applies after all other constraints. Optional. Unspecified is interpreted as no limit. Must be >= 0 if specified.


                        kind

array [KindExpression]

The kinds to query (if empty, returns entities of all kinds). Currently at most 1 kind may be specified.


                        KindExpression

object

A representation of a kind.

Properties


                        name

string

The name of the kind.


                        filter

Filter

The filter to apply.


                        Filter

object

A holder for any type of filter.

Properties


                        propertyFilter

PropertyFilter

A filter on a property.


                        PropertyFilter

object

A filter on a specific property.

Properties

`value`	Value	The value to compare the property to.
`property`	PropertyReference	The property to filter by.
`op`	string Allowed values: - `OPERATOR_UNSPECIFIED` - `LESS_THAN` - `LESS_THAN_OR_EQUAL` - `GREATER_THAN` - `GREATER_THAN_OR_EQUAL` - `EQUAL` - `HAS_ANCESTOR`	The operator to filter by.


                        compositeFilter

CompositeFilter

A composite filter.


                        CompositeFilter

object

A filter that merges multiple other filters using the given operator.

Properties

`op`	string Allowed values: - `OPERATOR_UNSPECIFIED` - `AND`	The operator for combining multiple filters.
`filters`	array [Filter]	The list of filters to combine. Must contain at least one filter.


                        endCursor

byte

An ending point for the query results. Query cursors are returned in query result batches and can only be used to limit the same query.


                        distinctOn

array [PropertyReference]

The properties to make distinct. The query results will contain the first result for each distinct combination of values for the given properties (if empty, all results are returned).


                        PropertyReference

object

A reference to a property relative to the kind expressions.

Properties


                        name

string

The name of the property. If name includes "."s, it may be interpreted as a property name path.


                        batch

QueryResultBatch

A batch of query results (always present).


                        QueryResultBatch

object

A batch of results produced by a query.

Properties


                        snapshotVersion

string


                        skippedResults

integer

The number of results skipped, typically because of an offset.


                        skippedCursor

byte

A cursor that points to the position after the last skipped result. Will be set when skipped_results != 0.


                        moreResults

string
Allowed values:
- MORE_RESULTS_TYPE_UNSPECIFIED
- NOT_FINISHED
- MORE_RESULTS_AFTER_LIMIT
- MORE_RESULTS_AFTER_CURSOR
- NO_MORE_RESULTS

The state of the query after the current batch.


                        entityResults

array [EntityResult]

The results for this batch.


                        EntityResult

object

The result of fetching an entity from Datastore.

Properties


                        version

string

The version of the entity, a strictly positive number that monotonically increases with changes to the entity.

This field is set for FULL entity results.

For missing entities in LookupResponse, this is the version of the snapshot that was used to look up the entity, and it is always set except for eventually consistent reads.


                        entity

Entity

The resulting entity.


                        Entity

object

A Datastore data object.

An entity is limited to 1 megabyte when stored. That roughly corresponds to a limit of 1 megabyte for the serialized form of this message.

Properties

`properties`	object	The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`.
`key`	Key	The entity's key. An entity must have a key, unless otherwise documented (for example, an entity in `Value.entity_value` may have no key). An entity's kind is its key path's last element's kind, or null if it has no key.


                        cursor

byte

A cursor that points to the position after the result entity. Set only when the EntityResult is part of a QueryResultBatch message.


                        entityResultType

string
Allowed values:
- RESULT_TYPE_UNSPECIFIED
- FULL
- PROJECTION
- KEY_ONLY

The result type for every entity in entity_results.


                        endCursor

byte

A cursor that points to the position after the last result in the batch.

Status

TransactionOptions

Options for beginning a new transaction.

Transactions can be created explicitly with calls to Datastore.BeginTransaction or implicitly by setting ReadOptions.new_transaction in read requests.

Properties

Name Data Type Description


                        readWrite

ReadWrite

The transaction should allow both reads and writes.


                        ReadWrite

object

Options specific to read / write transactions.

Properties


                        previousTransaction

byte

The transaction identifier of the transaction being retried.


                        readOnly

ReadOnly

The transaction should only allow reads.


                        ReadOnly

object

Options specific to read-only transactions.

Value

A message that can hold any of the supported value types and associated metadata.

Properties

Name Data Type Description


                        timestampValue

string

A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down.


                        stringValue

string

A UTF-8 encoded string value. When exclude_from_indexes is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at least 1,000,000 bytes.


                        nullValue

string
Allowed values:
- NULL_VALUE

A null value.


                        meaning

integer

The meaning field should only be populated for backwards compatibility.


                        keyValue

Key

A key value.

Key

object

Properties


                        path

array [PathElement]

A path can never be empty, and a path can have at most 100 elements.


                        PathElement

object

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.

Properties

`name`	string	The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
`kind`	string	The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
`id`	string	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.


                        partitionId

PartitionId

Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.


                        PartitionId

object

A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty.

A partition ID contains several dimensions: project ID and namespace ID.

Partition dimensions:

May be "".
Must be valid UTF-8 bytes.
Must have values that match regex [A-Za-z\d\.\-_]{1,100} If the value of any dimension matches regex __.*__, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts.

Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state.

Properties

`projectId`	string	The ID of the project to which the entities belong.
`namespaceId`	string	If not empty, the ID of the namespace to which the entities belong.


                        integerValue

string

An integer value.


                        geoPointValue

LatLng

A geo point value representing a point on the surface of Earth.


                        LatLng

object

Properties

`longitude`	double	The longitude in degrees. It must be in the range [-180.0, +180.0].
`latitude`	double	The latitude in degrees. It must be in the range [-90.0, +90.0].


                        excludeFromIndexes

boolean

If the value should be excluded from all indexes including those defined explicitly.


                        entityValue

Entity

An entity value.

May have no key.
May have a key with an incomplete key path.
May have a reserved/read-only key.


                        Entity

object

A Datastore data object.

An entity is limited to 1 megabyte when stored. That roughly corresponds to a limit of 1 megabyte for the serialized form of this message.

Properties


                        properties

object

key

Key

The entity's key.

Key

object

Properties


                        path

array [PathElement]

A path can never be empty, and a path can have at most 100 elements.


                        PathElement

object

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.

Properties

`name`	string	The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
`kind`	string	The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
`id`	string	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.


                        partitionId

PartitionId

Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.


                        PartitionId

object

A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty.

A partition ID contains several dimensions: project ID and namespace ID.

Partition dimensions:

May be "".
Must be valid UTF-8 bytes.
Must have values that match regex [A-Za-z\d\.\-_]{1,100} If the value of any dimension matches regex __.*__, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts.

Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state.

Properties

`projectId`	string	The ID of the project to which the entities belong.
`namespaceId`	string	If not empty, the ID of the namespace to which the entities belong.


                        doubleValue

double

A double value.


                        booleanValue

boolean

A boolean value.


                        blobValue

byte

A blob value. May have at most 1,000,000 bytes. When exclude_from_indexes is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded.


                        arrayValue

ArrayValue

An array value. Cannot contain another array value. A Value instance that sets field array_value must not set fields meaning or exclude_from_indexes.


                        ArrayValue

object

An array value.

Properties


                        values

array [Value]

Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'.


                        Value

object

A message that can hold any of the supported value types and associated metadata.

Properties


                        timestampValue

string

A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down.


                        stringValue

string

A UTF-8 encoded string value. When exclude_from_indexes is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at least 1,000,000 bytes.


                        nullValue

string
Allowed values:
- NULL_VALUE

A null value.


                        meaning

integer

The meaning field should only be populated for backwards compatibility.


                        keyValue

Key

A key value.

Key

object

Properties

`path`	array [PathElement]	The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: all of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements.
`partitionId`	PartitionId	Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.


                        integerValue

string

An integer value.


                        geoPointValue

LatLng

A geo point value representing a point on the surface of Earth.


                        LatLng

object

Properties

`longitude`	double	The longitude in degrees. It must be in the range [-180.0, +180.0].
`latitude`	double	The latitude in degrees. It must be in the range [-90.0, +90.0].


                        excludeFromIndexes

boolean

If the value should be excluded from all indexes including those defined explicitly.


                        entityValue

Entity

An entity value.

May have no key.
May have a key with an incomplete key path.
May have a reserved/read-only key.


                        Entity

object

A Datastore data object.

An entity is limited to 1 megabyte when stored. That roughly corresponds to a limit of 1 megabyte for the serialized form of this message.

Properties

`properties`	object	The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`.
`key`	Key	The entity's key. An entity must have a key, unless otherwise documented (for example, an entity in `Value.entity_value` may have no key). An entity's kind is its key path's last element's kind, or null if it has no key.


                        doubleValue

double

A double value.


                        booleanValue

boolean

A boolean value.


                        blobValue

byte

A blob value. May have at most 1,000,000 bytes. When exclude_from_indexes is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded.


                        arrayValue

ArrayValue

An array value. Cannot contain another array value. A Value instance that sets field array_value must not set fields meaning or exclude_from_indexes.


                        ArrayValue

object

An array value.

Properties


                        values

array [Value]

Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'.

Authentication

Oauth2

'OAuth' Authentication Scheme
Reference: RFC5849, Section 3.5.1

Oauth 2.0 accessCode authentication

Flow: authorizationCode
Authorization URL: https://accounts.google.com/o/oauth2/auth
Token URL: https://accounts.google.com/o/oauth2/token
Scopes:

https://www.googleapis.com/auth/datastore: View and manage your Google Cloud Datastore data
https://www.googleapis.com/auth/cloud-platform: View and manage your data across Google Cloud Platform services

Oauth2

'OAuth' Authentication Scheme
Reference: RFC5849, Section 3.5.1

Oauth 2.0 implicit authentication

Flow: implicit
Authorization URL: https://accounts.google.com/o/oauth2/auth
Scopes:

https://www.googleapis.com/auth/datastore: View and manage your Google Cloud Datastore data
https://www.googleapis.com/auth/cloud-platform: View and manage your data across Google Cloud Platform services

Contact

Name	`Google`
External URL	`https://google.com`

Metadata (Technical Details)

OAS (OpenAPI Specification) v3.0.0

Comments

Loading comments ...