public sealed class DatastoreAdminClientImpl : DatastoreAdminClientReference documentation and code samples for the Cloud Datastore v1 API class DatastoreAdminClientImpl.
DatastoreAdmin client wrapper implementation, for convenient use.
Namespace
Google.Cloud.Datastore.Admin.V1Assembly
Google.Cloud.Datastore.Admin.V1.dll
Remarks
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.
Constructors
DatastoreAdminClientImpl(DatastoreAdminClient, DatastoreAdminSettings, ILogger)
public DatastoreAdminClientImpl(DatastoreAdmin.DatastoreAdminClient grpcClient, DatastoreAdminSettings settings, ILogger logger)Constructs a client wrapper for the DatastoreAdmin service, with the specified gRPC client and settings.
| Parameters | |
|---|---|
| Name | Description |
grpcClient | DatastoreAdminDatastoreAdminClientThe underlying gRPC client. |
settings | DatastoreAdminSettingsThe base DatastoreAdminSettings used within this client. |
logger | ILoggerOptional ILogger to use within this client. |
Properties
CreateIndexOperationsClient
public override OperationsClient CreateIndexOperationsClient { get; }The long-running operations client for CreateIndex.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
DeleteIndexOperationsClient
public override OperationsClient DeleteIndexOperationsClient { get; }The long-running operations client for DeleteIndex.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
ExportEntitiesOperationsClient
public override OperationsClient ExportEntitiesOperationsClient { get; }The long-running operations client for ExportEntities.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
GrpcClient
public override DatastoreAdmin.DatastoreAdminClient GrpcClient { get; }The underlying gRPC DatastoreAdmin client
| Property Value | |
|---|---|
| Type | Description |
DatastoreAdminDatastoreAdminClient | |
ImportEntitiesOperationsClient
public override OperationsClient ImportEntitiesOperationsClient { get; }The long-running operations client for ImportEntities.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
Methods
CreateIndex(CreateIndexRequest, CallSettings)
public override Operation<Index, IndexOperationMetadata> CreateIndex(CreateIndexRequest request, CallSettings callSettings = null)Creates the specified index.
A newly created index's initial state is CREATING. On completion of the
returned [google.longrunning.Operation][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][google.datastore.admin.v1.DatastoreAdmin.DeleteIndex], 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 | CreateIndexRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationIndexIndexOperationMetadata | The RPC response. |
CreateIndexAsync(CreateIndexRequest, CallSettings)
public override Task<Operation<Index, IndexOperationMetadata>> CreateIndexAsync(CreateIndexRequest request, CallSettings callSettings = null)Creates the specified index.
A newly created index's initial state is CREATING. On completion of the
returned [google.longrunning.Operation][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][google.datastore.admin.v1.DatastoreAdmin.DeleteIndex], 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 | CreateIndexRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationIndexIndexOperationMetadata | A Task containing the RPC response. |
DeleteIndex(DeleteIndexRequest, CallSettings)
public override Operation<Index, IndexOperationMetadata> DeleteIndex(DeleteIndexRequest request, CallSettings callSettings = null)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][google.datastore.admin.v1.Index.State]. And on completion of the
returned [google.longrunning.Operation][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][google.datastore.admin.v1.DatastoreAdmin.DeleteIndex] again.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteIndexRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationIndexIndexOperationMetadata | The RPC response. |
DeleteIndexAsync(DeleteIndexRequest, CallSettings)
public override Task<Operation<Index, IndexOperationMetadata>> DeleteIndexAsync(DeleteIndexRequest request, CallSettings callSettings = null)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][google.datastore.admin.v1.Index.State]. And on completion of the
returned [google.longrunning.Operation][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][google.datastore.admin.v1.DatastoreAdmin.DeleteIndex] again.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteIndexRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationIndexIndexOperationMetadata | A Task containing the RPC response. |
ExportEntities(ExportEntitiesRequest, CallSettings)
public override Operation<ExportEntitiesResponse, ExportEntitiesMetadata> ExportEntities(ExportEntitiesRequest request, CallSettings callSettings = null)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 | ExportEntitiesRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationExportEntitiesResponseExportEntitiesMetadata | The RPC response. |
ExportEntitiesAsync(ExportEntitiesRequest, CallSettings)
public override Task<Operation<ExportEntitiesResponse, ExportEntitiesMetadata>> ExportEntitiesAsync(ExportEntitiesRequest request, CallSettings callSettings = null)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 | ExportEntitiesRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationExportEntitiesResponseExportEntitiesMetadata | A Task containing the RPC response. |
GetIndex(GetIndexRequest, CallSettings)
public override Index GetIndex(GetIndexRequest request, CallSettings callSettings = null)Gets an index.
| Parameters | |
|---|---|
| Name | Description |
request | GetIndexRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Index | The RPC response. |
GetIndexAsync(GetIndexRequest, CallSettings)
public override Task<Index> GetIndexAsync(GetIndexRequest request, CallSettings callSettings = null)Gets an index.
| Parameters | |
|---|---|
| Name | Description |
request | GetIndexRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskIndex | A Task containing the RPC response. |
ImportEntities(ImportEntitiesRequest, CallSettings)
public override Operation<Empty, ImportEntitiesMetadata> ImportEntities(ImportEntitiesRequest request, CallSettings callSettings = null)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 | ImportEntitiesRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationEmptyImportEntitiesMetadata | The RPC response. |
ImportEntitiesAsync(ImportEntitiesRequest, CallSettings)
public override Task<Operation<Empty, ImportEntitiesMetadata>> ImportEntitiesAsync(ImportEntitiesRequest request, CallSettings callSettings = null)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 | ImportEntitiesRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationEmptyImportEntitiesMetadata | A Task containing the RPC response. |
ListIndexes(ListIndexesRequest, CallSettings)
public override PagedEnumerable<ListIndexesResponse, Index> ListIndexes(ListIndexesRequest request, CallSettings callSettings = null)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 | ListIndexesRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListIndexesResponseIndex | A pageable sequence of Index resources. |
ListIndexesAsync(ListIndexesRequest, CallSettings)
public override PagedAsyncEnumerable<ListIndexesResponse, Index> ListIndexesAsync(ListIndexesRequest request, CallSettings callSettings = null)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 | ListIndexesRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListIndexesResponseIndex | A pageable asynchronous sequence of Index resources. |