google.firestore.admin.v1

ARRAY_CONFIG_UNSPECIFIED

The index does not support additional array queries.

CONTAINS

The index supports array containment queries.

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.

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.

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.

parent

string

A parent name of the form projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}

index

Object

The composite index to create.

This object should have the same structure as Index

name

string

A name of the form projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}

name

string

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

collectionIds

Array of 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.

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

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.

This object should have the same structure as IndexConfig

name

string

A name of the form projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_id}

name

string

A name of the form projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}

name

string

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

collectionIds

Array of 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.v1.ExportDocumentsResponse.output_uri_prefix.

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

number

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.

The number should be among the values of QueryScope

fields

Array of Object

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.

This object should have the same structure as IndexField

state

number

Output only. The serving state of the index.

The number should be among the values of State

indexes

Array of Object

The indexes supported for this field.

This object should have the same structure as Index

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.

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

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.

fieldPath

string

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

order

number

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

The number should be among the values of Order

arrayConfig

number

Indicates that this field supports operations on array_values.

The number should be among the values of ArrayConfig

parent

string

A parent name of the form projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}

filter

string

The filter to apply to list results. Currently, FirestoreAdmin.ListFields only supports listing fields that have been explicitly overridden. To issue this query, call FirestoreAdmin.ListFields with the filter set to indexConfig.usesAncestorConfig:false.

pageSize

number

The number of results to return.

pageToken

string

A page token, returned from a previous call to FirestoreAdmin.ListFields, that may be used to get the next page of results.

fields

Array of Object

The requested fields.

This object should have the same structure as Field

nextPageToken

string

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

parent

string

A parent name of the form projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}

filter

string

The filter to apply to list results.

pageSize

number

The number of results to return.

pageToken

string

A page token, returned from a previous call to FirestoreAdmin.ListIndexes, that may be used to get the next page of results.

indexes

Array of Object

The requested indexes.

This object should have the same structure as Index

nextPageToken

string

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

field

Object

The field to be updated.

This object should have the same structure as Field

updateMask

Object

A mask, relative to the field. If specified, only configuration specified by this field_mask will be updated in the field.

This object should have the same structure as FieldMask