package google.firestore.admin.v1
Get desktop application:
View/edit binary Protocol Buffers messages
Operations are created by service `FirestoreAdmin`, but are accessed via service `google.longrunning.Operations`.
rpc CreateIndex (, )
firestore_admin.proto:47Creates a composite index. This returns a [google.longrunning.Operation][google.longrunning.Operation] which may be used to track the status of the creation. The metadata for the operation will be the type [IndexOperationMetadata][google.firestore.admin.v1.IndexOperationMetadata].
message
firestore_admin.proto:143The request for [FirestoreAdmin.CreateIndex][google.firestore.admin.v1.FirestoreAdmin.CreateIndex].
string parent = 1
A parent name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}`
optional index = 2
The composite index to create.
rpc ListIndexes (, )
firestore_admin.proto:55Lists composite indexes.
message
firestore_admin.proto:153The request for [FirestoreAdmin.ListIndexes][google.firestore.admin.v1.FirestoreAdmin.ListIndexes].
string parent = 1
A parent name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}`
string filter = 2
The filter to apply to list results.
int32 page_size = 3
The number of results to return.
string page_token = 4
A page token, returned from a previous call to [FirestoreAdmin.ListIndexes][google.firestore.admin.v1.FirestoreAdmin.ListIndexes], that may be used to get the next page of results.
message
firestore_admin.proto:171The response for [FirestoreAdmin.ListIndexes][google.firestore.admin.v1.FirestoreAdmin.ListIndexes].
repeated indexes = 1
The requested indexes.
string next_page_token = 2
A page token that may be used to request another page of results. If blank, this is the last page.
rpc GetIndex (, )
firestore_admin.proto:62Gets a composite index.
message
firestore_admin.proto:181The request for [FirestoreAdmin.GetIndex][google.firestore.admin.v1.FirestoreAdmin.GetIndex].
string name = 1
A name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}`
rpc DeleteIndex (, )
firestore_admin.proto:69Deletes a composite index.
message
firestore_admin.proto:188The request for [FirestoreAdmin.DeleteIndex][google.firestore.admin.v1.FirestoreAdmin.DeleteIndex].
string name = 1
A name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}`
rpc GetField (, )
firestore_admin.proto:76Gets the metadata and configuration for a Field.
message
firestore_admin.proto:205The request for [FirestoreAdmin.GetField][google.firestore.admin.v1.FirestoreAdmin.GetField].
string name = 1
A name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_id}`
rpc UpdateField (, )
firestore_admin.proto:95Updates a field configuration. Currently, field updates apply only to single field index configuration. However, calls to [FirestoreAdmin.UpdateField][google.firestore.admin.v1.FirestoreAdmin.UpdateField] should provide a field mask to avoid changing any configuration that the caller isn't aware of. The field mask should be specified as: `{ paths: "index_config" }`. This call returns a [google.longrunning.Operation][google.longrunning.Operation] which may be used to track the status of the field update. The metadata for the operation will be the type [FieldOperationMetadata][google.firestore.admin.v1.FieldOperationMetadata]. To configure the default field settings for the database, use the special `Field` with resource name: `projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*`.
message
firestore_admin.proto:195The request for [FirestoreAdmin.UpdateField][google.firestore.admin.v1.FirestoreAdmin.UpdateField].
optional field = 1
The field to be updated.
optional update_mask = 2
A mask, relative to the field. If specified, only configuration specified by this field_mask will be updated in the field.
rpc ListFields (, )
firestore_admin.proto:108Lists the field configuration and metadata for this database. Currently, [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields] only supports listing fields that have been explicitly overridden. To issue this query, call [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields] with the filter set to `indexConfig.usesAncestorConfig:false`.
message
firestore_admin.proto:212The request for [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields].
string parent = 1
A parent name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}`
string filter = 2
The filter to apply to list results. Currently, [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields] only supports listing fields that have been explicitly overridden. To issue this query, call [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields] with the filter set to `indexConfig.usesAncestorConfig:false`.
int32 page_size = 3
The number of results to return.
string page_token = 4
A page token, returned from a previous call to [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields], that may be used to get the next page of results.
message
firestore_admin.proto:234The response for [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields].
repeated fields = 1
The requested fields.
string next_page_token = 2
A page token that may be used to request another page of results. If blank, this is the last page.
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
firestore_admin.proto:244The request for [FirestoreAdmin.ExportDocuments][google.firestore.admin.v1.FirestoreAdmin.ExportDocuments].
string name = 1
Database to export. Should be of the form: `projects/{project_id}/databases/{database_id}`.
repeated string collection_ids = 2
Which collection ids to export. Unspecified means all collections.
string output_uri_prefix = 3
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.
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
firestore_admin.proto:264The request for [FirestoreAdmin.ImportDocuments][google.firestore.admin.v1.FirestoreAdmin.ImportDocuments].
string name = 1
Database to import into. Should be of the form: `projects/{project_id}/databases/{database_id}`.
repeated string collection_ids = 2
Which collection ids to import. Unspecified means all collections included in the import.
string input_uri_prefix = 3
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.v1.ExportDocumentsResponse.output_uri_prefix][google.firestore.admin.v1.ExportDocumentsResponse.output_uri_prefix].
message
operation.proto:107Metadata for [google.longrunning.Operation][google.longrunning.Operation] results from [FirestoreAdmin.ExportDocuments][google.firestore.admin.v1.FirestoreAdmin.ExportDocuments].
optional start_time = 1
The time this operation started.
optional end_time = 2
The time this operation completed. Will be unset if operation still in progress.
OperationState operation_state = 3
The state of the export operation.
optional progress_documents = 4
The progress, in documents, of this operation.
optional progress_bytes = 5
The progress, in bytes, of this operation.
repeated string collection_ids = 6
Which collection ids are being exported.
string output_uri_prefix = 7
Where the entities are being exported to.
message
operation.proto:158Returned 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.
message
field.proto:35Represents a single field in the database. Fields are grouped by their "Collection Group", which represent all collections in the database with the same id.
Used as response type in: FirestoreAdmin.GetField
Used as field type in: ,
string name = 1
A field name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}` A field path may be a simple field name, e.g. `address` or a path to fields within map_value , e.g. `address.city`, or a special field path. The only valid special field is `*`, which represents any field. Field paths may be quoted using ` (backtick). The only character that needs to be escaped within a quoted field path is the backtick character itself, escaped using a backslash. Special characters in field paths that must be quoted include: `*`, `.`, ``` (backtick), `[`, `]`, as well as any ascii symbolic characters. Examples: (Note: Comments here are written in markdown syntax, so there is an additional layer of backticks to represent a code block) `\`address.city\`` represents a field named `address.city`, not the map key `city` in the field `address`. `\`*\`` represents a field named `*`, not any field. A special `Field` contains the default indexing settings for all fields. This field's resource name is: `projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*` Indexes defined on this `Field` will be applied to all fields which do not have their own `Field` index configuration.
optional index_config = 2
The index configuration for this field. If unset, field indexing will revert to the configuration defined by the `ancestor_field`. To explicitly remove all indexes for this field, specify an index config with an empty list of indexes.
message
field.proto:37The index configuration for this field.
Used in:
repeated indexes = 1
The indexes supported for this field.
bool uses_ancestor_config = 2
Output only. When true, the `Field`'s index configuration is set from the configuration specified by the `ancestor_field`. When false, the `Field`'s index configuration is defined explicitly.
string ancestor_field = 3
Output only. Specifies the resource name of the `Field` from which this field's index configuration is set (when `uses_ancestor_config` is true), or from which it *would* be set if this field had no index configuration (when `uses_ancestor_config` is false).
bool reverting = 4
Output only When true, the `Field`'s index configuration is in the process of being reverted. Once complete, the index config will transition to the same state as the field specified by `ancestor_field`, at which point `uses_ancestor_config` will be `true` and `reverting` will be `false`.
message
operation.proto:58Metadata for [google.longrunning.Operation][google.longrunning.Operation] results from [FirestoreAdmin.UpdateField][google.firestore.admin.v1.FirestoreAdmin.UpdateField].
optional start_time = 1
The time this operation started.
optional end_time = 2
The time this operation completed. Will be unset if operation still in progress.
string field = 3
The field resource that this operation is acting on. For example: `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}`
repeated index_config_deltas = 4
A list of [IndexConfigDelta][google.firestore.admin.v1.FieldOperationMetadata.IndexConfigDelta], which describe the intent of this operation.
OperationState state = 5
The state of the operation.
optional progress_documents = 6
The progress, in documents, of this operation.
optional progress_bytes = 7
The progress, in bytes, of this operation.
message
operation.proto:60Information about an index configuration change.
Used in:
IndexConfigDelta.ChangeType change_type = 1
Specifies how the index is changing.
optional index = 2
The index being changed.
Specifies how the index is changing.
Used in:
CHANGE_TYPE_UNSPECIFIED = 0
The type of change is not specified or known.
ADD = 1
The single field index is being added.
REMOVE = 2
The single field index is being removed.
message
operation.proto:133Metadata for [google.longrunning.Operation][google.longrunning.Operation] results from [FirestoreAdmin.ImportDocuments][google.firestore.admin.v1.FirestoreAdmin.ImportDocuments].
optional start_time = 1
The time this operation started.
optional end_time = 2
The time this operation completed. Will be unset if operation still in progress.
OperationState operation_state = 3
The state of the import operation.
optional progress_documents = 4
The progress, in documents, of this operation.
optional progress_bytes = 5
The progress, in bytes, of this operation.
repeated string collection_ids = 6
Which collection ids are being imported.
string input_uri_prefix = 7
The location of the documents being imported.
message
index.proto:32Cloud Firestore indexes enable simple and complex queries against documents in a database.
Used as response type in: FirestoreAdmin.GetIndex
Used as field type in: , , ,
string name = 1
Output only. A server defined name for this index. The form of this name for composite indexes will be: `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id}` For single field indexes, this field will be empty.
Index.QueryScope query_scope = 2
Indexes with a collection query scope specified allow queries against a collection that is the child of a specific document, specified at query time, and that has the same collection id. Indexes with a collection group query scope specified allow queries against all collections descended from a specific document, specified at query time, and that have the same collection id as this index.
repeated fields = 3
The fields supported by this index. For composite indexes, this is always 2 or more fields. The last field entry is always for the field path `__name__`. If, on creation, `__name__` was not specified as the last field, it will be added automatically with the same direction as that of the last field defined. If the final field in a composite index is not directional, the `__name__` will be ordered ASCENDING (unless explicitly specified). For single field indexes, this will always be exactly one entry with a field path equal to the field path of the associated field.
Index.State state = 4
Output only. The serving state of the index.
message
index.proto:36A field in an index. The field_path describes which field is indexed, the value_mode describes how the field value is indexed.
Used in:
string field_path = 1
Can be __name__. For single field indexes, this must match the name of the field or may be omitted.
oneof value_mode
How the field value is indexed.
IndexField.Order order = 2
Indicates that this field supports ordering by the specified order or comparing using =, <, <=, >, >=.
IndexField.ArrayConfig array_config = 3
Indicates that this field supports operations on `array_value`s.
The supported array value configurations.
Used in:
ARRAY_CONFIG_UNSPECIFIED = 0
The index does not support additional array queries.
CONTAINS = 1
The index supports array containment queries.
The supported orderings.
Used in:
ORDER_UNSPECIFIED = 0
The ordering is unspecified. Not a valid option.
ASCENDING = 1
The field is ordered by ascending field value.
DESCENDING = 2
The field is ordered by descending field value.
Query Scope defines the scope at which a query is run. This is specified on a StructuredQuery's `from` field.
Used in:
QUERY_SCOPE_UNSPECIFIED = 0
The query scope is unspecified. Not a valid option.
COLLECTION = 1
Indexes with a collection query scope specified allow queries against a collection that is the child of a specific document, specified at query time, and that has the collection id specified by the index.
COLLECTION_GROUP = 2
Indexes with a collection group query scope specified allow queries against all collections that has the collection id specified by the index.
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 creation encounters a problem, the index will transition to the `NEEDS_REPAIR` state.
Used in:
STATE_UNSPECIFIED = 0
The state is unspecified.
CREATING = 1
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.
NEEDS_REPAIR = 3
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. Use the google.longrunning.Operations API to determine why the operation that last attempted to create this index failed, then re-create the index.
message
operation.proto:34Metadata for [google.longrunning.Operation][google.longrunning.Operation] results from [FirestoreAdmin.CreateIndex][google.firestore.admin.v1.FirestoreAdmin.CreateIndex].
optional start_time = 1
The time this operation started.
optional end_time = 2
The time this operation completed. Will be unset if operation still in progress.
string index = 3
The index resource that this operation is acting on. For example: `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}`
OperationState state = 4
The state of the operation.
optional progress_documents = 5
The progress, in documents, of this operation.
optional progress_bytes = 6
The progress, in bytes, of this operation.
message
location.proto:32The metadata message for [google.cloud.location.Location.metadata][google.cloud.location.Location.metadata].
(message has no fields)
Describes the state of the operation.
Used in: , , ,
OPERATION_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
operation.proto:197Describes the progress of the operation. Unit of work is generic and must be interpreted based on where [Progress][google.firestore.admin.v1.Progress] is used.
Used in: , , ,
int64 estimated_work = 1
The amount of work estimated.
int64 completed_work = 2
The amount of work completed.