string

Which collection ids are being exported.

string (Timestamp format)

The time this operation completed. Will be unset if operation still in progress.

enum

The state of the export operation.

string

Where the entities are being exported to.

object (GoogleFirestoreAdminV1beta2Progress)

The progress, in bytes, of this operation.

object (GoogleFirestoreAdminV1beta2Progress)

The progress, in documents, of this operation.

string (Timestamp format)

The time this operation started.

string

Which collection ids to export. Unspecified means all collections.

string

The output URI. Currently only supports Google Cloud Storage URIs of the form:gs://BUCKET_NAME[/NAMESPACE_PATH], whereBUCKET_NAME is the name of the Google Cloud Storage bucket andNAMESPACE_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.

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.

object (GoogleFirestoreAdminV1beta2IndexConfig)

The index configuration for this field. If unset, field indexing will revert to the configuration defined by theancestor_field. To explicitly remove all indexes for this field, specify an index config with an empty list of indexes.

string

A field name of the formprojects/{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.

object (GoogleFirestoreAdminV1beta2Progress)

The progress, in bytes, of this operation.

object (GoogleFirestoreAdminV1beta2Progress)

The progress, in documents, of this operation.

string (Timestamp format)

The time this operation completed. Will be unset if operation still in progress.

string

The field resource that this operation is acting on. For example:projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}

object (GoogleFirestoreAdminV1beta2IndexConfigDelta)

A list of IndexConfigDelta, which describe the intent of this operation.

string (Timestamp format)

The time this operation started.

enum

The state of the operation.

string

Which collection ids are being imported.

string (Timestamp format)

The time this operation completed. Will be unset if operation still in progress.

string

The location of the documents being imported.

enum

The state of the import operation.

object (GoogleFirestoreAdminV1beta2Progress)

The progress, in bytes, of this operation.

object (GoogleFirestoreAdminV1beta2Progress)

The progress, in documents, of this operation.

string (Timestamp format)

The time this operation started.

string

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

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.

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.

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.

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

Output only. The serving state of the index.

string

Output only. Specifies the resource name of theField from which this field's index configuration is set (whenuses_ancestor_config is true), or from which itwould be set if this field had no index configuration (whenuses_ancestor_config is false).

object (GoogleFirestoreAdminV1beta2Index)

The indexes supported for this field.

boolean

Output only When true, theField'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 byancestor_field, at which pointuses_ancestor_config will betrue andreverting will befalse.

boolean

Output only. When true, theField's index configuration is set from the configuration specified by theancestor_field. When false, theField's index configuration is defined explicitly.

enum

Specifies how the index is changing.

object (GoogleFirestoreAdminV1beta2Index)

The index being changed.

enum

Indicates that this field supports operations onarray_values.

string

Can bename. For single field indexes, this must match the name of the field or may be omitted.

enum

Indicates that this field supports ordering by the specified order or comparing using =, <, <=, >, >=.

string (Timestamp format)

The time this operation completed. Will be unset if operation still in progress.

string

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

object (GoogleFirestoreAdminV1beta2Progress)

The progress, in bytes, of this operation.

object (GoogleFirestoreAdminV1beta2Progress)

The progress, in documents, of this operation.

string (Timestamp format)

The time this operation started.

enum

The state of the operation.

object (GoogleFirestoreAdminV1beta2Field)

The requested fields.

string

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

object (GoogleFirestoreAdminV1beta2Index)

The requested indexes.

string

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

string (int64 format)

The amount of work completed.

string (int64 format)

The amount of work estimated.

boolean

If the value isfalse, it means the operation is still in progress. Iftrue, the operation is completed, and eithererror orresponse is available.

object (Status)

The error result of the operation in case of failure or cancellation.

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.

string

The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, thename should be a resource name ending withoperations/{unique_id}.

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 asDelete, the response isgoogle.protobuf.Empty. If the original method is standardGet/Create/Update, the response should be the resource. For other methods, the response should have the typeXxxResponse, whereXxx is the original method name. For example, if the original method name isTakeSnapshot(), the inferred response type isTakeSnapshotResponse.

integer (int32 format)

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

object

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

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.