package google.firestore.admin.v1beta1

Get desktop application:
View/edit binary Protocol Buffers messages

The Cloud Firestore Admin API. This API provides several administrative services for Cloud Firestore. # Concepts Project, Database, Namespace, Collection, and Document are used as defined in the Google Cloud Firestore API. Operation: An Operation represents work being performed in the background. # Services ## Index The index service manages Cloud Firestore indexes. Index creation is 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. ## Metadata Provides metadata and statistical information about data in Cloud Firestore. The data provided as part of this API may be stale. ## 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. Operations are created by service `FirestoreAdmin`, but are accessed via service `google.longrunning.Operations`.

• rpc CreateIndex (CreateIndexRequest, longrunning.Operation)

  firestore_admin.proto:96

  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 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.firestore.admin.v1beta1.FirestoreAdmin.DeleteIndex], then re-creating the index with [create][google.firestore.admin.v1beta1.FirestoreAdmin.CreateIndex]. Indexes with a single field cannot be created.

  message CreateIndexRequest

  firestore_admin.proto:199

  The request for [FirestoreAdmin.CreateIndex][google.firestore.admin.v1beta1.FirestoreAdmin.CreateIndex].

  • string parent = 1

    The name of the database this index will apply to. For example: `projects/{project_id}/databases/{database_id}`

  • optional Index index = 2

    The index to create. The name and state fields are output only and will be ignored. Certain single field indexes cannot be created or deleted.

• rpc ListIndexes (ListIndexesRequest, ListIndexesResponse)

  firestore_admin.proto:104

  Lists the indexes that match the specified filters.

  message ListIndexesRequest

  firestore_admin.proto:217

  The request for [FirestoreAdmin.ListIndexes][google.firestore.admin.v1beta1.FirestoreAdmin.ListIndexes].

  • string parent = 1

    The database name. For example: `projects/{project_id}/databases/{database_id}`

  • string filter = 2

  • int32 page_size = 3

    The standard List page size.

  • string page_token = 4

    The standard List page token.

  message ListIndexesResponse

  firestore_admin.proto:239

  The response for [FirestoreAdmin.ListIndexes][google.firestore.admin.v1beta1.FirestoreAdmin.ListIndexes].

  • repeated Index indexes = 1

    The indexes.

  • string next_page_token = 2

    The standard List next-page token.

• rpc GetIndex (GetIndexRequest, Index)

  firestore_admin.proto:111

  Gets an index.

  message GetIndexRequest

  firestore_admin.proto:210

  The request for [FirestoreAdmin.GetIndex][google.firestore.admin.v1beta1.FirestoreAdmin.GetIndex].

  • string name = 1

    The name of the index. For example: `projects/{project_id}/databases/{database_id}/indexes/{index_id}`

• rpc DeleteIndex (DeleteIndexRequest, protobuf.Empty)

  firestore_admin.proto:118

  Deletes an index.

  message DeleteIndexRequest

  firestore_admin.proto:232

  The request for [FirestoreAdmin.DeleteIndex][google.firestore.admin.v1beta1.FirestoreAdmin.DeleteIndex].

  • string name = 1

    The index name. For example: `projects/{project_id}/databases/{database_id}/indexes/{index_id}`

• rpc ExportDocuments (ExportDocumentsRequest, longrunning.Operation)

  firestore_admin.proto:132

  Exports a copy of all or a subset of documents from Google Cloud Firestore to another storage system, such as Google Cloud Storage. Recent updates to documents 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 ExportDocumentsRequest

  firestore_admin.proto:248

  The request for [FirestoreAdmin.ExportDocuments][google.firestore.admin.v1beta1.FirestoreAdmin.ExportDocuments].

  • string name = 1

    Database to export. Should be of the form: `projects/{project_id}/databases/{database_id}`.

  • repeated string collection_ids = 3

    Which collection ids to export. Unspecified means all collections.

  • string output_uri_prefix = 4

    The output URI. Currently only supports Google Cloud Storage URIs of the form: `gs://BUCKET_NAME[/NAMESPACE_PATH]`, where `BUCKET_NAME` is the name of the Google Cloud Storage bucket and `NAMESPACE_PATH` is an optional Google Cloud Storage namespace path. When choosing a name, be sure to consider Google Cloud Storage naming guidelines: https://cloud.google.com/storage/docs/naming. If the URI is a bucket (without a namespace path), a prefix will be generated based on the start time.

• rpc ImportDocuments (ImportDocumentsRequest, longrunning.Operation)

  firestore_admin.proto:144

  Imports documents into Google Cloud Firestore. Existing documents with the same name 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 ImportDocuments operation is cancelled, it is possible that a subset of the data has already been imported to Cloud Firestore.

  message ImportDocumentsRequest

  firestore_admin.proto:268

  The request for [FirestoreAdmin.ImportDocuments][google.firestore.admin.v1beta1.FirestoreAdmin.ImportDocuments].

  • string name = 1

    Database to import into. Should be of the form: `projects/{project_id}/databases/{database_id}`.

  • repeated string collection_ids = 3

    Which collection ids to import. Unspecified means all collections included in the import.

  • string input_uri_prefix = 4

    Location of the exported files. This must match the output_uri_prefix of an ExportDocumentsResponse from an export that has completed successfully. See: [google.firestore.admin.v1beta1.ExportDocumentsResponse.output_uri_prefix][google.firestore.admin.v1beta1.ExportDocumentsResponse.output_uri_prefix].

Metadata for ExportDocuments operations.

• optional protobuf.Timestamp start_time = 1

  The time that work began on the operation.

• optional protobuf.Timestamp end_time = 2

  The time the operation ended, either successfully or otherwise. Unset if the operation is still active.

• OperationState operation_state = 3

  The state of the export operation.

• optional Progress progress_documents = 4

  An estimate of the number of documents processed.

• optional Progress progress_bytes = 5

  An estimate of the number of bytes processed.

• repeated string collection_ids = 6

  Which collection ids are being exported.

• string output_uri_prefix = 7

  Where the entities are being exported to.

Returned in the [google.longrunning.Operation][google.longrunning.Operation] response field.

• string output_uri_prefix = 1

  Location of the output files. This can be used to begin an import into Cloud Firestore (this project or another project) after the operation completes successfully.

Metadata for ImportDocuments operations.

• optional protobuf.Timestamp start_time = 1

  The time that work began on the operation.

• optional protobuf.Timestamp end_time = 2

  The time the operation ended, either successfully or otherwise. Unset if the operation is still active.

• OperationState operation_state = 3

  The state of the import operation.

• optional Progress progress_documents = 4

  An estimate of the number of documents processed.

• optional Progress progress_bytes = 5

  An estimate of the number of bytes processed.

• repeated string collection_ids = 6

  Which collection ids are being imported.

• string input_uri_prefix = 7

  The location of the documents being imported.

An index definition.

Used as response type in: FirestoreAdmin.GetIndex

Used as field type in: CreateIndexRequest, ListIndexesResponse

• string name = 1

  The resource name of the index. Output only.

• string collection_id = 2

  The collection ID to which this index applies. Required.

• repeated IndexField fields = 3

  The fields to index.

• Index.State state = 6

  The state of the index. Output only.

The state of an index. During index creation, an index will be in the `CREATING` state. If the index is created successfully, it will transition to the `READY` state. If the index is not able to be created, it will transition to the `ERROR` state.

Used in: Index

• STATE_UNSPECIFIED = 0

  The state is unspecified.

• CREATING = 3

  The index is being created. There is an active long-running operation for the index. The index is updated when writing a document. Some index data may exist.

• READY = 2

  The index is ready to be used. The index is updated when writing a document. The index is fully populated from all stored documents it applies to.

• ERROR = 5

  The index was being created, but something went wrong. 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 a document. Some index data may exist.

A field of an index.

Used in: Index

• string field_path = 1

  The path of the field. Must match the field path specification described by [google.firestore.v1beta1.Document.fields][fields]. Special field path `__name__` may be used by itself or at the end of a path. `__type__` may be used only at the end of path.

• IndexField.Mode mode = 2

  The field's mode.

The mode determines how a field is indexed.

Used in: IndexField

• MODE_UNSPECIFIED = 0

  The mode is unspecified.

• ASCENDING = 2

  The field's values are indexed so as to support sequencing in ascending order and also query by <, >, <=, >=, and =.

• DESCENDING = 3

  The field's values are indexed so as to support sequencing in descending order and also query by <, >, <=, >=, and =.

• ARRAY_CONTAINS = 4

  The field's array values are indexed so as to support membership using ARRAY_CONTAINS queries.

Metadata for index operations. This metadata populates the metadata field of [google.longrunning.Operation][google.longrunning.Operation].

• optional protobuf.Timestamp start_time = 1

  The time that work began on the operation.

• optional protobuf.Timestamp end_time = 2

  The time the operation ended, either successfully or otherwise. Unset if the operation is still active.

• string index = 3

  The index resource that this operation is acting on. For example: `projects/{project_id}/databases/{database_id}/indexes/{index_id}`

• IndexOperationMetadata.OperationType operation_type = 4

  The type of index operation.

• bool cancelled = 5

  True if the [google.longrunning.Operation] was cancelled. If the cancellation is in progress, cancelled will be true but [google.longrunning.Operation.done][google.longrunning.Operation.done] will be false.

• optional Progress document_progress = 6

  Progress of the existing operation, measured in number of documents.

The type of index operation.

Used in: IndexOperationMetadata

• OPERATION_TYPE_UNSPECIFIED = 0

  Unspecified. Never set by server.

• CREATING_INDEX = 1

  The operation is creating the index. Initiated by a `CreateIndex` call.

The metadata message for [google.cloud.location.Location.metadata][google.cloud.location.Location.metadata].

(message has no fields)

The various possible states for an ongoing Operation.

Used in: ExportDocumentsMetadata, ImportDocumentsMetadata

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

Measures the progress of a particular metric.

Used in: ExportDocumentsMetadata, ImportDocumentsMetadata, IndexOperationMetadata

• int64 work_completed = 1

  An estimate of how much work 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. Zero if the work estimate is unavailable. May change as work progresses.