Classes
CollectionGroupName
Resource name for the CollectionGroup resource.
CreateIndexRequest
The request for [FirestoreAdmin.CreateIndex][google.firestore.admin.v1.FirestoreAdmin.CreateIndex].
DatabaseName
Resource name for the Database resource.
DeleteIndexRequest
The request for [FirestoreAdmin.DeleteIndex][google.firestore.admin.v1.FirestoreAdmin.DeleteIndex].
ExportDocumentsMetadata
Metadata for [google.longrunning.Operation][google.longrunning.Operation] results from [FirestoreAdmin.ExportDocuments][google.firestore.admin.v1.FirestoreAdmin.ExportDocuments].
ExportDocumentsRequest
The request for [FirestoreAdmin.ExportDocuments][google.firestore.admin.v1.FirestoreAdmin.ExportDocuments].
ExportDocumentsResponse
Returned in the [google.longrunning.Operation][google.longrunning.Operation] response field.
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.
Field.Types
Container for nested types declared in the Field message type.
Field.Types.IndexConfig
The index configuration for this field.
FieldName
Resource name for the Field resource.
FieldOperationMetadata
Metadata for [google.longrunning.Operation][google.longrunning.Operation] results from [FirestoreAdmin.UpdateField][google.firestore.admin.v1.FirestoreAdmin.UpdateField].
FieldOperationMetadata.Types
Container for nested types declared in the FieldOperationMetadata message type.
FieldOperationMetadata.Types.IndexConfigDelta
Information about an index configuration change.
FieldOperationMetadata.Types.IndexConfigDelta.Types
Container for nested types declared in the IndexConfigDelta message type.
FirestoreAdmin
Operations are created by service FirestoreAdmin, but are accessed via
service google.longrunning.Operations.
FirestoreAdmin.FirestoreAdminBase
Base class for server-side implementations of FirestoreAdmin
FirestoreAdmin.FirestoreAdminClient
Client for FirestoreAdmin
FirestoreAdminClient
FirestoreAdmin client wrapper, for convenient use.
FirestoreAdminClientBuilder
Builder class for FirestoreAdminClient to provide simple configuration of credentials, endpoint etc.
FirestoreAdminClientImpl
FirestoreAdmin client wrapper implementation, for convenient use.
FirestoreAdminSettings
Settings for FirestoreAdminClient instances.
GetFieldRequest
The request for [FirestoreAdmin.GetField][google.firestore.admin.v1.FirestoreAdmin.GetField].
GetIndexRequest
The request for [FirestoreAdmin.GetIndex][google.firestore.admin.v1.FirestoreAdmin.GetIndex].
ImportDocumentsMetadata
Metadata for [google.longrunning.Operation][google.longrunning.Operation] results from [FirestoreAdmin.ImportDocuments][google.firestore.admin.v1.FirestoreAdmin.ImportDocuments].
ImportDocumentsRequest
The request for [FirestoreAdmin.ImportDocuments][google.firestore.admin.v1.FirestoreAdmin.ImportDocuments].
Index
Cloud Firestore indexes enable simple and complex queries against documents in a database.
Index.Types
Container for nested types declared in the Index message type.
Index.Types.IndexField
A field in an index. The field_path describes which field is indexed, the value_mode describes how the field value is indexed.
Index.Types.IndexField.Types
Container for nested types declared in the IndexField message type.
IndexName
Resource name for the Index resource.
IndexOperationMetadata
Metadata for [google.longrunning.Operation][google.longrunning.Operation] results from [FirestoreAdmin.CreateIndex][google.firestore.admin.v1.FirestoreAdmin.CreateIndex].
ListFieldsRequest
The request for [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields].
ListFieldsResponse
The response for [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields].
ListIndexesRequest
The request for [FirestoreAdmin.ListIndexes][google.firestore.admin.v1.FirestoreAdmin.ListIndexes].
ListIndexesResponse
The response for [FirestoreAdmin.ListIndexes][google.firestore.admin.v1.FirestoreAdmin.ListIndexes].
LocationMetadata
The metadata message for [google.cloud.location.Location.metadata][google.cloud.location.Location.metadata].
Progress
Describes 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.
UpdateFieldRequest
The request for [FirestoreAdmin.UpdateField][google.firestore.admin.v1.FirestoreAdmin.UpdateField].
Enums
CollectionGroupName.ResourceNameType
The possible contents of CollectionGroupName.
DatabaseName.ResourceNameType
The possible contents of DatabaseName.
FieldName.ResourceNameType
The possible contents of FieldName.
FieldOperationMetadata.Types.IndexConfigDelta.Types.ChangeType
Specifies how the index is changing.
Index.Types.IndexField.Types.ArrayConfig
The supported array value configurations.
Index.Types.IndexField.Types.Order
The supported orderings.
Index.Types.IndexField.ValueModeOneofCase
Enum of possible cases for the "value_mode" oneof.
Index.Types.QueryScope
Query Scope defines the scope at which a query is run. This is specified on
a StructuredQuery's from field.
Index.Types.State
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.
IndexName.ResourceNameType
The possible contents of IndexName.
OperationState
Describes the state of the operation.