# Cloud Datastore v1 API - Namespace Google.Cloud.Datastore.Admin.V1 (2.5.0)

<button class="button button-with-icon cloud-select-dropdown__button " aria-haspopup="true">Version latest</button>

- [2.5.0 (latest)](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Datastore.Admin.V1/latest/Google.Cloud.Datastore.Admin.V1)
- [2.4.0](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Datastore.Admin.V1/2.4.0/Google.Cloud.Datastore.Admin.V1)
- [2.3.0](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Datastore.Admin.V1/2.3.0/Google.Cloud.Datastore.Admin.V1)
- [2.2.0](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Datastore.Admin.V1/2.2.0/Google.Cloud.Datastore.Admin.V1)
- [2.1.0](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Datastore.Admin.V1/2.1.0/Google.Cloud.Datastore.Admin.V1)
- [2.0.0](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Datastore.Admin.V1/2.0.0/Google.Cloud.Datastore.Admin.V1)
- [1.4.0](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Datastore.Admin.V1/1.4.0/Google.Cloud.Datastore.Admin.V1)
- [1.3.0](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Datastore.Admin.V1/1.3.0/Google.Cloud.Datastore.Admin.V1)
- [1.2.0](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Datastore.Admin.V1/1.2.0/Google.Cloud.Datastore.Admin.V1)
- [1.1.0](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Datastore.Admin.V1/1.1.0/Google.Cloud.Datastore.Admin.V1)

## Classes

### [CommonMetadata](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Datastore.Admin.V1/latest/Google.Cloud.Datastore.Admin.V1.CommonMetadata)

Metadata common to all Datastore Admin operations.

### [CommonMetadata.Types](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Datastore.Admin.V1/latest/Google.Cloud.Datastore.Admin.V1.CommonMetadata.Types)

Container for nested types declared in the CommonMetadata message type.

### [CreateIndexRequest](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Datastore.Admin.V1/latest/Google.Cloud.Datastore.Admin.V1.CreateIndexRequest)

The request for
\[google.datastore.admin.v1.DatastoreAdmin.CreateIndex\]\[google.datastore.admin.v1.DatastoreAdmin.CreateIndex\].

### [DatastoreAdmin](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Datastore.Admin.V1/latest/Google.Cloud.Datastore.Admin.V1.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).

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.

### [DatastoreAdmin.DatastoreAdminBase](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Datastore.Admin.V1/latest/Google.Cloud.Datastore.Admin.V1.DatastoreAdmin.DatastoreAdminBase)

Base class for server-side implementations of DatastoreAdmin

### [DatastoreAdmin.DatastoreAdminClient](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Datastore.Admin.V1/latest/Google.Cloud.Datastore.Admin.V1.DatastoreAdmin.DatastoreAdminClient)

Client for DatastoreAdmin

### [DatastoreAdminClient](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Datastore.Admin.V1/latest/Google.Cloud.Datastore.Admin.V1.DatastoreAdminClient)

DatastoreAdmin client wrapper, for convenient use.

### [DatastoreAdminClientBuilder](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Datastore.Admin.V1/latest/Google.Cloud.Datastore.Admin.V1.DatastoreAdminClientBuilder)

Builder class for [DatastoreAdminClient](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Datastore.Admin.V1/latest/Google.Cloud.Datastore.Admin.V1.DatastoreAdminClient) to provide simple configuration of credentials, endpoint
etc.

### [DatastoreAdminClientImpl](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Datastore.Admin.V1/latest/Google.Cloud.Datastore.Admin.V1.DatastoreAdminClientImpl)

DatastoreAdmin client wrapper implementation, for convenient use.

### [DatastoreAdminSettings](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Datastore.Admin.V1/latest/Google.Cloud.Datastore.Admin.V1.DatastoreAdminSettings)

Settings for [DatastoreAdminClient](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Datastore.Admin.V1/latest/Google.Cloud.Datastore.Admin.V1.DatastoreAdminClient) instances.

### [DatastoreFirestoreMigrationMetadata](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Datastore.Admin.V1/latest/Google.Cloud.Datastore.Admin.V1.DatastoreFirestoreMigrationMetadata)

Metadata for Datastore to Firestore migration operations.

The DatastoreFirestoreMigration operation is not started by the end-user via
an explicit "creation" method. This is an intentional deviation from the LRO
design pattern.

This singleton resource can be accessed at:
"projects/{project_id}/operations/datastore-firestore-migration"

### [DeleteIndexRequest](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Datastore.Admin.V1/latest/Google.Cloud.Datastore.Admin.V1.DeleteIndexRequest)

The request for
\[google.datastore.admin.v1.DatastoreAdmin.DeleteIndex\]\[google.datastore.admin.v1.DatastoreAdmin.DeleteIndex\].

### [EntityFilter](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Datastore.Admin.V1/latest/Google.Cloud.Datastore.Admin.V1.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'\]

### [ExportEntitiesMetadata](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Datastore.Admin.V1/latest/Google.Cloud.Datastore.Admin.V1.ExportEntitiesMetadata)

Metadata for ExportEntities operations.

### [ExportEntitiesRequest](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Datastore.Admin.V1/latest/Google.Cloud.Datastore.Admin.V1.ExportEntitiesRequest)

The request for
\[google.datastore.admin.v1.DatastoreAdmin.ExportEntities\]\[google.datastore.admin.v1.DatastoreAdmin.ExportEntities\].

### [ExportEntitiesResponse](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Datastore.Admin.V1/latest/Google.Cloud.Datastore.Admin.V1.ExportEntitiesResponse)

The response for
\[google.datastore.admin.v1.DatastoreAdmin.ExportEntities\]\[google.datastore.admin.v1.DatastoreAdmin.ExportEntities\].

### [GetIndexRequest](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Datastore.Admin.V1/latest/Google.Cloud.Datastore.Admin.V1.GetIndexRequest)

The request for
\[google.datastore.admin.v1.DatastoreAdmin.GetIndex\]\[google.datastore.admin.v1.DatastoreAdmin.GetIndex\].

### [ImportEntitiesMetadata](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Datastore.Admin.V1/latest/Google.Cloud.Datastore.Admin.V1.ImportEntitiesMetadata)

Metadata for ImportEntities operations.

### [ImportEntitiesRequest](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Datastore.Admin.V1/latest/Google.Cloud.Datastore.Admin.V1.ImportEntitiesRequest)

The request for
\[google.datastore.admin.v1.DatastoreAdmin.ImportEntities\]\[google.datastore.admin.v1.DatastoreAdmin.ImportEntities\].

### [Index](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Datastore.Admin.V1/latest/Google.Cloud.Datastore.Admin.V1.Index)

Datastore composite index definition.

### [Index.Types](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Datastore.Admin.V1/latest/Google.Cloud.Datastore.Admin.V1.Index.Types)

Container for nested types declared in the Index message type.

### [Index.Types.IndexedProperty](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Datastore.Admin.V1/latest/Google.Cloud.Datastore.Admin.V1.Index.Types.IndexedProperty)

A property of an index.

### [IndexOperationMetadata](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Datastore.Admin.V1/latest/Google.Cloud.Datastore.Admin.V1.IndexOperationMetadata)

Metadata for Index operations.

### [ListIndexesRequest](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Datastore.Admin.V1/latest/Google.Cloud.Datastore.Admin.V1.ListIndexesRequest)

The request for
\[google.datastore.admin.v1.DatastoreAdmin.ListIndexes\]\[google.datastore.admin.v1.DatastoreAdmin.ListIndexes\].

### [ListIndexesResponse](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Datastore.Admin.V1/latest/Google.Cloud.Datastore.Admin.V1.ListIndexesResponse)

The response for
\[google.datastore.admin.v1.DatastoreAdmin.ListIndexes\]\[google.datastore.admin.v1.DatastoreAdmin.ListIndexes\].

### [MigrationProgressEvent](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Datastore.Admin.V1/latest/Google.Cloud.Datastore.Admin.V1.MigrationProgressEvent)

An event signifying the start of a new step in a [migration from Cloud
Datastore to Cloud Firestore in Datastore
mode](https://cloud.google.com/datastore/docs/upgrade-to-firestore).

### [MigrationProgressEvent.Types](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Datastore.Admin.V1/latest/Google.Cloud.Datastore.Admin.V1.MigrationProgressEvent.Types)

Container for nested types declared in the MigrationProgressEvent message type.

### [MigrationProgressEvent.Types.PrepareStepDetails](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Datastore.Admin.V1/latest/Google.Cloud.Datastore.Admin.V1.MigrationProgressEvent.Types.PrepareStepDetails)

Details for the `PREPARE` step.

### [MigrationProgressEvent.Types.RedirectWritesStepDetails](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Datastore.Admin.V1/latest/Google.Cloud.Datastore.Admin.V1.MigrationProgressEvent.Types.RedirectWritesStepDetails)

Details for the `REDIRECT_WRITES` step.

### [MigrationStateEvent](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Datastore.Admin.V1/latest/Google.Cloud.Datastore.Admin.V1.MigrationStateEvent)

An event signifying a change in state of a [migration from Cloud Datastore to
Cloud Firestore in Datastore
mode](https://cloud.google.com/datastore/docs/upgrade-to-firestore).

### [Progress](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Datastore.Admin.V1/latest/Google.Cloud.Datastore.Admin.V1.Progress)

Measures the progress of a particular metric.

## Enums

### [CommonMetadata.Types.State](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Datastore.Admin.V1/latest/Google.Cloud.Datastore.Admin.V1.CommonMetadata.Types.State)

The various possible states for an ongoing Operation.

### [Index.Types.AncestorMode](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Datastore.Admin.V1/latest/Google.Cloud.Datastore.Admin.V1.Index.Types.AncestorMode)

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

### [Index.Types.Direction](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Datastore.Admin.V1/latest/Google.Cloud.Datastore.Admin.V1.Index.Types.Direction)

The direction determines how a property is indexed.

### [Index.Types.State](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Datastore.Admin.V1/latest/Google.Cloud.Datastore.Admin.V1.Index.Types.State)

The possible set of states of an index.

### [MigrationProgressEvent.StepDetailsOneofCase](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Datastore.Admin.V1/latest/Google.Cloud.Datastore.Admin.V1.MigrationProgressEvent.StepDetailsOneofCase)

Enum of possible cases for the "step_details" oneof.

### [MigrationProgressEvent.Types.ConcurrencyMode](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Datastore.Admin.V1/latest/Google.Cloud.Datastore.Admin.V1.MigrationProgressEvent.Types.ConcurrencyMode)

Concurrency modes for transactions in Cloud Firestore.

### [MigrationState](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Datastore.Admin.V1/latest/Google.Cloud.Datastore.Admin.V1.MigrationState)

States for a migration.

### [MigrationStep](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Datastore.Admin.V1/latest/Google.Cloud.Datastore.Admin.V1.MigrationStep)

Steps in a migration.

### [OperationType](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Datastore.Admin.V1/latest/Google.Cloud.Datastore.Admin.V1.OperationType)

Operation types.