Class GrpcDocumentsStub (4.46.0)

public class GrpcDocumentsStub extends DocumentsStub

gRPC stub implementation for the Documents service API.

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

Inheritance

java.lang.Object > DocumentsStub > GrpcDocumentsStub

Static Methods

create(ClientContext clientContext)

public static final GrpcDocumentsStub create(ClientContext clientContext)
Parameter
Name Description
clientContext ClientContext
Returns
Type Description
GrpcDocumentsStub
Exceptions
Type Description
IOException

create(ClientContext clientContext, GrpcStubCallableFactory callableFactory)

public static final GrpcDocumentsStub create(ClientContext clientContext, GrpcStubCallableFactory callableFactory)
Parameters
Name Description
clientContext ClientContext
callableFactory GrpcStubCallableFactory
Returns
Type Description
GrpcDocumentsStub
Exceptions
Type Description
IOException

create(DocumentsStubSettings settings)

public static final GrpcDocumentsStub create(DocumentsStubSettings settings)
Parameter
Name Description
settings DocumentsStubSettings
Returns
Type Description
GrpcDocumentsStub
Exceptions
Type Description
IOException

Constructors

GrpcDocumentsStub(DocumentsStubSettings settings, ClientContext clientContext)

protected GrpcDocumentsStub(DocumentsStubSettings settings, ClientContext clientContext)

Constructs an instance of GrpcDocumentsStub, 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 DocumentsStubSettings
clientContext ClientContext

GrpcDocumentsStub(DocumentsStubSettings settings, ClientContext clientContext, GrpcStubCallableFactory callableFactory)

protected GrpcDocumentsStub(DocumentsStubSettings settings, ClientContext clientContext, GrpcStubCallableFactory callableFactory)

Constructs an instance of GrpcDocumentsStub, 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 DocumentsStubSettings
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

close()

public final void close()
Overrides

createDocumentCallable()

public UnaryCallable<CreateDocumentRequest,Operation> createDocumentCallable()
Returns
Type Description
UnaryCallable<CreateDocumentRequest,Operation>
Overrides

createDocumentOperationCallable()

public OperationCallable<CreateDocumentRequest,Document,KnowledgeOperationMetadata> createDocumentOperationCallable()
Returns
Type Description
OperationCallable<CreateDocumentRequest,Document,KnowledgeOperationMetadata>
Overrides

deleteDocumentCallable()

public UnaryCallable<DeleteDocumentRequest,Operation> deleteDocumentCallable()
Returns
Type Description
UnaryCallable<DeleteDocumentRequest,Operation>
Overrides

deleteDocumentOperationCallable()

public OperationCallable<DeleteDocumentRequest,Empty,KnowledgeOperationMetadata> deleteDocumentOperationCallable()
Returns
Type Description
OperationCallable<DeleteDocumentRequest,Empty,KnowledgeOperationMetadata>
Overrides

exportDocumentCallable()

public UnaryCallable<ExportDocumentRequest,Operation> exportDocumentCallable()
Returns
Type Description
UnaryCallable<ExportDocumentRequest,Operation>
Overrides

exportDocumentOperationCallable()

public OperationCallable<ExportDocumentRequest,Document,KnowledgeOperationMetadata> exportDocumentOperationCallable()
Returns
Type Description
OperationCallable<ExportDocumentRequest,Document,KnowledgeOperationMetadata>
Overrides

getDocumentCallable()

public UnaryCallable<GetDocumentRequest,Document> getDocumentCallable()
Returns
Type Description
UnaryCallable<GetDocumentRequest,Document>
Overrides

getLocationCallable()

public UnaryCallable<GetLocationRequest,Location> getLocationCallable()
Returns
Type Description
UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>
Overrides

getOperationsStub()

public GrpcOperationsStub getOperationsStub()
Returns
Type Description
GrpcOperationsStub
Overrides

importDocumentsCallable()

public UnaryCallable<ImportDocumentsRequest,Operation> importDocumentsCallable()
Returns
Type Description
UnaryCallable<ImportDocumentsRequest,Operation>
Overrides

importDocumentsOperationCallable()

public OperationCallable<ImportDocumentsRequest,ImportDocumentsResponse,KnowledgeOperationMetadata> importDocumentsOperationCallable()
Returns
Type Description
OperationCallable<ImportDocumentsRequest,ImportDocumentsResponse,KnowledgeOperationMetadata>
Overrides

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

listDocumentsPagedCallable()

public UnaryCallable<ListDocumentsRequest,DocumentsClient.ListDocumentsPagedResponse> listDocumentsPagedCallable()
Returns
Type Description
UnaryCallable<ListDocumentsRequest,ListDocumentsPagedResponse>
Overrides

listLocationsCallable()

public UnaryCallable<ListLocationsRequest,ListLocationsResponse> listLocationsCallable()
Returns
Type Description
UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse>
Overrides

listLocationsPagedCallable()

public UnaryCallable<ListLocationsRequest,DocumentsClient.ListLocationsPagedResponse> listLocationsPagedCallable()
Returns
Type Description
UnaryCallable<com.google.cloud.location.ListLocationsRequest,ListLocationsPagedResponse>
Overrides

reloadDocumentCallable()

public UnaryCallable<ReloadDocumentRequest,Operation> reloadDocumentCallable()
Returns
Type Description
UnaryCallable<ReloadDocumentRequest,Operation>
Overrides

reloadDocumentOperationCallable()

public OperationCallable<ReloadDocumentRequest,Document,KnowledgeOperationMetadata> reloadDocumentOperationCallable()
Returns
Type Description
OperationCallable<ReloadDocumentRequest,Document,KnowledgeOperationMetadata>
Overrides

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateDocumentCallable()

public UnaryCallable<UpdateDocumentRequest,Operation> updateDocumentCallable()
Returns
Type Description
UnaryCallable<UpdateDocumentRequest,Operation>
Overrides

updateDocumentOperationCallable()

public OperationCallable<UpdateDocumentRequest,Document,KnowledgeOperationMetadata> updateDocumentOperationCallable()
Returns
Type Description
OperationCallable<UpdateDocumentRequest,Document,KnowledgeOperationMetadata>
Overrides