com.google.firestore.admin.v1

Class FirestoreAdminGrpc.FirestoreAdminImplBase

java.lang.Object

com.google.firestore.admin.v1.FirestoreAdminGrpc.FirestoreAdminImplBase

All Implemented Interfaces:

io.grpc.BindableService

Enclosing class:

FirestoreAdminGrpc

public abstract static class FirestoreAdminGrpc.FirestoreAdminImplBase
extends Object
implements io.grpc.BindableService

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

Constructor Summary

Constructors

Constructor and Description
FirestoreAdminImplBase()

Method Summary

Modifier and Type	Method and Description
io.grpc.ServerServiceDefinition	bindService()
void	createIndex(CreateIndexRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver) Creates a composite index.
void	deleteIndex(DeleteIndexRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver) Deletes a composite index.
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.
void	getField(GetFieldRequest request, io.grpc.stub.StreamObserver<Field> responseObserver) Gets the metadata and configuration for a Field.
void	getIndex(GetIndexRequest request, io.grpc.stub.StreamObserver<Index> responseObserver) Gets a composite index.
void	importDocuments(ImportDocumentsRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver) Imports documents into Google Cloud Firestore.
void	listFields(ListFieldsRequest request, io.grpc.stub.StreamObserver<ListFieldsResponse> responseObserver) Lists the field configuration and metadata for this database.
void	listIndexes(ListIndexesRequest request, io.grpc.stub.StreamObserver<ListIndexesResponse> responseObserver) Lists composite indexes.
void	updateField(UpdateFieldRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver) Updates a field configuration.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FirestoreAdminImplBase

public FirestoreAdminImplBase()

Method Detail

createIndex

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

listIndexes

public void listIndexes(ListIndexesRequest request,
                        io.grpc.stub.StreamObserver<ListIndexesResponse> responseObserver)

 Lists composite indexes.
 

getIndex

public void getIndex(GetIndexRequest request,
                     io.grpc.stub.StreamObserver<Index> responseObserver)

 Gets a composite index.
 

deleteIndex

public void deleteIndex(DeleteIndexRequest request,
                        io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)

 Deletes a composite index.
 

getField

public void getField(GetFieldRequest request,
                     io.grpc.stub.StreamObserver<Field> responseObserver)

 Gets the metadata and configuration for a Field.
 

updateField

public 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/*`.
 

listFields

public 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`.
 

exportDocuments

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

importDocuments

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

bindService

public final io.grpc.ServerServiceDefinition bindService()

Specified by:

bindService in interface io.grpc.BindableService