Firestore Admin v1 API - Namespace Google.Cloud.Firestore.Admin.V1 (3.2.0)

Classes

CollectionGroupName

Resource name for the CollectionGroup resource.

CreateIndexRequest

The request for [FirestoreAdmin.CreateIndex][google.firestore.admin.v1.FirestoreAdmin.CreateIndex].

Database

A Cloud Firestore Database. Currently only one database is allowed per cloud project; this database must have a database_id of '(default)'.

Database.Types

Container for nested types declared in the Database message type.

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.

The TTL (time-to-live) configuration for documents that have this Field set. Storing a timestamp value into a TTL-enabled field will be treated as the document's absolute expiration time. Using any other data type or leaving the field absent will disable the TTL for the individual document.

Field.Types.TtlConfig.Types

Container for nested types declared in the TtlConfig message type.

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.

FieldOperationMetadata.Types.TtlConfigDelta

Information about an TTL configuration change.

FieldOperationMetadata.Types.TtlConfigDelta.Types

Container for nested types declared in the TtlConfigDelta message type.

FirestoreAdmin

The Cloud Firestore Admin API.

This API provides several administrative services for Cloud Firestore.

Project, Database, Namespace, Collection, Collection Group, and Document are used as defined in the Google Cloud Firestore API.

Operation: An Operation represents work being performed in the background.

The index service manages Cloud Firestore indexes.

Index creation is performed asynchronously. An Operation resource is created for each such asynchronous operation. The state of the operation (including any errors encountered) may be queried via the Operation resource.

The Operations collection provides a record of actions performed for the specified Project (including any Operations in progress). Operations are not created directly but through calls on other collections or resources.

An Operation that is done may be deleted so that it is no longer listed as part of the Operation collection. Operations are garbage collected after 30 days. By default, ListOperations will only return in progress and failed operations. To list completed operation, issue a ListOperations request with the filter done: true.

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.

GetDatabaseRequest

The request for [FirestoreAdmin.GetDatabase][google.firestore.admin.v1.FirestoreAdmin.GetDatabase].

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

ListDatabasesRequest

A request to list the Firestore Databases in all locations for a project.

ListDatabasesResponse

The list of databases for a project.

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

LocationName

Resource name for the Location resource.

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.

UpdateDatabaseMetadata

Metadata related to the update database operation.

UpdateDatabaseRequest

The request for [FirestoreAdmin.UpdateDatabase][google.firestore.admin.v1.FirestoreAdmin.UpdateDatabase].

UpdateFieldRequest

The request for [FirestoreAdmin.UpdateField][google.firestore.admin.v1.FirestoreAdmin.UpdateField].

Enums

CollectionGroupName.ResourceNameType

The possible contents of CollectionGroupName.

Database.Types.AppEngineIntegrationMode

The type of App Engine integration mode.

Database.Types.ConcurrencyMode

The type of concurrency control mode for transactions.

Database.Types.DatabaseType

The type of the database. See https://cloud.google.com/datastore/docs/firestore-or-datastore for information about how to choose.

Mode changes are only allowed if the database is empty.

DatabaseName.ResourceNameType

The possible contents of DatabaseName.

Field.Types.TtlConfig.Types.State

The state of applying the TTL configuration to all documents.

FieldName.ResourceNameType

The possible contents of FieldName.

FieldOperationMetadata.Types.IndexConfigDelta.Types.ChangeType

Specifies how the index is changing.

FieldOperationMetadata.Types.TtlConfigDelta.Types.ChangeType

Specifies how the TTL config is changing.

Index.Types.ApiScope

API Scope defines the APIs (Firestore Native, or Firestore in Datastore Mode) that are supported for queries.

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.