public static interface DatastoreAdminGrpc.AsyncServiceGoogle 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.
Methods
createIndex(CreateIndexRequest request, StreamObserver<Operation> responseObserver)
public default void createIndex(CreateIndexRequest request, StreamObserver<Operation> responseObserver) 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]
[google.datastore.admin.v1.DatastoreAdmin.CreateIndex].
Indexes with a single property cannot be created.
| Parameters | |
|---|---|
| Name | Description |
request | CreateIndexRequest |
responseObserver | io.grpc.stub.StreamObserver<Operation> |
deleteIndex(DeleteIndexRequest request, StreamObserver<Operation> responseObserver)
public default void deleteIndex(DeleteIndexRequest request, StreamObserver<Operation> responseObserver) 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.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteIndexRequest |
responseObserver | io.grpc.stub.StreamObserver<Operation> |
exportEntities(ExportEntitiesRequest request, StreamObserver<Operation> responseObserver)
public default void exportEntities(ExportEntitiesRequest request, StreamObserver<Operation> responseObserver)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.
| Parameters | |
|---|---|
| Name | Description |
request | ExportEntitiesRequest |
responseObserver | io.grpc.stub.StreamObserver<Operation> |
getIndex(GetIndexRequest request, StreamObserver<Index> responseObserver)
public default void getIndex(GetIndexRequest request, StreamObserver<Index> responseObserver)Gets an index.
| Parameters | |
|---|---|
| Name | Description |
request | GetIndexRequest |
responseObserver | io.grpc.stub.StreamObserver<Index> |
importEntities(ImportEntitiesRequest request, StreamObserver<Operation> responseObserver)
public default void importEntities(ImportEntitiesRequest request, StreamObserver<Operation> responseObserver)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.
| Parameters | |
|---|---|
| Name | Description |
request | ImportEntitiesRequest |
responseObserver | io.grpc.stub.StreamObserver<Operation> |
listIndexes(ListIndexesRequest request, StreamObserver<ListIndexesResponse> responseObserver)
public default void listIndexes(ListIndexesRequest request, StreamObserver<ListIndexesResponse> responseObserver)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.
| Parameters | |
|---|---|
| Name | Description |
request | ListIndexesRequest |
responseObserver | io.grpc.stub.StreamObserver<ListIndexesResponse> |