Package com.google.cloud.datastore.admin.v1 (2.18.4)

A client to Cloud Datastore API

The interfaces provided are listed below, along with usage samples.

DatastoreAdminClient

Service Description: 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).

Export/Import Service:

- 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 Service:

- 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 Service:

- 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.

Sample for DatastoreAdminClient:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DatastoreAdminClient datastoreAdminClient = DatastoreAdminClient.create()) {
   GetIndexRequest request =
       GetIndexRequest.newBuilder()
           .setProjectId("projectId-894832108")
           .setIndexId("indexId1943291277")
           .build();
   Index response = datastoreAdminClient.getIndex(request);
 }

Classes

DatastoreAdminClient

Service Description: 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).

Export/Import Service:

Index Service:

Operation Service:

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DatastoreAdminClient datastoreAdminClient = DatastoreAdminClient.create()) {
   GetIndexRequest request =
       GetIndexRequest.newBuilder()
           .setProjectId("projectId-894832108")
           .setIndexId("indexId1943291277")
           .build();
   Index response = datastoreAdminClient.getIndex(request);
 }

Note: close() needs to be called on the DatastoreAdminClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

Methods
Method	Description	Method Variants
ExportEntities	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 object method variants only take one parameter, a request object, which must be constructed before the call. exportEntitiesAsync(ExportEntitiesRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. exportEntitiesAsync(String projectId, Map<String, String> labels, EntityFilter entityFilter, String outputUrlPrefix) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. exportEntitiesOperationCallable() exportEntitiesCallable()
ImportEntities	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 object method variants only take one parameter, a request object, which must be constructed before the call. importEntitiesAsync(ImportEntitiesRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. importEntitiesAsync(String projectId, Map<String, String> labels, String inputUrl, EntityFilter entityFilter) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. importEntitiesOperationCallable() importEntitiesCallable()
CreateIndex	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.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createIndexAsync(CreateIndexRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createIndexOperationCallable() createIndexCallable()
DeleteIndex	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 object method variants only take one parameter, a request object, which must be constructed before the call. deleteIndexAsync(DeleteIndexRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deleteIndexOperationCallable() deleteIndexCallable()
GetIndex	Gets an index.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getIndex(GetIndexRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getIndexCallable()
ListIndexes	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 object method variants only take one parameter, a request object, which must be constructed before the call. listIndexes(ListIndexesRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listIndexesPagedCallable() listIndexesCallable()

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of DatastoreAdminSettings to create(). For example:

To customize credentials:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 DatastoreAdminSettings datastoreAdminSettings =
     DatastoreAdminSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 DatastoreAdminClient datastoreAdminClient = DatastoreAdminClient.create(datastoreAdminSettings);

To customize the endpoint:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 DatastoreAdminSettings datastoreAdminSettings =
     DatastoreAdminSettings.newBuilder().setEndpoint(myEndpoint).build();
 DatastoreAdminClient datastoreAdminClient = DatastoreAdminClient.create(datastoreAdminSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 DatastoreAdminSettings datastoreAdminSettings =
     DatastoreAdminSettings.newHttpJsonBuilder().build();
 DatastoreAdminClient datastoreAdminClient = DatastoreAdminClient.create(datastoreAdminSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

The default service address (datastore.googleapis.com) and default port (443) are used.
Credentials are acquired automatically through Application Default Credentials.
Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of getIndex to 30 seconds:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 DatastoreAdminSettings.Builder datastoreAdminSettingsBuilder =
     DatastoreAdminSettings.newBuilder();
 datastoreAdminSettingsBuilder
     .getIndexSettings()
     .setRetrySettings(
         datastoreAdminSettingsBuilder
             .getIndexSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 DatastoreAdminSettings datastoreAdminSettings = datastoreAdminSettingsBuilder.build();

DatastoreAdminSettings.Builder

Builder for DatastoreAdminSettings.

Package com.google.cloud.datastore.admin.v1 (2.18.4)

DatastoreAdminClient

Classes

DatastoreAdminClient

DatastoreAdminClient.ListIndexesFixedSizeCollection

DatastoreAdminClient.ListIndexesPage

DatastoreAdminClient.ListIndexesPagedResponse

DatastoreAdminSettings

DatastoreAdminSettings.Builder