Package com.google.firestore.admin.v1 (3.9.3)

Classes

CollectionGroupName

CollectionGroupName.Builder

Builder for projects/{project}/databases/{database}/collectionGroups/{collection}.

CreateIndexRequest

The request for FirestoreAdmin.CreateIndex.

Protobuf type google.firestore.admin.v1.CreateIndexRequest

CreateIndexRequest.Builder

The request for FirestoreAdmin.CreateIndex.

Protobuf type google.firestore.admin.v1.CreateIndexRequest

Database

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

Protobuf type google.firestore.admin.v1.Database

Database.Builder

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

Protobuf type google.firestore.admin.v1.Database

DatabaseName

DatabaseName.Builder

Builder for projects/{project}/databases/{database}.

DatabaseProto

DeleteIndexRequest

The request for FirestoreAdmin.DeleteIndex.

Protobuf type google.firestore.admin.v1.DeleteIndexRequest

DeleteIndexRequest.Builder

The request for FirestoreAdmin.DeleteIndex.

Protobuf type google.firestore.admin.v1.DeleteIndexRequest

ExportDocumentsMetadata

Metadata for google.longrunning.Operation results from FirestoreAdmin.ExportDocuments.

Protobuf type google.firestore.admin.v1.ExportDocumentsMetadata

ExportDocumentsMetadata.Builder

Metadata for google.longrunning.Operation results from FirestoreAdmin.ExportDocuments.

Protobuf type google.firestore.admin.v1.ExportDocumentsMetadata

ExportDocumentsRequest

The request for FirestoreAdmin.ExportDocuments.

Protobuf type google.firestore.admin.v1.ExportDocumentsRequest

ExportDocumentsRequest.Builder

The request for FirestoreAdmin.ExportDocuments.

Protobuf type google.firestore.admin.v1.ExportDocumentsRequest

ExportDocumentsResponse

Returned in the google.longrunning.Operation response field.

Protobuf type google.firestore.admin.v1.ExportDocumentsResponse

ExportDocumentsResponse.Builder

Returned in the google.longrunning.Operation response field.

Protobuf type google.firestore.admin.v1.ExportDocumentsResponse

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.

Protobuf type google.firestore.admin.v1.Field

Field.Builder

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.

Protobuf type google.firestore.admin.v1.Field

Field.IndexConfig

The index configuration for this field.

Protobuf type google.firestore.admin.v1.Field.IndexConfig

Field.IndexConfig.Builder

The index configuration for this field.

Protobuf type google.firestore.admin.v1.Field.IndexConfig

Field.TtlConfig

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.

Protobuf type google.firestore.admin.v1.Field.TtlConfig

Field.TtlConfig.Builder

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.

Protobuf type google.firestore.admin.v1.Field.TtlConfig

FieldName

FieldName.Builder

Builder for projects/{project}/databases/{database}/collectionGroups/{collection}/fields/{field}.

FieldOperationMetadata

Metadata for google.longrunning.Operation results from FirestoreAdmin.UpdateField.

Protobuf type google.firestore.admin.v1.FieldOperationMetadata

FieldOperationMetadata.Builder

Metadata for google.longrunning.Operation results from FirestoreAdmin.UpdateField.

Protobuf type google.firestore.admin.v1.FieldOperationMetadata

FieldOperationMetadata.IndexConfigDelta

Information about an index configuration change.

Protobuf type google.firestore.admin.v1.FieldOperationMetadata.IndexConfigDelta

FieldOperationMetadata.IndexConfigDelta.Builder

Information about an index configuration change.

Protobuf type google.firestore.admin.v1.FieldOperationMetadata.IndexConfigDelta

FieldOperationMetadata.TtlConfigDelta

Information about an TTL configuration change.

Protobuf type google.firestore.admin.v1.FieldOperationMetadata.TtlConfigDelta

FieldOperationMetadata.TtlConfigDelta.Builder

Information about an TTL configuration change.

Protobuf type google.firestore.admin.v1.FieldOperationMetadata.TtlConfigDelta

FieldProto

FirestoreAdminGrpc

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.

FirestoreAdminGrpc.FirestoreAdminBlockingStub

A stub to allow clients to do synchronous rpc calls to service 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.

FirestoreAdminGrpc.FirestoreAdminFutureStub

A stub to allow clients to do ListenableFuture-style rpc calls to service 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.

FirestoreAdminGrpc.FirestoreAdminImplBase

Base class for the server implementation of the service 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.

FirestoreAdminGrpc.FirestoreAdminStub

A stub to allow clients to do asynchronous rpc calls to service 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.

FirestoreAdminProto

GetDatabaseRequest

The request for FirestoreAdmin.GetDatabase.

Protobuf type google.firestore.admin.v1.GetDatabaseRequest

GetDatabaseRequest.Builder

The request for FirestoreAdmin.GetDatabase.

Protobuf type google.firestore.admin.v1.GetDatabaseRequest

GetFieldRequest

The request for FirestoreAdmin.GetField.

Protobuf type google.firestore.admin.v1.GetFieldRequest

GetFieldRequest.Builder

The request for FirestoreAdmin.GetField.

Protobuf type google.firestore.admin.v1.GetFieldRequest

GetIndexRequest

The request for FirestoreAdmin.GetIndex.

Protobuf type google.firestore.admin.v1.GetIndexRequest

GetIndexRequest.Builder

The request for FirestoreAdmin.GetIndex.

Protobuf type google.firestore.admin.v1.GetIndexRequest

ImportDocumentsMetadata

Metadata for google.longrunning.Operation results from FirestoreAdmin.ImportDocuments.

Protobuf type google.firestore.admin.v1.ImportDocumentsMetadata

ImportDocumentsMetadata.Builder

Metadata for google.longrunning.Operation results from FirestoreAdmin.ImportDocuments.

Protobuf type google.firestore.admin.v1.ImportDocumentsMetadata

ImportDocumentsRequest

The request for FirestoreAdmin.ImportDocuments.

Protobuf type google.firestore.admin.v1.ImportDocumentsRequest

ImportDocumentsRequest.Builder

The request for FirestoreAdmin.ImportDocuments.

Protobuf type google.firestore.admin.v1.ImportDocumentsRequest

Index

Cloud Firestore indexes enable simple and complex queries against documents in a database.

Protobuf type google.firestore.admin.v1.Index

Index.Builder

Cloud Firestore indexes enable simple and complex queries against documents in a database.

Protobuf type google.firestore.admin.v1.Index

Index.IndexField

A field in an index. The field_path describes which field is indexed, the value_mode describes how the field value is indexed.

Protobuf type google.firestore.admin.v1.Index.IndexField

Index.IndexField.Builder

A field in an index. The field_path describes which field is indexed, the value_mode describes how the field value is indexed.

Protobuf type google.firestore.admin.v1.Index.IndexField

IndexName

IndexName.Builder

Builder for projects/{project}/databases/{database}/collectionGroups/{collection}/indexes/{index}.

IndexOperationMetadata

Metadata for google.longrunning.Operation results from FirestoreAdmin.CreateIndex.

Protobuf type google.firestore.admin.v1.IndexOperationMetadata

IndexOperationMetadata.Builder

Metadata for google.longrunning.Operation results from FirestoreAdmin.CreateIndex.

Protobuf type google.firestore.admin.v1.IndexOperationMetadata

IndexProto

ListDatabasesRequest

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

Protobuf type google.firestore.admin.v1.ListDatabasesRequest

ListDatabasesRequest.Builder

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

Protobuf type google.firestore.admin.v1.ListDatabasesRequest

ListDatabasesResponse

The list of databases for a project.

Protobuf type google.firestore.admin.v1.ListDatabasesResponse

ListDatabasesResponse.Builder

The list of databases for a project.

Protobuf type google.firestore.admin.v1.ListDatabasesResponse

ListFieldsRequest

The request for FirestoreAdmin.ListFields.

Protobuf type google.firestore.admin.v1.ListFieldsRequest

ListFieldsRequest.Builder

The request for FirestoreAdmin.ListFields.

Protobuf type google.firestore.admin.v1.ListFieldsRequest

ListFieldsResponse

The response for FirestoreAdmin.ListFields.

Protobuf type google.firestore.admin.v1.ListFieldsResponse

ListFieldsResponse.Builder

The response for FirestoreAdmin.ListFields.

Protobuf type google.firestore.admin.v1.ListFieldsResponse

ListIndexesRequest

The request for FirestoreAdmin.ListIndexes.

Protobuf type google.firestore.admin.v1.ListIndexesRequest

ListIndexesRequest.Builder

The request for FirestoreAdmin.ListIndexes.

Protobuf type google.firestore.admin.v1.ListIndexesRequest

ListIndexesResponse

The response for FirestoreAdmin.ListIndexes.

Protobuf type google.firestore.admin.v1.ListIndexesResponse

ListIndexesResponse.Builder

The response for FirestoreAdmin.ListIndexes.

Protobuf type google.firestore.admin.v1.ListIndexesResponse

LocationMetadata

The metadata message for google.cloud.location.Location.metadata.

Protobuf type google.firestore.admin.v1.LocationMetadata

LocationMetadata.Builder

The metadata message for google.cloud.location.Location.metadata.

Protobuf type google.firestore.admin.v1.LocationMetadata

LocationProto

OperationProto

ParentName

AUTO-GENERATED DOCUMENTATION AND CLASS

ParentName.Builder

Builder for ParentName.

Progress

Describes the progress of the operation. Unit of work is generic and must be interpreted based on where Progress is used.

Protobuf type google.firestore.admin.v1.Progress

Progress.Builder

Describes the progress of the operation. Unit of work is generic and must be interpreted based on where Progress is used.

Protobuf type google.firestore.admin.v1.Progress

ProjectName

ProjectName.Builder

Builder for projects/{project}.

UpdateDatabaseMetadata

Metadata related to the update database operation.

Protobuf type google.firestore.admin.v1.UpdateDatabaseMetadata

UpdateDatabaseMetadata.Builder

Metadata related to the update database operation.

Protobuf type google.firestore.admin.v1.UpdateDatabaseMetadata

UpdateDatabaseRequest

The request for FirestoreAdmin.UpdateDatabase.

Protobuf type google.firestore.admin.v1.UpdateDatabaseRequest

UpdateDatabaseRequest.Builder

The request for FirestoreAdmin.UpdateDatabase.

Protobuf type google.firestore.admin.v1.UpdateDatabaseRequest

UpdateFieldRequest

The request for FirestoreAdmin.UpdateField.

Protobuf type google.firestore.admin.v1.UpdateFieldRequest

UpdateFieldRequest.Builder

The request for FirestoreAdmin.UpdateField.

Protobuf type google.firestore.admin.v1.UpdateFieldRequest

Interfaces

CreateIndexRequestOrBuilder

DatabaseOrBuilder

DeleteIndexRequestOrBuilder

ExportDocumentsMetadataOrBuilder

ExportDocumentsRequestOrBuilder

ExportDocumentsResponseOrBuilder

Field.IndexConfigOrBuilder

Field.TtlConfigOrBuilder

FieldOperationMetadata.IndexConfigDeltaOrBuilder

FieldOperationMetadata.TtlConfigDeltaOrBuilder

FieldOperationMetadataOrBuilder

FieldOrBuilder

FirestoreAdminGrpc.AsyncService

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.

GetDatabaseRequestOrBuilder

GetFieldRequestOrBuilder

GetIndexRequestOrBuilder

ImportDocumentsMetadataOrBuilder

ImportDocumentsRequestOrBuilder

Index.IndexFieldOrBuilder

IndexOperationMetadataOrBuilder

IndexOrBuilder

ListDatabasesRequestOrBuilder

ListDatabasesResponseOrBuilder

ListFieldsRequestOrBuilder

ListFieldsResponseOrBuilder

ListIndexesRequestOrBuilder

ListIndexesResponseOrBuilder

LocationMetadataOrBuilder

ProgressOrBuilder

UpdateDatabaseMetadataOrBuilder

UpdateDatabaseRequestOrBuilder

UpdateFieldRequestOrBuilder

Enums

Database.AppEngineIntegrationMode

The type of App Engine integration mode.

Protobuf enum google.firestore.admin.v1.Database.AppEngineIntegrationMode

Database.ConcurrencyMode

The type of concurrency control mode for transactions.

Protobuf enum google.firestore.admin.v1.Database.ConcurrencyMode

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

Protobuf enum google.firestore.admin.v1.Database.DatabaseType

Field.TtlConfig.State

The state of applying the TTL configuration to all documents.

Protobuf enum google.firestore.admin.v1.Field.TtlConfig.State

FieldOperationMetadata.IndexConfigDelta.ChangeType

Specifies how the index is changing.

Protobuf enum google.firestore.admin.v1.FieldOperationMetadata.IndexConfigDelta.ChangeType

FieldOperationMetadata.TtlConfigDelta.ChangeType

Specifies how the TTL config is changing.

Protobuf enum google.firestore.admin.v1.FieldOperationMetadata.TtlConfigDelta.ChangeType

Index.IndexField.ArrayConfig

The supported array value configurations.

Protobuf enum google.firestore.admin.v1.Index.IndexField.ArrayConfig

Index.IndexField.Order

The supported orderings.

Protobuf enum google.firestore.admin.v1.Index.IndexField.Order

Index.IndexField.ValueModeCase

Index.QueryScope

Query Scope defines the scope at which a query is run. This is specified on a StructuredQuery's from field.

Protobuf enum google.firestore.admin.v1.Index.QueryScope

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

Protobuf enum google.firestore.admin.v1.Index.State

OperationState

Describes the state of the operation.

Protobuf enum google.firestore.admin.v1.OperationState