public static final class FirestoreAdminGrpc.FirestoreAdminStub extends AbstractAsyncStub<FirestoreAdminGrpc.FirestoreAdminStub>
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.
Inheritance
java.lang.Object >
io.grpc.stub.AbstractStub >
io.grpc.stub.AbstractAsyncStub >
FirestoreAdminGrpc.FirestoreAdminStub
Inherited Members
io.grpc.stub.AbstractAsyncStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel)
io.grpc.stub.AbstractAsyncStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel,io.grpc.CallOptions)
io.grpc.stub.AbstractStub.<T>withOption(io.grpc.CallOptions.Key<T>,T)
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)
io.grpc.stub.AbstractStub.getCallOptions()
io.grpc.stub.AbstractStub.getChannel()
io.grpc.stub.AbstractStub.withCallCredentials(io.grpc.CallCredentials)
io.grpc.stub.AbstractStub.withChannel(io.grpc.Channel)
io.grpc.stub.AbstractStub.withCompression(java.lang.String)
io.grpc.stub.AbstractStub.withDeadline(io.grpc.Deadline)
io.grpc.stub.AbstractStub.withDeadlineAfter(long,java.util.concurrent.TimeUnit)
io.grpc.stub.AbstractStub.withExecutor(java.util.concurrent.Executor)
io.grpc.stub.AbstractStub.withInterceptors(io.grpc.ClientInterceptor...)
io.grpc.stub.AbstractStub.withMaxInboundMessageSize(int)
io.grpc.stub.AbstractStub.withMaxOutboundMessageSize(int)
io.grpc.stub.AbstractStub.withWaitForReady()
Methods
build(Channel channel, CallOptions callOptions)
protected FirestoreAdminGrpc.FirestoreAdminStub build(Channel channel, CallOptions callOptions)
Parameters
| Name | Description |
channel | io.grpc.Channel
|
callOptions | io.grpc.CallOptions
|
Returns
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)
createIndex(CreateIndexRequest request, StreamObserver<Operation> responseObserver)
public void createIndex(CreateIndexRequest request, StreamObserver<Operation> responseObserver)
Creates a composite index. This returns a google.longrunning.Operation
which may be used to track the status of the creation. The metadata for
the operation will be the type IndexOperationMetadata.
deleteIndex(DeleteIndexRequest request, StreamObserver<Empty> responseObserver)
public void deleteIndex(DeleteIndexRequest request, StreamObserver<Empty> responseObserver)
Deletes a composite index.
exportDocuments(ExportDocumentsRequest request, StreamObserver<Operation> responseObserver)
public void exportDocuments(ExportDocumentsRequest request, StreamObserver<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
getDatabase(GetDatabaseRequest request, StreamObserver<Database> responseObserver)
public void getDatabase(GetDatabaseRequest request, StreamObserver<Database> responseObserver)
Gets information about a database.
getField(GetFieldRequest request, StreamObserver<Field> responseObserver)
public void getField(GetFieldRequest request, StreamObserver<Field> responseObserver)
Gets the metadata and configuration for a Field.
getIndex(GetIndexRequest request, StreamObserver<Index> responseObserver)
public void getIndex(GetIndexRequest request, StreamObserver<Index> responseObserver)
Parameters
importDocuments(ImportDocumentsRequest request, StreamObserver<Operation> responseObserver)
public void importDocuments(ImportDocumentsRequest request, StreamObserver<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.
listDatabases(ListDatabasesRequest request, StreamObserver<ListDatabasesResponse> responseObserver)
public void listDatabases(ListDatabasesRequest request, StreamObserver<ListDatabasesResponse> responseObserver)
List all the databases in the project.
listFields(ListFieldsRequest request, StreamObserver<ListFieldsResponse> responseObserver)
public void listFields(ListFieldsRequest request, StreamObserver<ListFieldsResponse> responseObserver)
Lists the field configuration and metadata for this database.
Currently, FirestoreAdmin.ListFields only supports listing fields
that have been explicitly overridden. To issue this query, call
FirestoreAdmin.ListFields with the filter set to
indexConfig.usesAncestorConfig:false .
listIndexes(ListIndexesRequest request, StreamObserver<ListIndexesResponse> responseObserver)
public void listIndexes(ListIndexesRequest request, StreamObserver<ListIndexesResponse> responseObserver)
Parameters
updateDatabase(UpdateDatabaseRequest request, StreamObserver<Operation> responseObserver)
public void updateDatabase(UpdateDatabaseRequest request, StreamObserver<Operation> responseObserver)
Parameters
updateField(UpdateFieldRequest request, StreamObserver<Operation> responseObserver)
public void updateField(UpdateFieldRequest request, StreamObserver<Operation> responseObserver)
Updates a field configuration. Currently, field updates apply only to
single field index configuration. However, calls to
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 which may be used to
track the status of the field update. The metadata for
the operation will be the type 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/*.
