Namespace com.google.firestore.admin.v1

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

DatabaseName

DatabaseName.Builder

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

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

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

FieldProto

FirestoreAdminGrpc

Operations are created by service FirestoreAdmin, but are accessed via service google.longrunning.Operations.

FirestoreAdminGrpc.FirestoreAdminBlockingStub

Operations are created by service FirestoreAdmin, but are accessed via service google.longrunning.Operations.

FirestoreAdminGrpc.FirestoreAdminFutureStub

Operations are created by service FirestoreAdmin, but are accessed via service google.longrunning.Operations.

FirestoreAdminGrpc.FirestoreAdminImplBase

Operations are created by service FirestoreAdmin, but are accessed via service google.longrunning.Operations.

FirestoreAdminGrpc.FirestoreAdminStub

Operations are created by service FirestoreAdmin, but are accessed via service google.longrunning.Operations.

FirestoreAdminProto

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

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

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

DeleteIndexRequestOrBuilder

ExportDocumentsMetadataOrBuilder

ExportDocumentsRequestOrBuilder

ExportDocumentsResponseOrBuilder

Field.IndexConfigOrBuilder

FieldOperationMetadata.IndexConfigDeltaOrBuilder

FieldOperationMetadataOrBuilder

FieldOrBuilder

GetFieldRequestOrBuilder

GetIndexRequestOrBuilder

ImportDocumentsMetadataOrBuilder

ImportDocumentsRequestOrBuilder

Index.IndexFieldOrBuilder

IndexOperationMetadataOrBuilder

IndexOrBuilder

ListFieldsRequestOrBuilder

ListFieldsResponseOrBuilder

ListIndexesRequestOrBuilder

ListIndexesResponseOrBuilder

LocationMetadataOrBuilder

ProgressOrBuilder

UpdateFieldRequestOrBuilder

Enums

FieldOperationMetadata.IndexConfigDelta.ChangeType

Specifies how the index is changing.

Protobuf enum google.firestore.admin.v1.FieldOperationMetadata.IndexConfigDelta.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