Accesses the schemaless NoSQL database to provide fully managed, robust, scalable storage for your application.
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.
Name | Data Type | Description |
---|---|---|
indexId
|
string |
The resource ID of the index to delete. |
projectId
|
string |
Project ID against which to make the request. |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
GoogleLongrunningOperation | ||||||||||||||||||||||||||||||||||||
Properties
|
Gets an index.
Name | Data Type | Description |
---|---|---|
indexId
|
string |
The resource ID of the index to get. |
projectId
|
string |
Project ID against which to make the request. |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
GoogleDatastoreAdminV1Index | ||||||||||||||||||||||||||||||||||||
Properties
|
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.
Name | Data Type | Description |
---|---|---|
projectId
|
string |
Project ID against which to make the request. |
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 |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
GoogleDatastoreAdminV1ListIndexesResponse | ||||||||||||||||||||||||||||||||||||
Properties
|
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.
Name | Data Type | Description |
---|---|---|
projectId
|
string |
Project ID against which to make the request. |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
GoogleDatastoreAdminV1Index | ||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
GoogleLongrunningOperation | ||||||||||||||||||||||||||||||||||||
Properties
|
Allocates IDs for the given keys, which is useful for referencing an entity before it is inserted.
Name | Data Type | Description |
---|---|---|
projectId
|
string |
Required. The ID of the project against which to make the request. |
Name | Data Type | Description | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
AllocateIdsRequest | |||||||||||||||||||||
Properties
|
Name | Data Type | Description | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
AllocateIdsResponse | |||||||||||||||||||||
Properties
|
Begins a new transaction.
Name | Data Type | Description |
---|---|---|
projectId
|
string |
Required. The ID of the project against which to make the request. |
Name | Data Type | Description | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
BeginTransactionRequest | |||||||||||||||||||||
Properties
|
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
BeginTransactionResponse | ||||||||
Properties
|
Commits a transaction, optionally creating, deleting or modifying some entities.
Name | Data Type | Description |
---|---|---|
projectId
|
string |
Required. The ID of the project against which to make the request. |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
CommitRequest | ||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | ||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
CommitResponse | |||||||||||||||||||||||||||
Properties
|
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.
Name | Data Type | Description |
---|---|---|
projectId
|
string |
Required. Project ID against which to make the request. |
Name | Data Type | Description | ||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
GoogleDatastoreAdminV1ExportEntitiesRequest | |||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
GoogleLongrunningOperation | ||||||||||||||||||||||||||||||||||||
Properties
|
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.
Name | Data Type | Description |
---|---|---|
projectId
|
string |
Required. Project ID against which to make the request. |
Name | Data Type | Description | ||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
GoogleDatastoreAdminV1ImportEntitiesRequest | |||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
GoogleLongrunningOperation | ||||||||||||||||||||||||||||||||||||
Properties
|
Looks up entities by key.
Name | Data Type | Description |
---|---|---|
projectId
|
string |
Required. The ID of the project against which to make the request. |
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
LookupRequest | |||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
LookupResponse | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Prevents the supplied keys' IDs from being auto-allocated by Cloud Datastore.
Name | Data Type | Description |
---|---|---|
projectId
|
string |
Required. The ID of the project against which to make the request. |
Name | Data Type | Description | |||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
ReserveIdsRequest | ||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
|
ReserveIdsResponse | |||||
|
Rolls back a transaction.
Name | Data Type | Description |
---|---|---|
projectId
|
string |
Required. The ID of the project against which to make the request. |
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
RollbackRequest | ||||||||
Properties
|
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
|
RollbackResponse | |||||
|
Queries for entities.
Name | Data Type | Description |
---|---|---|
projectId
|
string |
Required. The ID of the project against which to make the request. |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
RunQueryRequest | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
RunQueryResponse | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
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.
Name | Data Type | Description |
---|---|---|
name
|
string |
The name of the operation's parent resource. |
Name | Data Type | Description |
---|---|---|
pageToken
|
string |
The standard list page token. |
pageSize
|
integer |
The standard list page size. |
filter
|
string |
The standard list filter. |
Name | Data Type | Description | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
GoogleLongrunningListOperationsResponse | |||||||||||||||||||||||||||||||||
Properties
|
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
.
Name | Data Type | Description |
---|---|---|
name
|
string |
The name of the operation resource to be cancelled. |
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
|
Empty | |||||
|
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
.
Name | Data Type | Description |
---|---|---|
name
|
string |
The name of the operation resource to be deleted. |
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
|
Empty | |||||
|
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.
Name | Data Type | Description |
---|---|---|
name
|
string |
The name of the operation resource. |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
GoogleLongrunningOperation | ||||||||||||||||||||||||||||||||||||
Properties
|
The request for Datastore.AllocateIds.
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. |
|||||||||||||||||||||||||||||||||||||||
Properties
|
The response for Datastore.AllocateIds.
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. |
|||||||||||||||||||||||||||||||||||||||
Properties
|
An array value.
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'. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
The request for Datastore.BeginTransaction.
Name | Data Type | Description | |||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
transactionOptions
|
TransactionOptions |
Options for a new transaction. |
|||||||||||||||||||||||||||
Properties
|
The response for Datastore.BeginTransaction.
Name | Data Type | Description |
---|---|---|
transaction
|
byte |
The transaction identifier (always present). |
The request for Datastore.Commit.
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
When mode is |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
mode
|
string Allowed values: - MODE_UNSPECIFIED - TRANSACTIONAL - NON_TRANSACTIONAL |
The type of commit to perform. Defaults to |
The response for Datastore.Commit.
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. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||
indexUpdates
|
integer |
The number of index entries updated during the commit, or zero if none were updated. |
A filter that merges multiple other filters using the given operator.
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. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
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 {}
.
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:
The JSON representation for |
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.
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
properties
|
object |
The entity's properties.
The map's keys are property names.
A property name matching regex |
|||||||||||||||||||||||||||||||||||||||
key
|
Key |
The entity's key. An entity must have a key, unless otherwise documented (for example,
an entity in |
|||||||||||||||||||||||||||||||||||||||
Properties
|
The result of fetching an entity from Datastore.
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 For missing entities in |
||||||||||||||||||||||||||||||||||||||||||||||||||||
entity
|
Entity |
The resulting entity. |
||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
cursor
|
byte |
A cursor that points to the position after the result entity.
Set only when the |
A holder for any type of filter.
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
propertyFilter
|
PropertyFilter |
A filter on a property. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
compositeFilter
|
CompositeFilter |
A composite filter. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Metadata common to all Datastore Admin operations.
Name | Data Type | Description |
---|---|---|
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. |
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']
Name | Data Type | Description |
---|---|---|
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. |
Metadata for ExportEntities operations.
Name | Data Type | Description | |||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
progressEntities
|
GoogleDatastoreAdminV1Progress |
An estimate of the number of entities processed. |
|||||||||||||||||||
Properties
|
|||||||||||||||||||||
progressBytes
|
GoogleDatastoreAdminV1Progress |
An estimate of the number of bytes processed. |
|||||||||||||||||||
Properties
|
|||||||||||||||||||||
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. |
|||||||||||||||||||
Properties
|
|||||||||||||||||||||
common
|
GoogleDatastoreAdminV1CommonMetadata |
Metadata common to all Datastore Admin operations. |
|||||||||||||||||||
Properties
|
The request for google.datastore.admin.v1.DatastoreAdmin.ExportEntities.
Name | Data Type | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
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: 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. |
||||||||||
Properties
|
The response for google.datastore.admin.v1.DatastoreAdmin.ExportEntities.
Name | Data Type | Description |
---|---|---|
outputUrl
|
string |
Location of the output metadata file. This can be used to begin an import into Cloud Datastore (this project or another project). See google.datastore.admin.v1.ImportEntitiesRequest.input_url. Only present if the operation completed successfully. |
Metadata for ImportEntities operations.
Name | Data Type | Description | |||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
progressEntities
|
GoogleDatastoreAdminV1Progress |
An estimate of the number of entities processed. |
|||||||||||||||||||
Properties
|
|||||||||||||||||||||
progressBytes
|
GoogleDatastoreAdminV1Progress |
An estimate of the number of bytes processed. |
|||||||||||||||||||
Properties
|
|||||||||||||||||||||
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. |
|||||||||||||||||||
Properties
|
|||||||||||||||||||||
common
|
GoogleDatastoreAdminV1CommonMetadata |
Metadata common to all Datastore Admin operations. |
|||||||||||||||||||
Properties
|
The request for google.datastore.admin.v1.DatastoreAdmin.ImportEntities.
Name | Data Type | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
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:
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. |
||||||||||
Properties
|
A minimal index definition.
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. |
||||||||||
Properties
|
||||||||||||
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. |
Metadata for Index operations.
Name | Data Type | Description | |||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
progressEntities
|
GoogleDatastoreAdminV1Progress |
An estimate of the number of entities processed. |
|||||||||||||||||||
Properties
|
|||||||||||||||||||||
indexId
|
string |
The index resource ID that this operation is acting on. |
|||||||||||||||||||
common
|
GoogleDatastoreAdminV1CommonMetadata |
Metadata common to all Datastore Admin operations. |
|||||||||||||||||||
Properties
|
A property of an index.
Name | Data Type | Description |
---|---|---|
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. |
The response for google.datastore.admin.v1.DatastoreAdmin.ListIndexes.
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
nextPageToken
|
string |
The standard List next-page token. |
|||||||||||||||||||||||||||||||||||
indexes
|
array [GoogleDatastoreAdminV1Index] |
The indexes. |
|||||||||||||||||||||||||||||||||||
Properties
|
Measures the progress of a particular metric.
Name | Data Type | Description |
---|---|---|
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. |
Metadata common to all Datastore Admin operations.
Name | Data Type | Description |
---|---|---|
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. |
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']
Name | Data Type | Description |
---|---|---|
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. |
Metadata for ExportEntities operations.
Name | Data Type | Description | |||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
progressEntities
|
GoogleDatastoreAdminV1beta1Progress |
An estimate of the number of entities processed. |
|||||||||||||||||||
Properties
|
|||||||||||||||||||||
progressBytes
|
GoogleDatastoreAdminV1beta1Progress |
An estimate of the number of bytes processed. |
|||||||||||||||||||
Properties
|
|||||||||||||||||||||
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. |
|||||||||||||||||||
Properties
|
|||||||||||||||||||||
common
|
GoogleDatastoreAdminV1beta1CommonMetadata |
Metadata common to all Datastore Admin operations. |
|||||||||||||||||||
Properties
|
The response for google.datastore.admin.v1beta1.DatastoreAdmin.ExportEntities.
Name | Data Type | Description |
---|---|---|
outputUrl
|
string |
Location of the output metadata file. This can be used to begin an import into Cloud Datastore (this project or another project). See google.datastore.admin.v1beta1.ImportEntitiesRequest.input_url. Only present if the operation completed successfully. |
Metadata for ImportEntities operations.
Name | Data Type | Description | |||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
progressEntities
|
GoogleDatastoreAdminV1beta1Progress |
An estimate of the number of entities processed. |
|||||||||||||||||||
Properties
|
|||||||||||||||||||||
progressBytes
|
GoogleDatastoreAdminV1beta1Progress |
An estimate of the number of bytes processed. |
|||||||||||||||||||
Properties
|
|||||||||||||||||||||
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. |
|||||||||||||||||||
Properties
|
|||||||||||||||||||||
common
|
GoogleDatastoreAdminV1beta1CommonMetadata |
Metadata common to all Datastore Admin operations. |
|||||||||||||||||||
Properties
|
Measures the progress of a particular metric.
Name | Data Type | Description |
---|---|---|
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. |
The response message for Operations.ListOperations.
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
operations
|
array [GoogleLongrunningOperation] |
A list of operations that matches the specified filter in the request. |
|||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||
nextPageToken
|
string |
The standard List next-page token. |
This resource represents a long-running operation that is the result of a network API call.
Name | Data Type | Description | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
response
|
object |
The normal response of the operation in case of success. If the original
method returns no data on success, such as |
|||||||||||||
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
|
|||||||||||||
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. |
|||||||||||||
Properties
|
|||||||||||||||
done
|
boolean |
If the value is |
A GQL query.
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 |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
allowLiterals
|
boolean |
When false, the query string must not contain any literals and instead must
bind all values. For example,
|
A binding parameter for a GQL query.
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
value
|
Value |
A value parameter. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
cursor
|
byte |
A query cursor. Query cursors are returned in query result batches. |
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.
Name | Data Type | Description | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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 A path can never be empty, and a path can have at most 100 elements. |
|||||||||||||
Properties
|
|||||||||||||||
partitionId
|
PartitionId |
Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. |
|||||||||||||
Properties
|
A representation of a kind.
Name | Data Type | Description |
---|---|---|
name
|
string |
The name of the kind. |
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.
Name | Data Type | Description |
---|---|---|
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]. |
The request for Datastore.Lookup.
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
readOptions
|
ReadOptions |
The options for this lookup request. |
|||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||
keys
|
array [Key] |
Required. Keys of entities to look up. |
|||||||||||||||||||||||||||||||||||||||
Properties
|
The response for Datastore.Lookup.
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
missing
|
array [EntityResult] |
Entities not found as |
|||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||
found
|
array [EntityResult] |
Entities found as |
|||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||
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. |
|||||||||||||||||||||||||||||||||||||||
Properties
|
A mutation to apply to an entity.
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. |
||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
update
|
Entity |
The entity to update. The entity must already exist. Must have a complete key path. |
||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
insert
|
Entity |
The entity to insert. The entity must not already exist. The entity key's final path element may be incomplete. |
||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. |
||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. |
The result of applying a mutation.
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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. |
|||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||
conflictDetected
|
boolean |
Whether a conflict was detected for this mutation. Always false when a conflict detection strategy field is not set in the mutation. |
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:
""
.[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.
Name | Data Type | Description |
---|---|---|
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. |
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.
Name | Data Type | Description |
---|---|---|
name
|
string |
The name of the entity.
A name matching regex |
kind
|
string |
The kind of the entity.
A kind matching regex |
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. |
A representation of a property in a projection.
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
property
|
PropertyReference |
The property to project. |
|||||||
Properties
|
A filter on a specific property.
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
value
|
Value |
The value to compare the property to. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
property
|
PropertyReference |
The property to filter by. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. |
The desired order for a specific property.
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
property
|
PropertyReference |
The property to order by. |
|||||||
Properties
|
|||||||||
direction
|
string Allowed values: - DIRECTION_UNSPECIFIED - ASCENDING - DESCENDING |
The direction to order by. Defaults to |
A reference to a property relative to the kind expressions.
Name | Data Type | Description |
---|---|---|
name
|
string |
The name of the property. If name includes "."s, it may be interpreted as a property name path. |
A query for entities.
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. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
order
|
array [PropertyOrder] |
The order to apply to the query results (if empty, order is unspecified). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
filter
|
Filter |
The filter to apply. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
A batch of results produced by a query.
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 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 |
|||||||||||||||||||||||||||||||||||||||
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. |
|||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||
entityResultType
|
string Allowed values: - RESULT_TYPE_UNSPECIFIED - FULL - PROJECTION - KEY_ONLY |
The result type for every entity in |
|||||||||||||||||||||||||||||||||||||||
endCursor
|
byte |
A cursor that points to the position after the last result in the batch. |
Options specific to read-only transactions.
Name | Data Type | Description |
---|---|---|
ReadOnly
|
object |
Options specific to read-only transactions. |
The options shared by read requests.
Name | Data Type | Description |
---|---|---|
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 |
Options specific to read / write transactions.
Name | Data Type | Description |
---|---|---|
previousTransaction
|
byte |
The transaction identifier of the transaction being retried. |
The request for Datastore.ReserveIds.
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
keys
|
array [Key] |
Required. A list of keys with complete key paths whose numeric IDs should not be auto-allocated. |
|||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||
databaseId
|
string |
If not empty, the ID of the database against which to make the request. |
The response for Datastore.ReserveIds.
Name | Data Type | Description |
---|---|---|
ReserveIdsResponse
|
object |
The response for Datastore.ReserveIds. |
The request for Datastore.Rollback.
Name | Data Type | Description |
---|---|---|
transaction
|
byte |
Required. The transaction identifier, returned by a call to Datastore.BeginTransaction. |
The response for Datastore.Rollback. (an empty message).
Name | Data Type | Description |
---|---|---|
RollbackResponse
|
object |
The response for Datastore.Rollback. (an empty message). |
The request for Datastore.RunQuery.
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
readOptions
|
ReadOptions |
The options for this query. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
query
|
Query |
The query to run. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
gqlQuery
|
GqlQuery |
The GQL query to run. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
The response for Datastore.RunQuery.
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
query
|
Query |
The parsed form of the |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
batch
|
QueryResultBatch |
A batch of query results (always present). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
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.
Name | Data Type | Description |
---|---|---|
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. |
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.
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
readWrite
|
ReadWrite |
The transaction should allow both reads and writes. |
|||||||
Properties
|
|||||||||
readOnly
|
ReadOnly |
The transaction should only allow reads. |
|||||||
|
A message that can hold any of the supported value types and associated metadata.
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 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
nullValue
|
string Allowed values: - NULL_VALUE |
A null value. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
meaning
|
integer |
The |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
keyValue
|
Key |
A key value. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
integerValue
|
string |
An integer value. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
geoPointValue
|
LatLng |
A geo point value representing a point on the surface of Earth. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
excludeFromIndexes
|
boolean |
If the value should be excluded from all indexes including those defined explicitly. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
entityValue
|
Entity |
An entity value.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
doubleValue
|
double |
A double value. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
booleanValue
|
boolean |
A boolean value. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
blobValue
|
byte |
A blob value.
May have at most 1,000,000 bytes.
When |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
arrayValue
|
ArrayValue |
An array value.
Cannot contain another array value.
A |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
'OAuth' Authentication Scheme
Reference: RFC5849, Section 3.5.1
Oauth 2.0 accessCode authentication
Flow:authorizationCode
https://accounts.google.com/o/oauth2/auth
https://accounts.google.com/o/oauth2/token
https://www.googleapis.com/auth/datastore
: View and manage your Google Cloud Datastore datahttps://www.googleapis.com/auth/cloud-platform
: View and manage your data across Google Cloud Platform services
'OAuth' Authentication Scheme
Reference: RFC5849, Section 3.5.1
Oauth 2.0 implicit authentication
Flow:implicit
https://accounts.google.com/o/oauth2/auth
https://www.googleapis.com/auth/datastore
: View and manage your Google Cloud Datastore datahttps://www.googleapis.com/auth/cloud-platform
: View and manage your data across Google Cloud Platform servicesName | Google |
External URL | https://google.com |
OAS (OpenAPI Specification) | v3.0.0 |