public static interface 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`.
| Modifier and Type | Method and Description |
|---|---|
default void |
createIndex(CreateIndexRequest request,
io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
Creates a composite index.
|
default void |
deleteIndex(DeleteIndexRequest request,
io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)
Deletes a composite index.
|
default void |
exportDocuments(ExportDocumentsRequest request,
io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
Exports a copy of all or a subset of documents from Google Cloud Firestore
to another storage system, such as Google Cloud Storage.
|
default void |
getDatabase(GetDatabaseRequest request,
io.grpc.stub.StreamObserver<Database> responseObserver)
Gets information about a database.
|
default void |
getField(GetFieldRequest request,
io.grpc.stub.StreamObserver<Field> responseObserver)
Gets the metadata and configuration for a Field.
|
default void |
getIndex(GetIndexRequest request,
io.grpc.stub.StreamObserver<Index> responseObserver)
Gets a composite index.
|
default void |
importDocuments(ImportDocumentsRequest request,
io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
Imports documents into Google Cloud Firestore.
|
default void |
listDatabases(ListDatabasesRequest request,
io.grpc.stub.StreamObserver<ListDatabasesResponse> responseObserver)
List all the databases in the project.
|
default void |
listFields(ListFieldsRequest request,
io.grpc.stub.StreamObserver<ListFieldsResponse> responseObserver)
Lists the field configuration and metadata for this database.
|
default void |
listIndexes(ListIndexesRequest request,
io.grpc.stub.StreamObserver<ListIndexesResponse> responseObserver)
Lists composite indexes.
|
default void |
updateDatabase(UpdateDatabaseRequest request,
io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
Updates a database.
|
default void |
updateField(UpdateFieldRequest request,
io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
Updates a field configuration.
|
default void createIndex(CreateIndexRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
Creates a composite index. This returns a [google.longrunning.Operation][google.longrunning.Operation] which may be used to track the status of the creation. The metadata for the operation will be the type [IndexOperationMetadata][google.firestore.admin.v1.IndexOperationMetadata].
default void listIndexes(ListIndexesRequest request, io.grpc.stub.StreamObserver<ListIndexesResponse> responseObserver)
Lists composite indexes.
default void getIndex(GetIndexRequest request, io.grpc.stub.StreamObserver<Index> responseObserver)
Gets a composite index.
default void deleteIndex(DeleteIndexRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)
Deletes a composite index.
default void getField(GetFieldRequest request, io.grpc.stub.StreamObserver<Field> responseObserver)
Gets the metadata and configuration for a Field.
default void updateField(UpdateFieldRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
Updates a field configuration. Currently, field updates apply only to
single field index configuration. However, calls to
[FirestoreAdmin.UpdateField][google.firestore.admin.v1.FirestoreAdmin.UpdateField] should provide a field mask to avoid
changing any configuration that the caller isn't aware of. The field mask
should be specified as: `{ paths: "index_config" }`.
This call returns a [google.longrunning.Operation][google.longrunning.Operation] which may be used to
track the status of the field update. The metadata for
the operation will be the type [FieldOperationMetadata][google.firestore.admin.v1.FieldOperationMetadata].
To configure the default field settings for the database, use
the special `Field` with resource name:
`projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*`.
default void listFields(ListFieldsRequest request, io.grpc.stub.StreamObserver<ListFieldsResponse> responseObserver)
Lists the field configuration and metadata for this database. Currently, [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields] only supports listing fields that have been explicitly overridden. To issue this query, call [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields] with the filter set to `indexConfig.usesAncestorConfig:false` .
default void exportDocuments(ExportDocumentsRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
Exports a copy of all or a subset of documents from Google Cloud Firestore to another storage system, such as Google Cloud Storage. Recent updates to documents may not be reflected in the export. The export occurs in the background and its progress can be monitored and managed via the Operation resource that is created. The output of an export may only be used once the associated operation is done. If an export operation is cancelled before completion it may leave partial data behind in Google Cloud Storage. For more details on export behavior and output format, refer to: https://cloud.google.com/firestore/docs/manage-data/export-import
default void importDocuments(ImportDocumentsRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
Imports documents into Google Cloud Firestore. Existing documents with the same name are overwritten. The import occurs in the background and its progress can be monitored and managed via the Operation resource that is created. If an ImportDocuments operation is cancelled, it is possible that a subset of the data has already been imported to Cloud Firestore.
default void getDatabase(GetDatabaseRequest request, io.grpc.stub.StreamObserver<Database> responseObserver)
Gets information about a database.
default void listDatabases(ListDatabasesRequest request, io.grpc.stub.StreamObserver<ListDatabasesResponse> responseObserver)
List all the databases in the project.
default void updateDatabase(UpdateDatabaseRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
Updates a database.
Copyright © 2023 Google LLC. All rights reserved.