Class GrpcDocumentServiceStub (2.45.0)

public class GrpcDocumentServiceStub extends DocumentServiceStub

gRPC stub implementation for the DocumentService service API.

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

Inheritance

java.lang.Object > DocumentServiceStub > GrpcDocumentServiceStub

Inherited Members

DocumentServiceStub.batchDeleteDocumentsCallable()

DocumentServiceStub.batchDeleteDocumentsOperationCallable()

DocumentServiceStub.close()

DocumentServiceStub.getDatasetSchemaCallable()

DocumentServiceStub.getDocumentCallable()

DocumentServiceStub.getHttpJsonOperationsStub()

DocumentServiceStub.getLocationCallable()

DocumentServiceStub.getOperationsStub()

DocumentServiceStub.importDocumentsCallable()

DocumentServiceStub.importDocumentsOperationCallable()

DocumentServiceStub.listDocumentsCallable()

DocumentServiceStub.listDocumentsPagedCallable()

DocumentServiceStub.listLocationsCallable()

DocumentServiceStub.listLocationsPagedCallable()

DocumentServiceStub.updateDatasetCallable()

DocumentServiceStub.updateDatasetOperationCallable()

DocumentServiceStub.updateDatasetSchemaCallable()

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 Methods

create(ClientContext clientContext)

public static final GrpcDocumentServiceStub create(ClientContext clientContext)

Parameter
Name	Description
`clientContext`	`ClientContext`

Returns
Type	Description
`GrpcDocumentServiceStub`

Exceptions
Type	Description
`IOException`

create(ClientContext clientContext, GrpcStubCallableFactory callableFactory)

public static final GrpcDocumentServiceStub create(ClientContext clientContext, GrpcStubCallableFactory callableFactory)

Parameters
Name	Description
`clientContext`	`ClientContext`
`callableFactory`	`GrpcStubCallableFactory`

Returns
Type	Description
`GrpcDocumentServiceStub`

Exceptions
Type	Description
`IOException`

create(DocumentServiceStubSettings settings)

public static final GrpcDocumentServiceStub create(DocumentServiceStubSettings settings)

Parameter
Name	Description
`settings`	`DocumentServiceStubSettings`

Returns
Type	Description
`GrpcDocumentServiceStub`

Exceptions
Type	Description
`IOException`

Constructors

GrpcDocumentServiceStub(DocumentServiceStubSettings settings, ClientContext clientContext)

protected GrpcDocumentServiceStub(DocumentServiceStubSettings settings, ClientContext clientContext)

Constructs an instance of GrpcDocumentServiceStub, 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.

Parameters
Name	Description
`settings`	`DocumentServiceStubSettings`
`clientContext`	`ClientContext`

GrpcDocumentServiceStub(DocumentServiceStubSettings settings, ClientContext clientContext, GrpcStubCallableFactory callableFactory)

protected GrpcDocumentServiceStub(DocumentServiceStubSettings settings, ClientContext clientContext, GrpcStubCallableFactory callableFactory)

Constructs an instance of GrpcDocumentServiceStub, 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.

Parameters
Name	Description
`settings`	`DocumentServiceStubSettings`
`clientContext`	`ClientContext`
`callableFactory`	`GrpcStubCallableFactory`

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)

Parameters
Name	Description
`duration`	`long`
`unit`	`TimeUnit`

Returns
Type	Description
`boolean`

Exceptions
Type	Description
`InterruptedException`

batchDeleteDocumentsCallable()

public UnaryCallable<BatchDeleteDocumentsRequest,Operation> batchDeleteDocumentsCallable()

Returns
Type	Description
`UnaryCallable<BatchDeleteDocumentsRequest,Operation>`

Overrides

DocumentServiceStub.batchDeleteDocumentsCallable()

batchDeleteDocumentsOperationCallable()

public OperationCallable<BatchDeleteDocumentsRequest,BatchDeleteDocumentsResponse,BatchDeleteDocumentsMetadata> batchDeleteDocumentsOperationCallable()

Returns
Type	Description
`OperationCallable<BatchDeleteDocumentsRequest,BatchDeleteDocumentsResponse,BatchDeleteDocumentsMetadata>`

Overrides

DocumentServiceStub.batchDeleteDocumentsOperationCallable()

close()

public final void close()

Overrides

DocumentServiceStub.close()

getDatasetSchemaCallable()

public UnaryCallable<GetDatasetSchemaRequest,DatasetSchema> getDatasetSchemaCallable()

Returns
Type	Description
`UnaryCallable<GetDatasetSchemaRequest,DatasetSchema>`

Overrides

DocumentServiceStub.getDatasetSchemaCallable()

getDocumentCallable()

public UnaryCallable<GetDocumentRequest,GetDocumentResponse> getDocumentCallable()

Returns
Type	Description
`UnaryCallable<GetDocumentRequest,GetDocumentResponse>`

Overrides

DocumentServiceStub.getDocumentCallable()

getLocationCallable()

public UnaryCallable<GetLocationRequest,Location> getLocationCallable()

Returns
Type	Description
`UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>`

Overrides

DocumentServiceStub.getLocationCallable()

getOperationsStub()

public GrpcOperationsStub getOperationsStub()

Returns
Type	Description
`GrpcOperationsStub`

Overrides

DocumentServiceStub.getOperationsStub()

importDocumentsCallable()

public UnaryCallable<ImportDocumentsRequest,Operation> importDocumentsCallable()

Returns
Type	Description
`UnaryCallable<ImportDocumentsRequest,Operation>`

Overrides

DocumentServiceStub.importDocumentsCallable()

importDocumentsOperationCallable()

public OperationCallable<ImportDocumentsRequest,ImportDocumentsResponse,ImportDocumentsMetadata> importDocumentsOperationCallable()

Returns
Type	Description
`OperationCallable<ImportDocumentsRequest,ImportDocumentsResponse,ImportDocumentsMetadata>`

Overrides

DocumentServiceStub.importDocumentsOperationCallable()

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

listDocumentsCallable()

public UnaryCallable<ListDocumentsRequest,ListDocumentsResponse> listDocumentsCallable()

Returns
Type	Description
`UnaryCallable<ListDocumentsRequest,ListDocumentsResponse>`

Overrides

DocumentServiceStub.listDocumentsCallable()

listDocumentsPagedCallable()

public UnaryCallable<ListDocumentsRequest,DocumentServiceClient.ListDocumentsPagedResponse> listDocumentsPagedCallable()

Returns
Type	Description
`UnaryCallable<ListDocumentsRequest,ListDocumentsPagedResponse>`

Overrides

DocumentServiceStub.listDocumentsPagedCallable()

listLocationsCallable()

public UnaryCallable<ListLocationsRequest,ListLocationsResponse> listLocationsCallable()

Returns
Type	Description
`UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse>`

Overrides

DocumentServiceStub.listLocationsCallable()

listLocationsPagedCallable()

public UnaryCallable<ListLocationsRequest,DocumentServiceClient.ListLocationsPagedResponse> listLocationsPagedCallable()

Returns
Type	Description
`UnaryCallable<com.google.cloud.location.ListLocationsRequest,ListLocationsPagedResponse>`

Overrides

DocumentServiceStub.listLocationsPagedCallable()

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateDatasetCallable()

public UnaryCallable<UpdateDatasetRequest,Operation> updateDatasetCallable()

Returns
Type	Description
`UnaryCallable<UpdateDatasetRequest,Operation>`

Overrides

DocumentServiceStub.updateDatasetCallable()

updateDatasetOperationCallable()

public OperationCallable<UpdateDatasetRequest,Dataset,UpdateDatasetOperationMetadata> updateDatasetOperationCallable()

Returns
Type	Description
`OperationCallable<UpdateDatasetRequest,Dataset,UpdateDatasetOperationMetadata>`

Overrides

DocumentServiceStub.updateDatasetOperationCallable()

updateDatasetSchemaCallable()

public UnaryCallable<UpdateDatasetSchemaRequest,DatasetSchema> updateDatasetSchemaCallable()

Returns
Type	Description
`UnaryCallable<UpdateDatasetSchemaRequest,DatasetSchema>`

Overrides

DocumentServiceStub.updateDatasetSchemaCallable()