Class GrpcDocumentsStub (4.6.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

Inherited Members

DocumentsStub.close()

DocumentsStub.createDocumentCallable()

DocumentsStub.createDocumentOperationCallable()

DocumentsStub.deleteDocumentCallable()

DocumentsStub.deleteDocumentOperationCallable()

DocumentsStub.exportDocumentCallable()

DocumentsStub.exportDocumentOperationCallable()

DocumentsStub.getDocumentCallable()

DocumentsStub.getOperationsStub()

DocumentsStub.importDocumentsCallable()

DocumentsStub.importDocumentsOperationCallable()

DocumentsStub.listDocumentsCallable()

DocumentsStub.listDocumentsPagedCallable()

DocumentsStub.reloadDocumentCallable()

DocumentsStub.reloadDocumentOperationCallable()

DocumentsStub.updateDocumentCallable()

DocumentsStub.updateDocumentOperationCallable()

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

DocumentsStub.close()

createDocumentCallable()

public UnaryCallable<CreateDocumentRequest,Operation> createDocumentCallable()

Returns

Type	Description
UnaryCallable<CreateDocumentRequest,Operation>

Overrides

DocumentsStub.createDocumentCallable()

createDocumentOperationCallable()

public OperationCallable<CreateDocumentRequest,Document,KnowledgeOperationMetadata> createDocumentOperationCallable()

Returns

Type	Description
OperationCallable<CreateDocumentRequest,Document,KnowledgeOperationMetadata>

Overrides

DocumentsStub.createDocumentOperationCallable()

deleteDocumentCallable()

public UnaryCallable<DeleteDocumentRequest,Operation> deleteDocumentCallable()

Returns

Type	Description
UnaryCallable<DeleteDocumentRequest,Operation>

Overrides

DocumentsStub.deleteDocumentCallable()

deleteDocumentOperationCallable()

public OperationCallable<DeleteDocumentRequest,Empty,KnowledgeOperationMetadata> deleteDocumentOperationCallable()

Returns

Type	Description
OperationCallable<DeleteDocumentRequest,Empty,KnowledgeOperationMetadata>

Overrides

DocumentsStub.deleteDocumentOperationCallable()

exportDocumentCallable()

public UnaryCallable<ExportDocumentRequest,Operation> exportDocumentCallable()

Returns

Type	Description
UnaryCallable<ExportDocumentRequest,Operation>

Overrides

DocumentsStub.exportDocumentCallable()

exportDocumentOperationCallable()

public OperationCallable<ExportDocumentRequest,Document,KnowledgeOperationMetadata> exportDocumentOperationCallable()

Returns

Type	Description
OperationCallable<ExportDocumentRequest,Document,KnowledgeOperationMetadata>

Overrides

DocumentsStub.exportDocumentOperationCallable()

getDocumentCallable()

public UnaryCallable<GetDocumentRequest,Document> getDocumentCallable()

Returns

Type	Description
UnaryCallable<GetDocumentRequest,Document>

Overrides

DocumentsStub.getDocumentCallable()

getOperationsStub()

public GrpcOperationsStub getOperationsStub()

Returns

Type	Description
GrpcOperationsStub

Overrides

DocumentsStub.getOperationsStub()

importDocumentsCallable()

public UnaryCallable<ImportDocumentsRequest,Operation> importDocumentsCallable()

Returns

Type	Description
UnaryCallable<ImportDocumentsRequest,Operation>

Overrides

DocumentsStub.importDocumentsCallable()

importDocumentsOperationCallable()

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

Returns

Type	Description
OperationCallable<ImportDocumentsRequest,ImportDocumentsResponse,KnowledgeOperationMetadata>

Overrides

DocumentsStub.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

DocumentsStub.listDocumentsCallable()

listDocumentsPagedCallable()

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

Returns

Type	Description
UnaryCallable<ListDocumentsRequest,ListDocumentsPagedResponse>

Overrides

DocumentsStub.listDocumentsPagedCallable()

reloadDocumentCallable()

public UnaryCallable<ReloadDocumentRequest,Operation> reloadDocumentCallable()

Returns

Type	Description
UnaryCallable<ReloadDocumentRequest,Operation>

Overrides

DocumentsStub.reloadDocumentCallable()

reloadDocumentOperationCallable()

public OperationCallable<ReloadDocumentRequest,Document,KnowledgeOperationMetadata> reloadDocumentOperationCallable()

Returns

Type	Description
OperationCallable<ReloadDocumentRequest,Document,KnowledgeOperationMetadata>

Overrides

DocumentsStub.reloadDocumentOperationCallable()

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateDocumentCallable()

public UnaryCallable<UpdateDocumentRequest,Operation> updateDocumentCallable()

Returns

Type	Description
UnaryCallable<UpdateDocumentRequest,Operation>

Overrides

DocumentsStub.updateDocumentCallable()

updateDocumentOperationCallable()

public OperationCallable<UpdateDocumentRequest,Document,KnowledgeOperationMetadata> updateDocumentOperationCallable()

Returns

Type	Description
OperationCallable<UpdateDocumentRequest,Document,KnowledgeOperationMetadata>

Overrides

DocumentsStub.updateDocumentOperationCallable()