Package google.datastore.admin.v1

Index

DatastoreAdmin

Google Cloud Datastore Admin API

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


Concepts

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

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

EntityFilter: Allows specifying a subset of entities in a project. This is specified as a combination of kinds and namespaces (either or both of which may be all).


Services

Export/Import

The Export/Import service provides the ability to copy all or a subset of entities to/from Google Cloud Storage.

Exported data may be imported into Cloud Datastore for any Google Cloud Platform project. It is not restricted to the export source project. It is possible to export from one project and then import into another.

Exported data can also be loaded into Google BigQuery for analysis.

Exports and imports are performed asynchronously. An Operation resource is created for each export/import. The state (including any errors encountered) of the export/import may be queried via the Operation resource.

Index

The index service manages Cloud Datastore composite indexes.

Index creation and deletion are performed asynchronously. An Operation resource is created for each such asynchronous operation. The state of the operation (including any errors encountered) may be queried via the Operation resource.

Operation

The Operations collection provides a record of actions performed for the specified project (including any operations in progress). Operations are not created directly but through calls on other collections or resources.

An operation that is not yet done may be cancelled. The request to cancel is asynchronous and the operation may continue to run for some time after the request to cancel is made.

An operation that is done may be deleted so that it is no longer listed as part of the Operation collection.

ListOperations returns all pending operations, but not completed operations.

Operations are created by service DatastoreAdmin, but are accessed via service google.longrunning.Operations.

ExportEntities

rpc ExportEntities(ExportEntitiesRequest) returns (Operation)

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.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

GetIndex

rpc GetIndex(GetIndexRequest) returns (Index)

Gets an index.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

ImportEntities

rpc ImportEntities(ImportEntitiesRequest) returns (Operation)

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.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

ListIndexes

rpc ListIndexes(ListIndexesRequest) returns (ListIndexesResponse)

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.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

CommonMetadata

Metadata common to all Datastore Admin operations.

Fields
start_time

Timestamp

The time that work began on the operation.

end_time

Timestamp

The time the operation ended, either successfully or otherwise.

operation_type

OperationType

The type of the operation. Can be used as a filter in ListOperationsRequest.

labels

map<string, string>

The client-assigned labels which were provided when the operation was created. May also include additional labels.

state

State

The current state of the Operation.

State

The various possible states for an ongoing Operation.

Enums
STATE_UNSPECIFIED Unspecified.
INITIALIZING Request is being prepared for processing.
PROCESSING Request is actively being processed.
CANCELLING Request is in the process of being cancelled after user called google.longrunning.Operations.CancelOperation on the operation.
FINALIZING Request has been processed and is in its finalization stage.
SUCCESSFUL Request has completed successfully.
FAILED Request has finished being processed, but encountered an error.
CANCELLED Request has finished being cancelled after user called google.longrunning.Operations.CancelOperation.

EntityFilter

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']

Fields
kinds[]

string

If empty, then this represents all kinds.

namespace_ids[]

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.

ExportEntitiesMetadata

Metadata for ExportEntities operations.

Fields
common

CommonMetadata

Metadata common to all Datastore Admin operations.

progress_entities

Progress

An estimate of the number of entities processed.

progress_bytes

Progress

An estimate of the number of bytes processed.

entity_filter

EntityFilter

Description of which entities are being exported.

output_url_prefix

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.

ExportEntitiesRequest

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

Fields
project_id

string

Project ID against which to make the request.

database_id

string

Database ID against which to make the request. Unset indicates the default database. Not currently supported.

labels

map<string, string>

Client-assigned labels.

entity_filter

EntityFilter

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

output_url_prefix

string

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.

ExportEntitiesResponse

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

Fields
output_url

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.

GetIndexRequest

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

Fields
project_id

string

Project ID against which to make the request.

database_id

string

Database ID against which to make the request. Unset indicates the default database. Not currently supported.

index_id

string

The resource ID of the index to get.

ImportEntitiesMetadata

Metadata for ImportEntities operations.

Fields
common

CommonMetadata

Metadata common to all Datastore Admin operations.

progress_entities

Progress

An estimate of the number of entities processed.

progress_bytes

Progress

An estimate of the number of bytes processed.

entity_filter

EntityFilter

Description of which entities are being imported.

input_url

string

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

ImportEntitiesRequest

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

Fields
project_id

string

Project ID against which to make the request.

database_id

string

Database ID against which to make the request. Unset indicates the default database. Not currently supported.

labels

map<string, string>

Client-assigned labels.

input_url

string

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.

entity_filter

EntityFilter

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.

Index

A minimal index definition. Next tag: 8

Fields
project_id

string

Project ID. Output only.

database_id

string

Database ID. Not currently supported. Output only.

index_id

string

The resource ID of the index. Output only.

kind

string

The entity kind to which this index applies. Required.

ancestor

AncestorMode

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

properties[]

IndexedProperty

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

state

State

The state of the index. Output only.

AncestorMode

For an ordered index, specifies whether each of the entity's ancestors will be included.

Enums
ANCESTOR_MODE_UNSPECIFIED The ancestor mode is unspecified.
NONE Do not include the entity's ancestors in the index.
ALL_ANCESTORS Include all the entity's ancestors in the index.

Direction

The direction determines how a property is indexed.

Enums
DIRECTION_UNSPECIFIED The direction is unspecified.
ASCENDING The property's values are indexed so as to support sequencing in ascending order and also query by <, >, <=, >=, and =.
DESCENDING The property's values are indexed so as to support sequencing in descending order and also query by <, >, <=, >=, and =.

IndexedProperty

Next tag: 3

Fields
name

string

The property name to index. Required.

direction

Direction

The indexed property's direction. Must not be DIRECTION_UNSPECIFIED. Required.

State

The possible set of states of an index.

Enums
STATE_UNSPECIFIED The state is unspecified.
CREATING The index is being created, and cannot be used by queries. There is an active long-running operation for the index. The index is updated when writing an entity. Some index data may exist.
READY The index is ready to be used. The index is updated when writing an entity. The index is fully populated from all stored entities it applies to.
DELETING The index is being deleted, and cannot be used by queries. There is an active long-running operation for the index. The index is not updated when writing an entity. Some index data may exist.
ERROR The index was being created or deleted, but something went wrong. The index cannot by used by queries. There is no active long-running operation for the index, and the most recently finished long-running operation failed. The index is not updated when writing an entity. Some index data may exist.

IndexOperationMetadata

Metadata for Index operations.

Fields
common

CommonMetadata

Metadata common to all Datastore Admin operations.

progress_entities

Progress

An estimate of the number of entities processed.

index_id

string

The index resource ID that this operation is acting on.

ListIndexesRequest

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

Fields
project_id

string

Project ID against which to make the request.

database_id

string

Database ID against which to make the request. Unset indicates the default database. Not currently supported.

filter

string

page_size

int32

The maximum number of items to return. If zero, then all results will be returned.

page_token

string

The next_page_token value returned from a previous List request, if any.

ListIndexesResponse

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

Fields
indexes[]

Index

The indexes.

next_page_token

string

The standard List next-page token.

OperationType

Operation types.

Enums
OPERATION_TYPE_UNSPECIFIED Unspecified.
EXPORT_ENTITIES ExportEntities.
IMPORT_ENTITIES ImportEntities.
CREATE_INDEX CreateIndex.
DELETE_INDEX DeleteIndex.

Progress

Measures the progress of a particular metric.

Fields
work_completed

int64

The amount of work that has been completed. Note that this may be greater than work_estimated.

work_estimated

int64

An estimate of how much work needs to be performed. May be zero if the work estimate is unavailable.

Was this page helpful? Let us know how we did:

Send feedback about...

Cloud Datastore