public static final class FirestoreAdminGrpc.FirestoreAdminBlockingStub extends AbstractBlockingStub<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.
Inheritance
java.lang.Object >
io.grpc.stub.AbstractStub >
io.grpc.stub.AbstractBlockingStub >
FirestoreAdminGrpc.FirestoreAdminBlockingStub
Inherited Members
io.grpc.stub.AbstractBlockingStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel)
io.grpc.stub.AbstractBlockingStub.<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.FirestoreAdminBlockingStub build(Channel channel, CallOptions callOptions)
| Parameters |
| Name |
Description |
channel |
io.grpc.Channel
|
callOptions |
io.grpc.CallOptions
|
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)
bulkDeleteDocuments(BulkDeleteDocumentsRequest request)
public Operation bulkDeleteDocuments(BulkDeleteDocumentsRequest request)
Bulk deletes a subset of documents from Google Cloud Firestore.
Documents created or updated after the underlying system starts to process
the request will not be deleted. The bulk delete occurs in the background
and its progress can be monitored and managed via the Operation resource
that is created.
For more details on bulk delete behavior, refer to:
https://cloud.google.com/firestore/docs/manage-data/bulk-delete
createBackupSchedule(CreateBackupScheduleRequest request)
public BackupSchedule createBackupSchedule(CreateBackupScheduleRequest request)
Creates a backup schedule on a database.
At most two backup schedules can be configured on a database, one daily
backup schedule and one weekly backup schedule.
createDatabase(CreateDatabaseRequest request)
public Operation createDatabase(CreateDatabaseRequest request)
createIndex(CreateIndexRequest request)
public Operation createIndex(CreateIndexRequest request)
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.
deleteBackup(DeleteBackupRequest request)
public Empty deleteBackup(DeleteBackupRequest request)
| Returns |
| Type |
Description |
Empty |
|
deleteBackupSchedule(DeleteBackupScheduleRequest request)
public Empty deleteBackupSchedule(DeleteBackupScheduleRequest request)
Deletes a backup schedule.
| Returns |
| Type |
Description |
Empty |
|
deleteDatabase(DeleteDatabaseRequest request)
public Operation deleteDatabase(DeleteDatabaseRequest request)
deleteIndex(DeleteIndexRequest request)
public Empty deleteIndex(DeleteIndexRequest request)
Deletes a composite index.
| Returns |
| Type |
Description |
Empty |
|
exportDocuments(ExportDocumentsRequest request)
public Operation exportDocuments(ExportDocumentsRequest request)
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
getBackup(GetBackupRequest request)
public Backup getBackup(GetBackupRequest request)
Gets information about a backup.
| Returns |
| Type |
Description |
Backup |
|
getBackupSchedule(GetBackupScheduleRequest request)
public BackupSchedule getBackupSchedule(GetBackupScheduleRequest request)
Gets information about a backup schedule.
getDatabase(GetDatabaseRequest request)
public Database getDatabase(GetDatabaseRequest request)
Gets information about a database.
getField(GetFieldRequest request)
public Field getField(GetFieldRequest request)
Gets the metadata and configuration for a Field.
| Returns |
| Type |
Description |
Field |
|
getIndex(GetIndexRequest request)
public Index getIndex(GetIndexRequest request)
| Returns |
| Type |
Description |
Index |
|
importDocuments(ImportDocumentsRequest request)
public Operation importDocuments(ImportDocumentsRequest request)
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.
listBackupSchedules(ListBackupSchedulesRequest request)
public ListBackupSchedulesResponse listBackupSchedules(ListBackupSchedulesRequest request)
listBackups(ListBackupsRequest request)
public ListBackupsResponse listBackups(ListBackupsRequest request)
listDatabases(ListDatabasesRequest request)
public ListDatabasesResponse listDatabases(ListDatabasesRequest request)
List all the databases in the project.
listFields(ListFieldsRequest request)
public ListFieldsResponse listFields(ListFieldsRequest request)
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 or
ttlConfig:*.
listIndexes(ListIndexesRequest request)
public ListIndexesResponse listIndexes(ListIndexesRequest request)
restoreDatabase(RestoreDatabaseRequest request)
public Operation restoreDatabase(RestoreDatabaseRequest request)
Creates a new database by restoring from an existing backup.
The new database must be in the same cloud region or multi-region location
as the existing backup. This behaves similar to
FirestoreAdmin.CreateDatabase
except instead of creating a new empty database, a new database is created
with the database type, index configuration, and documents from an existing
backup.
The long-running operation can be used to
track the progress of the restore, with the Operation's
metadata field type being the
RestoreDatabaseMetadata.
The response type is the
Database if the restore was
successful. The new database is not readable or writeable until the LRO has
completed.
updateBackupSchedule(UpdateBackupScheduleRequest request)
public BackupSchedule updateBackupSchedule(UpdateBackupScheduleRequest request)
Updates a backup schedule.
updateDatabase(UpdateDatabaseRequest request)
public Operation updateDatabase(UpdateDatabaseRequest request)
updateField(UpdateFieldRequest request)
public Operation updateField(UpdateFieldRequest request)
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/*.
