Types overview

GoogleFirestoreAdminV1beta2ExportDocumentsMetadata

Metadata for google.longrunning.Operation results from FirestoreAdmin.ExportDocuments.

Fields
`collectionIds[]`	`string` Which collection ids are being exported.
`endTime`	`string (Timestamp format)` The time this operation completed. Will be unset if operation still in progress.
`operationState`	`enum` The state of the export operation.
Enum type. Can be one of the following:
`OPERATION_STATE_UNSPECIFIED`	Unspecified.
`INITIALIZING`	Request is being prepared for processing.
`PROCESSING`	Request is actively being processed.
`CANCELLING`	Request is in the process of being cancelled after user called google.longrunning.Operations.CancelOperation on the operation.
`FINALIZING`	Request has been processed and is in its finalization stage.
`SUCCESSFUL`	Request has completed successfully.
`FAILED`	Request has finished being processed, but encountered an error.
`CANCELLED`	Request has finished being cancelled after user called google.longrunning.Operations.CancelOperation.

`outputUriPrefix`	`string` Where the entities are being exported to.
`progressBytes`	`object (GoogleFirestoreAdminV1beta2Progress)` The progress, in bytes, of this operation.
`progressDocuments`	`object (GoogleFirestoreAdminV1beta2Progress)` The progress, in documents, of this operation.
`startTime`	`string (Timestamp format)` The time this operation started.

GoogleFirestoreAdminV1beta2ExportDocumentsRequest

The request for FirestoreAdmin.ExportDocuments.

Fields

Fields
`collectionIds[]`	`string` Which collection ids to export. Unspecified means all collections.
`outputUriPrefix`	`string` 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.

collectionIds[]

string

Which collection ids to export. Unspecified means all collections.

outputUriPrefix

string

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.

GoogleFirestoreAdminV1beta2ExportDocumentsResponse

Returned in the google.longrunning.Operation response field.

Fields

Fields
`outputUriPrefix`	`string` 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.

outputUriPrefix

string

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.

GoogleFirestoreAdminV1beta2Field

Represents a single field in the database. Fields are grouped by their "Collection Group", which represent all collections in the database with the same id.

Fields

Fields
`indexConfig`	`object (GoogleFirestoreAdminV1beta2IndexConfig)` 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.
`name`	`string` 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.

indexConfig

object (GoogleFirestoreAdminV1beta2IndexConfig)

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.

name

string

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 namedaddress.city, not the map keycityin the fieldaddress.``represents a field named, not any field. A specialFieldcontains 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 thisFieldwill be applied to all fields which do not have their ownField` index configuration.

GoogleFirestoreAdminV1beta2FieldOperationMetadata

Metadata for google.longrunning.Operation results from FirestoreAdmin.UpdateField.

Fields
`bytesProgress`	`object (GoogleFirestoreAdminV1beta2Progress)` The progress, in bytes, of this operation.
`documentProgress`	`object (GoogleFirestoreAdminV1beta2Progress)` The progress, in documents, of this operation.
`endTime`	`string (Timestamp format)` The time this operation completed. Will be unset if operation still in progress.
`field`	`string` The field resource that this operation is acting on. For example: `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}`
`indexConfigDeltas[]`	`object (GoogleFirestoreAdminV1beta2IndexConfigDelta)` A list of IndexConfigDelta, which describe the intent of this operation.
`startTime`	`string (Timestamp format)` The time this operation started.
`state`	`enum` The state of the operation.
Enum type. Can be one of the following:
`OPERATION_STATE_UNSPECIFIED`	Unspecified.
`INITIALIZING`	Request is being prepared for processing.
`PROCESSING`	Request is actively being processed.
`CANCELLING`	Request is in the process of being cancelled after user called google.longrunning.Operations.CancelOperation on the operation.
`FINALIZING`	Request has been processed and is in its finalization stage.
`SUCCESSFUL`	Request has completed successfully.
`FAILED`	Request has finished being processed, but encountered an error.
`CANCELLED`	Request has finished being cancelled after user called google.longrunning.Operations.CancelOperation.

GoogleFirestoreAdminV1beta2ImportDocumentsMetadata

Metadata for google.longrunning.Operation results from FirestoreAdmin.ImportDocuments.

Fields
`collectionIds[]`	`string` Which collection ids are being imported.
`endTime`	`string (Timestamp format)` The time this operation completed. Will be unset if operation still in progress.
`inputUriPrefix`	`string` The location of the documents being imported.
`operationState`	`enum` The state of the import operation.
Enum type. Can be one of the following:
`OPERATION_STATE_UNSPECIFIED`	Unspecified.
`INITIALIZING`	Request is being prepared for processing.
`PROCESSING`	Request is actively being processed.
`CANCELLING`	Request is in the process of being cancelled after user called google.longrunning.Operations.CancelOperation on the operation.
`FINALIZING`	Request has been processed and is in its finalization stage.
`SUCCESSFUL`	Request has completed successfully.
`FAILED`	Request has finished being processed, but encountered an error.
`CANCELLED`	Request has finished being cancelled after user called google.longrunning.Operations.CancelOperation.

`progressBytes`	`object (GoogleFirestoreAdminV1beta2Progress)` The progress, in bytes, of this operation.
`progressDocuments`	`object (GoogleFirestoreAdminV1beta2Progress)` The progress, in documents, of this operation.
`startTime`	`string (Timestamp format)` The time this operation started.

GoogleFirestoreAdminV1beta2ImportDocumentsRequest

The request for FirestoreAdmin.ImportDocuments.

Fields

Fields
`collectionIds[]`	`string` Which collection ids to import. Unspecified means all collections included in the import.
`inputUriPrefix`	`string` 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.v1beta2.ExportDocumentsResponse.output_uri_prefix.

collectionIds[]

string

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

inputUriPrefix

string

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.v1beta2.ExportDocumentsResponse.output_uri_prefix.

GoogleFirestoreAdminV1beta2Index

Cloud Firestore indexes enable simple and complex queries against documents in a database.

Fields
`fields[]`	`object (GoogleFirestoreAdminV1beta2IndexField)` 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.
`name`	`string` 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.
`queryScope`	`enum` 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.
Enum type. Can be one of the following:
`QUERY_SCOPE_UNSPECIFIED`	The query scope is unspecified. Not a valid option.
`COLLECTION`	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`	Indexes with a collection group query scope specified allow queries against all collections that has the collection id specified by the index.

`state`	`enum` Output only. The serving state of the index.
Enum type. Can be one of the following:
`STATE_UNSPECIFIED`	The state is unspecified.
`CREATING`	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`	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`	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.

GoogleFirestoreAdminV1beta2IndexConfig

The index configuration for this field.

Fields
`ancestorField`	`string` 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).
`indexes[]`	`object (GoogleFirestoreAdminV1beta2Index)` The indexes supported for this field.
`reverting`	`boolean` 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`.
`usesAncestorConfig`	`boolean` 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.

GoogleFirestoreAdminV1beta2IndexConfigDelta

Information about an index configuration change.

Fields
`changeType`	`enum` Specifies how the index is changing.
Enum type. Can be one of the following:
`CHANGE_TYPE_UNSPECIFIED`	The type of change is not specified or known.
`ADD`	The single field index is being added.
`REMOVE`	The single field index is being removed.

`index`	`object (GoogleFirestoreAdminV1beta2Index)` The index being changed.

GoogleFirestoreAdminV1beta2IndexField

A field in an index. The field_path describes which field is indexed, the value_mode describes how the field value is indexed.

Fields
`arrayConfig`	`enum` Indicates that this field supports operations on `array_value`s.
Enum type. Can be one of the following:
`ARRAY_CONFIG_UNSPECIFIED`	The index does not support additional array queries.
`CONTAINS`	The index supports array containment queries.

`fieldPath`	`string` Can be name. For single field indexes, this must match the name of the field or may be omitted.
`order`	`enum` Indicates that this field supports ordering by the specified order or comparing using =, <, <=, >, >=.
Enum type. Can be one of the following:
`ORDER_UNSPECIFIED`	The ordering is unspecified. Not a valid option.
`ASCENDING`	The field is ordered by ascending field value.
`DESCENDING`	The field is ordered by descending field value.

GoogleFirestoreAdminV1beta2IndexOperationMetadata

Metadata for google.longrunning.Operation results from FirestoreAdmin.CreateIndex.

Fields
`endTime`	`string (Timestamp format)` The time this operation completed. Will be unset if operation still in progress.
`index`	`string` The index resource that this operation is acting on. For example: `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}`
`progressBytes`	`object (GoogleFirestoreAdminV1beta2Progress)` The progress, in bytes, of this operation.
`progressDocuments`	`object (GoogleFirestoreAdminV1beta2Progress)` The progress, in documents, of this operation.
`startTime`	`string (Timestamp format)` The time this operation started.
`state`	`enum` The state of the operation.
Enum type. Can be one of the following:
`OPERATION_STATE_UNSPECIFIED`	Unspecified.
`INITIALIZING`	Request is being prepared for processing.
`PROCESSING`	Request is actively being processed.
`CANCELLING`	Request is in the process of being cancelled after user called google.longrunning.Operations.CancelOperation on the operation.
`FINALIZING`	Request has been processed and is in its finalization stage.
`SUCCESSFUL`	Request has completed successfully.
`FAILED`	Request has finished being processed, but encountered an error.
`CANCELLED`	Request has finished being cancelled after user called google.longrunning.Operations.CancelOperation.

GoogleFirestoreAdminV1beta2ListFieldsResponse

The response for FirestoreAdmin.ListFields.

Fields

Fields
`fields[]`	`object (GoogleFirestoreAdminV1beta2Field)` The requested fields.
`nextPageToken`	`string` A page token that may be used to request another page of results. If blank, this is the last page.

fields[]

object (GoogleFirestoreAdminV1beta2Field)

The requested fields.

nextPageToken

string

A page token that may be used to request another page of results. If blank, this is the last page.

GoogleFirestoreAdminV1beta2ListIndexesResponse

The response for FirestoreAdmin.ListIndexes.

Fields

Fields
`indexes[]`	`object (GoogleFirestoreAdminV1beta2Index)` The requested indexes.
`nextPageToken`	`string` A page token that may be used to request another page of results. If blank, this is the last page.

indexes[]

object (GoogleFirestoreAdminV1beta2Index)

The requested indexes.

nextPageToken

string

A page token that may be used to request another page of results. If blank, this is the last page.

GoogleFirestoreAdminV1beta2Progress

Describes the progress of the operation. Unit of work is generic and must be interpreted based on where Progress is used.

Fields

Fields
`completedWork`	`string (int64 format)` The amount of work completed.
`estimatedWork`	`string (int64 format)` The amount of work estimated.

completedWork

string (int64 format)

The amount of work completed.

estimatedWork

string (int64 format)

The amount of work estimated.

GoogleLongrunningOperation

This resource represents a long-running operation that is the result of a network API call.

Fields
`done`	`boolean` If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
`error`	`object (Status)` The error result of the operation in case of failure or cancellation.
`metadata`	`map (key: string, value: any)` Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
`name`	`string` The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
`response`	`map (key: string, value: any)` The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.

Status

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

Fields

Fields
`code`	`integer (int32 format)` The status code, which should be an enum value of google.rpc.Code.
`details[]`	`object` A list of messages that carry the error details. There is a common set of message types for APIs to use.
`message`	`string` A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

code

integer (int32 format)

The status code, which should be an enum value of google.rpc.Code.

details[]

object

A list of messages that carry the error details. There is a common set of message types for APIs to use.

message

string

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.