com.google.cloud.firestore.v1.stub

Class HttpJsonFirestoreAdminStub

java.lang.Object

com.google.cloud.firestore.v1.stub.FirestoreAdminStub

com.google.cloud.firestore.v1.stub.HttpJsonFirestoreAdminStub

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator-java")
 @BetaApi
public class HttpJsonFirestoreAdminStub
extends FirestoreAdminStub

REST stub implementation for the FirestoreAdmin service API.

This class is for advanced usage and reflects the underlying API directly.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HttpJsonFirestoreAdminStub(FirestoreAdminStubSettings settings, com.google.api.gax.rpc.ClientContext clientContext) Constructs an instance of HttpJsonFirestoreAdminStub, using the given settings.
protected	HttpJsonFirestoreAdminStub(FirestoreAdminStubSettings settings, com.google.api.gax.rpc.ClientContext clientContext, com.google.api.gax.httpjson.HttpJsonStubCallableFactory callableFactory) Constructs an instance of HttpJsonFirestoreAdminStub, using the given settings.

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static HttpJsonFirestoreAdminStub	create(com.google.api.gax.rpc.ClientContext clientContext)
static HttpJsonFirestoreAdminStub	create(com.google.api.gax.rpc.ClientContext clientContext, com.google.api.gax.httpjson.HttpJsonStubCallableFactory callableFactory)
static HttpJsonFirestoreAdminStub	create(FirestoreAdminStubSettings settings)
com.google.api.gax.rpc.UnaryCallable<CreateIndexRequest,com.google.longrunning.Operation>	createIndexCallable()
com.google.api.gax.rpc.OperationCallable<CreateIndexRequest,Index,IndexOperationMetadata>	createIndexOperationCallable()
com.google.api.gax.rpc.UnaryCallable<DeleteIndexRequest,com.google.protobuf.Empty>	deleteIndexCallable()
com.google.api.gax.rpc.UnaryCallable<ExportDocumentsRequest,com.google.longrunning.Operation>	exportDocumentsCallable()
com.google.api.gax.rpc.OperationCallable<ExportDocumentsRequest,ExportDocumentsResponse,ExportDocumentsMetadata>	exportDocumentsOperationCallable()
com.google.api.gax.rpc.UnaryCallable<GetDatabaseRequest,Database>	getDatabaseCallable()
com.google.api.gax.rpc.UnaryCallable<GetFieldRequest,Field>	getFieldCallable()
com.google.api.gax.httpjson.longrunning.stub.HttpJsonOperationsStub	getHttpJsonOperationsStub()
com.google.api.gax.rpc.UnaryCallable<GetIndexRequest,Index>	getIndexCallable()
static List<com.google.api.gax.httpjson.ApiMethodDescriptor>	getMethodDescriptors()
com.google.api.gax.rpc.UnaryCallable<ImportDocumentsRequest,com.google.longrunning.Operation>	importDocumentsCallable()
com.google.api.gax.rpc.OperationCallable<ImportDocumentsRequest,com.google.protobuf.Empty,ImportDocumentsMetadata>	importDocumentsOperationCallable()
boolean	isShutdown()
boolean	isTerminated()
com.google.api.gax.rpc.UnaryCallable<ListDatabasesRequest,ListDatabasesResponse>	listDatabasesCallable()
com.google.api.gax.rpc.UnaryCallable<ListFieldsRequest,ListFieldsResponse>	listFieldsCallable()
com.google.api.gax.rpc.UnaryCallable<ListFieldsRequest,FirestoreAdminClient.ListFieldsPagedResponse>	listFieldsPagedCallable()
com.google.api.gax.rpc.UnaryCallable<ListIndexesRequest,ListIndexesResponse>	listIndexesCallable()
com.google.api.gax.rpc.UnaryCallable<ListIndexesRequest,FirestoreAdminClient.ListIndexesPagedResponse>	listIndexesPagedCallable()
void	shutdown()
void	shutdownNow()
com.google.api.gax.rpc.UnaryCallable<UpdateDatabaseRequest,com.google.longrunning.Operation>	updateDatabaseCallable()
com.google.api.gax.rpc.OperationCallable<UpdateDatabaseRequest,Database,UpdateDatabaseMetadata>	updateDatabaseOperationCallable()
com.google.api.gax.rpc.UnaryCallable<UpdateFieldRequest,com.google.longrunning.Operation>	updateFieldCallable()
com.google.api.gax.rpc.OperationCallable<UpdateFieldRequest,Field,FieldOperationMetadata>	updateFieldOperationCallable()

Methods inherited from class com.google.cloud.firestore.v1.stub.FirestoreAdminStub

getOperationsStub

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpJsonFirestoreAdminStub

protected HttpJsonFirestoreAdminStub(FirestoreAdminStubSettings settings,
                                     com.google.api.gax.rpc.ClientContext clientContext)
                              throws IOException

Constructs an instance of HttpJsonFirestoreAdminStub, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Throws:

IOException

HttpJsonFirestoreAdminStub

protected HttpJsonFirestoreAdminStub(FirestoreAdminStubSettings settings,
                                     com.google.api.gax.rpc.ClientContext clientContext,
                                     com.google.api.gax.httpjson.HttpJsonStubCallableFactory callableFactory)
                              throws IOException

Constructs an instance of HttpJsonFirestoreAdminStub, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Throws:

IOException

Method Detail

create

public static final HttpJsonFirestoreAdminStub create(FirestoreAdminStubSettings settings)
                                               throws IOException

Throws:

IOException

create

public static final HttpJsonFirestoreAdminStub create(com.google.api.gax.rpc.ClientContext clientContext)
                                               throws IOException

Throws:

IOException

create

public static final HttpJsonFirestoreAdminStub create(com.google.api.gax.rpc.ClientContext clientContext,
                                                      com.google.api.gax.httpjson.HttpJsonStubCallableFactory callableFactory)
                                               throws IOException

Throws:

IOException

getMethodDescriptors

@InternalApi
public static List<com.google.api.gax.httpjson.ApiMethodDescriptor> getMethodDescriptors()

getHttpJsonOperationsStub

public com.google.api.gax.httpjson.longrunning.stub.HttpJsonOperationsStub getHttpJsonOperationsStub()

Overrides:

getHttpJsonOperationsStub in class FirestoreAdminStub

createIndexCallable

public com.google.api.gax.rpc.UnaryCallable<CreateIndexRequest,com.google.longrunning.Operation> createIndexCallable()

Overrides:

createIndexCallable in class FirestoreAdminStub

createIndexOperationCallable

public com.google.api.gax.rpc.OperationCallable<CreateIndexRequest,Index,IndexOperationMetadata> createIndexOperationCallable()

Overrides:

createIndexOperationCallable in class FirestoreAdminStub

listIndexesCallable

public com.google.api.gax.rpc.UnaryCallable<ListIndexesRequest,ListIndexesResponse> listIndexesCallable()

Overrides:

listIndexesCallable in class FirestoreAdminStub

listIndexesPagedCallable

public com.google.api.gax.rpc.UnaryCallable<ListIndexesRequest,FirestoreAdminClient.ListIndexesPagedResponse> listIndexesPagedCallable()

Overrides:

listIndexesPagedCallable in class FirestoreAdminStub

getIndexCallable

public com.google.api.gax.rpc.UnaryCallable<GetIndexRequest,Index> getIndexCallable()

Overrides:

getIndexCallable in class FirestoreAdminStub

deleteIndexCallable

public com.google.api.gax.rpc.UnaryCallable<DeleteIndexRequest,com.google.protobuf.Empty> deleteIndexCallable()

Overrides:

deleteIndexCallable in class FirestoreAdminStub

getFieldCallable

public com.google.api.gax.rpc.UnaryCallable<GetFieldRequest,Field> getFieldCallable()

Overrides:

getFieldCallable in class FirestoreAdminStub

updateFieldCallable

public com.google.api.gax.rpc.UnaryCallable<UpdateFieldRequest,com.google.longrunning.Operation> updateFieldCallable()

Overrides:

updateFieldCallable in class FirestoreAdminStub

updateFieldOperationCallable

public com.google.api.gax.rpc.OperationCallable<UpdateFieldRequest,Field,FieldOperationMetadata> updateFieldOperationCallable()

Overrides:

updateFieldOperationCallable in class FirestoreAdminStub

listFieldsCallable

public com.google.api.gax.rpc.UnaryCallable<ListFieldsRequest,ListFieldsResponse> listFieldsCallable()

Overrides:

listFieldsCallable in class FirestoreAdminStub

listFieldsPagedCallable

public com.google.api.gax.rpc.UnaryCallable<ListFieldsRequest,FirestoreAdminClient.ListFieldsPagedResponse> listFieldsPagedCallable()

Overrides:

listFieldsPagedCallable in class FirestoreAdminStub

exportDocumentsCallable

public com.google.api.gax.rpc.UnaryCallable<ExportDocumentsRequest,com.google.longrunning.Operation> exportDocumentsCallable()

Overrides:

exportDocumentsCallable in class FirestoreAdminStub

exportDocumentsOperationCallable

public com.google.api.gax.rpc.OperationCallable<ExportDocumentsRequest,ExportDocumentsResponse,ExportDocumentsMetadata> exportDocumentsOperationCallable()

Overrides:

exportDocumentsOperationCallable in class FirestoreAdminStub

importDocumentsCallable

public com.google.api.gax.rpc.UnaryCallable<ImportDocumentsRequest,com.google.longrunning.Operation> importDocumentsCallable()

Overrides:

importDocumentsCallable in class FirestoreAdminStub

importDocumentsOperationCallable

public com.google.api.gax.rpc.OperationCallable<ImportDocumentsRequest,com.google.protobuf.Empty,ImportDocumentsMetadata> importDocumentsOperationCallable()

Overrides:

importDocumentsOperationCallable in class FirestoreAdminStub

getDatabaseCallable

public com.google.api.gax.rpc.UnaryCallable<GetDatabaseRequest,Database> getDatabaseCallable()

Overrides:

getDatabaseCallable in class FirestoreAdminStub

listDatabasesCallable

public com.google.api.gax.rpc.UnaryCallable<ListDatabasesRequest,ListDatabasesResponse> listDatabasesCallable()

Overrides:

listDatabasesCallable in class FirestoreAdminStub

updateDatabaseCallable

public com.google.api.gax.rpc.UnaryCallable<UpdateDatabaseRequest,com.google.longrunning.Operation> updateDatabaseCallable()

Overrides:

updateDatabaseCallable in class FirestoreAdminStub

updateDatabaseOperationCallable

public com.google.api.gax.rpc.OperationCallable<UpdateDatabaseRequest,Database,UpdateDatabaseMetadata> updateDatabaseOperationCallable()

Overrides:

updateDatabaseOperationCallable in class FirestoreAdminStub

close

public final void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in class FirestoreAdminStub

shutdown

public void shutdown()

isShutdown

public boolean isShutdown()

isTerminated

public boolean isTerminated()

shutdownNow

public void shutdownNow()

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Throws:

InterruptedException