Cloud Datastore v1 API - Class DatastoreAdmin.DatastoreAdminBase (2.1.0)

[BindServiceMethod(typeof(DatastoreAdmin), "BindService")]
public abstract class DatastoreAdminBase

Reference documentation and code samples for the Cloud Datastore v1 API class DatastoreAdmin.DatastoreAdminBase.

Base class for server-side implementations of DatastoreAdmin

Inheritance

Object > DatastoreAdmin.DatastoreAdminBase

Inherited Members

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.Datastore.Admin.V1

Assembly

Google.Cloud.Datastore.Admin.V1.dll

Methods

CreateIndex(CreateIndexRequest, ServerCallContext)

public virtual Task<Operation> CreateIndex(CreateIndexRequest request, ServerCallContext context)

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`	`CreateIndexRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<Operation>`	The response to send back to the client (wrapped by a task).

DeleteIndex(DeleteIndexRequest, ServerCallContext)

public virtual Task<Operation> DeleteIndex(DeleteIndexRequest request, ServerCallContext context)

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`	`DeleteIndexRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<Operation>`	The response to send back to the client (wrapped by a task).

ExportEntities(ExportEntitiesRequest, ServerCallContext)

public virtual Task<Operation> ExportEntities(ExportEntitiesRequest request, ServerCallContext context)

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` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<Operation>`	The response to send back to the client (wrapped by a task).

GetIndex(GetIndexRequest, ServerCallContext)

public virtual Task<Index> GetIndex(GetIndexRequest request, ServerCallContext context)

Gets an index.

Parameters
Name	Description
`request`	`GetIndexRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<Index>`	The response to send back to the client (wrapped by a task).

ImportEntities(ImportEntitiesRequest, ServerCallContext)

public virtual Task<Operation> ImportEntities(ImportEntitiesRequest request, ServerCallContext context)

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` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<Operation>`	The response to send back to the client (wrapped by a task).

ListIndexes(ListIndexesRequest, ServerCallContext)

public virtual Task<ListIndexesResponse> ListIndexes(ListIndexesRequest request, ServerCallContext context)

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` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<ListIndexesResponse>`	The response to send back to the client (wrapped by a task).