Class FirestoreAdminGrpc (3.12.1)

public final class FirestoreAdminGrpc

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 > FirestoreAdminGrpc

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

SERVICE_NAME

public static final String SERVICE_NAME

Field Value
Type	Description
`String`

Static Methods

bindService(FirestoreAdminGrpc.AsyncService service)

public static final ServerServiceDefinition bindService(FirestoreAdminGrpc.AsyncService service)

Parameter
Name	Description
`service`	`FirestoreAdminGrpc.AsyncService`

Returns
Type	Description
`io.grpc.ServerServiceDefinition`

getCreateIndexMethod()

public static MethodDescriptor<CreateIndexRequest,Operation> getCreateIndexMethod()

Returns
Type	Description
`io.grpc.MethodDescriptor<CreateIndexRequest,Operation>`

getDeleteIndexMethod()

public static MethodDescriptor<DeleteIndexRequest,Empty> getDeleteIndexMethod()

Returns
Type	Description
`io.grpc.MethodDescriptor<DeleteIndexRequest,Empty>`

getExportDocumentsMethod()

public static MethodDescriptor<ExportDocumentsRequest,Operation> getExportDocumentsMethod()

Returns
Type	Description
`io.grpc.MethodDescriptor<ExportDocumentsRequest,Operation>`

getGetDatabaseMethod()

public static MethodDescriptor<GetDatabaseRequest,Database> getGetDatabaseMethod()

Returns
Type	Description
`io.grpc.MethodDescriptor<GetDatabaseRequest,Database>`

getGetFieldMethod()

public static MethodDescriptor<GetFieldRequest,Field> getGetFieldMethod()

Returns
Type	Description
`io.grpc.MethodDescriptor<GetFieldRequest,Field>`

getGetIndexMethod()

public static MethodDescriptor<GetIndexRequest,Index> getGetIndexMethod()

Returns
Type	Description
`io.grpc.MethodDescriptor<GetIndexRequest,Index>`

getImportDocumentsMethod()

public static MethodDescriptor<ImportDocumentsRequest,Operation> getImportDocumentsMethod()

Returns
Type	Description
`io.grpc.MethodDescriptor<ImportDocumentsRequest,Operation>`

getListDatabasesMethod()

public static MethodDescriptor<ListDatabasesRequest,ListDatabasesResponse> getListDatabasesMethod()

Returns
Type	Description
`io.grpc.MethodDescriptor<ListDatabasesRequest,ListDatabasesResponse>`

getListFieldsMethod()

public static MethodDescriptor<ListFieldsRequest,ListFieldsResponse> getListFieldsMethod()

Returns
Type	Description
`io.grpc.MethodDescriptor<ListFieldsRequest,ListFieldsResponse>`

getListIndexesMethod()

public static MethodDescriptor<ListIndexesRequest,ListIndexesResponse> getListIndexesMethod()

Returns
Type	Description
`io.grpc.MethodDescriptor<ListIndexesRequest,ListIndexesResponse>`

getServiceDescriptor()

public static ServiceDescriptor getServiceDescriptor()

Returns
Type	Description
`io.grpc.ServiceDescriptor`

getUpdateDatabaseMethod()

public static MethodDescriptor<UpdateDatabaseRequest,Operation> getUpdateDatabaseMethod()

Returns
Type	Description
`io.grpc.MethodDescriptor<UpdateDatabaseRequest,Operation>`

getUpdateFieldMethod()

public static MethodDescriptor<UpdateFieldRequest,Operation> getUpdateFieldMethod()

Returns
Type	Description
`io.grpc.MethodDescriptor<UpdateFieldRequest,Operation>`

newBlockingStub(Channel channel)

public static FirestoreAdminGrpc.FirestoreAdminBlockingStub newBlockingStub(Channel channel)

Creates a new blocking-style stub that supports unary and streaming output calls on the service

Parameter
Name	Description
`channel`	`io.grpc.Channel`

Returns
Type	Description
`FirestoreAdminGrpc.FirestoreAdminBlockingStub`

newFutureStub(Channel channel)

public static FirestoreAdminGrpc.FirestoreAdminFutureStub newFutureStub(Channel channel)

Creates a new ListenableFuture-style stub that supports unary calls on the service

Parameter
Name	Description
`channel`	`io.grpc.Channel`

Returns
Type	Description
`FirestoreAdminGrpc.FirestoreAdminFutureStub`

newStub(Channel channel)

public static FirestoreAdminGrpc.FirestoreAdminStub newStub(Channel channel)

Creates a new async stub that supports all call types for the service

Parameter
Name	Description
`channel`	`io.grpc.Channel`

Returns
Type	Description
`FirestoreAdminGrpc.FirestoreAdminStub`