package google.datastore.admin.v1
Get desktop application:
View/edit binary Protocol Buffers messages
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). ----------------------------------------------------------------------------- ## 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.
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.
message
datastore_admin.proto:199The request for [google.datastore.admin.v1.DatastoreAdmin.ExportEntities][google.datastore.admin.v1.DatastoreAdmin.ExportEntities].
string project_id = 1
Project ID against which to make the request.
map<string, string> labels = 2
Client-assigned labels.
optional entity_filter = 3
Description of what data from the project is included in the export.
string output_url_prefix = 4
Location for the export metadata and data files. The full resource URL of the external storage location. Currently, only Google Cloud Storage is supported. So output_url_prefix should be of the form: `gs://BUCKET_NAME[/NAMESPACE_PATH]`, where `BUCKET_NAME` is the name of the Cloud Storage bucket and `NAMESPACE_PATH` is an optional Cloud Storage namespace path (this is not a Cloud Datastore namespace). For more information about Cloud Storage namespace paths, see [Object name considerations](https://cloud.google.com/storage/docs/naming#object-considerations). The resulting files will be nested deeper than the specified URL prefix. The final output URL will be provided in the [google.datastore.admin.v1.ExportEntitiesResponse.output_url][google.datastore.admin.v1.ExportEntitiesResponse.output_url] field. That value should be used for subsequent ImportEntities operations. By nesting the data files deeper, the same Cloud Storage bucket can be used in multiple ExportEntities operations without conflict.
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.
message
datastore_admin.proto:232The request for [google.datastore.admin.v1.DatastoreAdmin.ImportEntities][google.datastore.admin.v1.DatastoreAdmin.ImportEntities].
string project_id = 1
Project ID against which to make the request.
map<string, string> labels = 2
Client-assigned labels.
string input_url = 3
The full resource URL of the external storage location. Currently, only Google Cloud Storage is supported. So input_url should be of the form: `gs://BUCKET_NAME[/NAMESPACE_PATH]/OVERALL_EXPORT_METADATA_FILE`, where `BUCKET_NAME` is the name of the Cloud Storage bucket, `NAMESPACE_PATH` is an optional Cloud Storage namespace path (this is not a Cloud Datastore namespace), and `OVERALL_EXPORT_METADATA_FILE` is the metadata file written by the ExportEntities operation. For more information about Cloud Storage namespace paths, see [Object name considerations](https://cloud.google.com/storage/docs/naming#object-considerations). For more information, see [google.datastore.admin.v1.ExportEntitiesResponse.output_url][google.datastore.admin.v1.ExportEntitiesResponse.output_url].
optional entity_filter = 4
Optionally specify which kinds/namespaces are to be imported. If provided, the list must be a subset of the EntityFilter used in creating the export, otherwise a FAILED_PRECONDITION error will be returned. If no filter is specified then all entities from the export are imported.
rpc GetIndex (, )
datastore_admin.proto:121Gets an index.
message
datastore_admin.proto:349The request for [google.datastore.admin.v1.DatastoreAdmin.GetIndex][google.datastore.admin.v1.DatastoreAdmin.GetIndex].
string project_id = 1
Project ID against which to make the request.
string index_id = 3
The resource ID of the index to get.
rpc ListIndexes (, )
datastore_admin.proto:130Lists 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.
message
datastore_admin.proto:359The request for [google.datastore.admin.v1.DatastoreAdmin.ListIndexes][google.datastore.admin.v1.DatastoreAdmin.ListIndexes].
string project_id = 1
Project ID against which to make the request.
string filter = 3
int32 page_size = 4
The maximum number of items to return. If zero, then all results will be returned.
string page_token = 5
The next_page_token value returned from a previous List request, if any.
message
datastore_admin.proto:375The response for [google.datastore.admin.v1.DatastoreAdmin.ListIndexes][google.datastore.admin.v1.DatastoreAdmin.ListIndexes].
repeated indexes = 1
The indexes.
string next_page_token = 2
The standard List next-page token.
message
datastore_admin.proto:138Metadata common to all Datastore Admin operations.
Used in: , ,
optional start_time = 1
The time that work began on the operation.
optional end_time = 2
The time the operation ended, either successfully or otherwise.
OperationType operation_type = 3
The type of the operation. Can be used as a filter in ListOperationsRequest.
map<string, string> labels = 4
The client-assigned labels which were provided when the operation was created. May also include additional labels.
CommonMetadata.State state = 5
The current state of the Operation.
The various possible states for an ongoing Operation.
Used in:
STATE_UNSPECIFIED = 0
Unspecified.
INITIALIZING = 1
Request is being prepared for processing.
PROCESSING = 2
Request is actively being processed.
CANCELLING = 3
Request is in the process of being cancelled after user called google.longrunning.Operations.CancelOperation on the operation.
FINALIZING = 4
Request has been processed and is in its finalization stage.
SUCCESSFUL = 5
Request has completed successfully.
FAILED = 6
Request has finished being processed, but encountered an error.
CANCELLED = 7
Request has finished being cancelled after user called google.longrunning.Operations.CancelOperation.
message
datastore_admin.proto:333Identifies 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']
Used in: , , ,
repeated string kinds = 1
If empty, then this represents all kinds.
repeated string namespace_ids = 2
An empty list represents all namespaces. This is the preferred usage for projects that don't use namespaces. An empty string element represents the default namespace. This should be used if the project has data in non-default namespaces, but doesn't want to include them. Each namespace in this list must be unique.
message
datastore_admin.proto:272Metadata for ExportEntities operations.
optional common = 1
Metadata common to all Datastore Admin operations.
optional progress_entities = 2
An estimate of the number of entities processed.
optional progress_bytes = 3
An estimate of the number of bytes processed.
optional entity_filter = 4
Description of which entities are being exported.
string output_url_prefix = 5
Location for the export metadata and data files. This will be the same value as the [google.datastore.admin.v1.ExportEntitiesRequest.output_url_prefix][google.datastore.admin.v1.ExportEntitiesRequest.output_url_prefix] field. The final output location is provided in [google.datastore.admin.v1.ExportEntitiesResponse.output_url][google.datastore.admin.v1.ExportEntitiesResponse.output_url].
message
datastore_admin.proto:263The response for [google.datastore.admin.v1.DatastoreAdmin.ExportEntities][google.datastore.admin.v1.DatastoreAdmin.ExportEntities].
string output_url = 1
Location of the output metadata file. This can be used to begin an import into Cloud Datastore (this project or another project). See [google.datastore.admin.v1.ImportEntitiesRequest.input_url][google.datastore.admin.v1.ImportEntitiesRequest.input_url]. Only present if the operation completed successfully.
message
datastore_admin.proto:294Metadata for ImportEntities operations.
optional common = 1
Metadata common to all Datastore Admin operations.
optional progress_entities = 2
An estimate of the number of entities processed.
optional progress_bytes = 3
An estimate of the number of bytes processed.
optional entity_filter = 4
Description of which entities are being imported.
string input_url = 5
The location of the import metadata file. This will be the same value as the [google.datastore.admin.v1.ExportEntitiesResponse.output_url][google.datastore.admin.v1.ExportEntitiesResponse.output_url] field.
message
index.proto:29A minimal index definition. Next tag: 8
Used as response type in: DatastoreAdmin.GetIndex
Used as field type in:
string project_id = 1
Project ID. Output only.
string index_id = 3
The resource ID of the index. Output only.
string kind = 4
The entity kind to which this index applies. Required.
Index.AncestorMode ancestor = 5
The index's ancestor mode. Must not be ANCESTOR_MODE_UNSPECIFIED. Required.
repeated properties = 6
An ordered sequence of property names and their index attributes. Required.
Index.State state = 7
The state of the index. Output only.
For an ordered index, specifies whether each of the entity's ancestors will be included.
Used in:
ANCESTOR_MODE_UNSPECIFIED = 0
The ancestor mode is unspecified.
NONE = 1
Do not include the entity's ancestors in the index.
ALL_ANCESTORS = 2
Include all the entity's ancestors in the index.
The direction determines how a property is indexed.
Used in:
DIRECTION_UNSPECIFIED = 0
The direction is unspecified.
ASCENDING = 1
The property's values are indexed so as to support sequencing in ascending order and also query by <, >, <=, >=, and =.
DESCENDING = 2
The property's values are indexed so as to support sequencing in descending order and also query by <, >, <=, >=, and =.
message
index.proto:31Next tag: 3
Used in:
string name = 1
The property name to index. Required.
Direction direction = 2
The indexed property's direction. Must not be DIRECTION_UNSPECIFIED. Required.
The possible set of states of an index.
Used in:
STATE_UNSPECIFIED = 0
The state is unspecified.
CREATING = 1
The index is being created, and cannot be used by queries. There is an active long-running operation for the index. The index is updated when writing an entity. Some index data may exist.
READY = 2
The index is ready to be used. The index is updated when writing an entity. The index is fully populated from all stored entities it applies to.
DELETING = 3
The index is being deleted, and cannot be used by queries. There is an active long-running operation for the index. The index is not updated when writing an entity. Some index data may exist.
ERROR = 4
The index was being created or deleted, but something went wrong. The index cannot by used by queries. There is no active long-running operation for the index, and the most recently finished long-running operation failed. The index is not updated when writing an entity. Some index data may exist.
message
datastore_admin.proto:384Metadata for Index operations.
optional common = 1
Metadata common to all Datastore Admin operations.
optional progress_entities = 2
An estimate of the number of entities processed.
string index_id = 3
The index resource ID that this operation is acting on.
Operation types.
Used in:
OPERATION_TYPE_UNSPECIFIED = 0
Unspecified.
EXPORT_ENTITIES = 1
ExportEntities.
IMPORT_ENTITIES = 2
ImportEntities.
CREATE_INDEX = 3
CreateIndex.
DELETE_INDEX = 4
DeleteIndex.
message
datastore_admin.proto:187Measures the progress of a particular metric.
Used in: , ,
int64 work_completed = 1
The amount of work that has been completed. Note that this may be greater than work_estimated.
int64 work_estimated = 2
An estimate of how much work needs to be performed. May be zero if the work estimate is unavailable.