google.firestore.admin. v1
Enumerations
ArrayConfig
number
The supported array value configurations.
Value |
|
---|---|
ARRAY_CONFIG_UNSPECIFIED |
The index does not support additional array queries. |
CONTAINS |
The index supports array containment queries. |
Order
number
The supported orderings.
Value |
|
---|---|
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. |
QueryScope
number
Query Scope defines the scope at which a query is run. This is specified on a StructuredQuery's from
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
number
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.
Value |
|
---|---|
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. |
Properties
ArrayConfig
number
The supported array value configurations.
Value |
|
---|---|
ARRAY_CONFIG_UNSPECIFIED |
The index does not support additional array queries. |
CONTAINS |
The index supports array containment queries. |
Order
number
The supported orderings.
Value |
|
---|---|
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. |
QueryScope
number
Query Scope defines the scope at which a query is run. This is specified on a StructuredQuery's from
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
number
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.
Value |
|
---|---|
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. |
Abstract types
CreateIndexRequest
The request for FirestoreAdmin.CreateIndex.
Properties
Parameter |
|
---|---|
parent |
string A parent name of the form
|
index |
Object The composite index to create. This object should have the same structure as Index |
DeleteIndexRequest
The request for FirestoreAdmin.DeleteIndex.
Property
Parameter |
|
---|---|
name |
string A name of the form
|
ExportDocumentsRequest
The request for FirestoreAdmin.ExportDocuments.
Properties
Parameter |
|
---|---|
name |
string Database to export. Should be of the form:
|
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: |
Field
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.
Properties
Parameter |
|
---|---|
name |
string A field name of the form
A field path may be a simple field name, e.g. Field paths may be quoted using Examples: (Note: Comments here are written in markdown syntax, so there is an additional layer of backticks to represent a code block)
A special |
indexConfig |
Object The index configuration for this field. If unset, field indexing will
revert to the configuration defined by the This object should have the same structure as IndexConfig |
GetFieldRequest
The request for FirestoreAdmin.GetField.
Property
Parameter |
|
---|---|
name |
string A name of the form
|
GetIndexRequest
The request for FirestoreAdmin.GetIndex.
Property
Parameter |
|
---|---|
name |
string A name of the form
|
ImportDocumentsRequest
The request for FirestoreAdmin.ImportDocuments.
Properties
Parameter |
|
---|---|
name |
string Database to import into. Should be of the form:
|
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. |
Index
Cloud Firestore indexes enable simple and complex queries against documents in a database.
Properties
Parameter |
|
---|---|
name |
string Output only.
A server defined name for this index.
The form of this name for composite indexes will be:
|
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 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 |
IndexConfig
The index configuration for this field.
Properties
Parameter |
|
---|---|
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 |
ancestorField |
string Output only.
Specifies the resource name of the |
reverting |
boolean Output only When true, the |
IndexField
A field in an index. The field_path describes which field is indexed, the value_mode describes how the field value is indexed.
Properties
Parameter |
|
---|---|
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 The number should be among the values of ArrayConfig |
ListFieldsRequest
The request for FirestoreAdmin.ListFields.
Properties
Parameter |
|
---|---|
parent |
string A parent name of the form
|
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
|
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. |
ListFieldsResponse
The response for FirestoreAdmin.ListFields.
Properties
Parameter |
|
---|---|
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. |
ListIndexesRequest
The request for FirestoreAdmin.ListIndexes.
Properties
Parameter |
|
---|---|
parent |
string A parent name of the form
|
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. |
ListIndexesResponse
The response for FirestoreAdmin.ListIndexes.
Properties
Parameter |
|
---|---|
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. |
UpdateFieldRequest
The request for FirestoreAdmin.UpdateField.
Properties
Parameter |
|
---|---|
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 |