Class DocumentServiceGrpc.DocumentServiceFutureStub (2.53.0)

public static final class DocumentServiceGrpc.DocumentServiceFutureStub extends AbstractFutureStub<DocumentServiceGrpc.DocumentServiceFutureStub>

A stub to allow clients to do ListenableFuture-style rpc calls to service DocumentService.

Service to call Cloud DocumentAI to manage document collection (dataset).

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractFutureStub > DocumentServiceGrpc.DocumentServiceFutureStub

Inherited Members

io.grpc.stub.AbstractFutureStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel)

io.grpc.stub.AbstractFutureStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel,io.grpc.CallOptions)

io.grpc.stub.AbstractStub.<T>withOption(io.grpc.CallOptions.Key<T>,T)

io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

io.grpc.stub.AbstractStub.getCallOptions()

io.grpc.stub.AbstractStub.getChannel()

io.grpc.stub.AbstractStub.withCallCredentials(io.grpc.CallCredentials)

io.grpc.stub.AbstractStub.withChannel(io.grpc.Channel)

io.grpc.stub.AbstractStub.withCompression(java.lang.String)

io.grpc.stub.AbstractStub.withDeadline(io.grpc.Deadline)

io.grpc.stub.AbstractStub.withDeadlineAfter(long,java.util.concurrent.TimeUnit)

io.grpc.stub.AbstractStub.withExecutor(java.util.concurrent.Executor)

io.grpc.stub.AbstractStub.withInterceptors(io.grpc.ClientInterceptor...)

io.grpc.stub.AbstractStub.withMaxInboundMessageSize(int)

io.grpc.stub.AbstractStub.withMaxOutboundMessageSize(int)

io.grpc.stub.AbstractStub.withOnReadyThreshold(int)

io.grpc.stub.AbstractStub.withWaitForReady()

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)

Methods

batchDeleteDocuments(BatchDeleteDocumentsRequest request)

public ListenableFuture<Operation> batchDeleteDocuments(BatchDeleteDocumentsRequest request)

Deletes a set of documents.

Parameter
Name	Description
`request`	`BatchDeleteDocumentsRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Operation>`

build(Channel channel, CallOptions callOptions)

protected DocumentServiceGrpc.DocumentServiceFutureStub build(Channel channel, CallOptions callOptions)

Parameters
Name	Description
`channel`	`io.grpc.Channel`
`callOptions`	`io.grpc.CallOptions`

Returns
Type	Description
`DocumentServiceGrpc.DocumentServiceFutureStub`

Overrides

io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

getDatasetSchema(GetDatasetSchemaRequest request)

public ListenableFuture<DatasetSchema> getDatasetSchema(GetDatasetSchemaRequest request)

Gets the DatasetSchema of a Dataset.

Parameter
Name	Description
`request`	`GetDatasetSchemaRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<DatasetSchema>`

getDocument(GetDocumentRequest request)

public ListenableFuture<GetDocumentResponse> getDocument(GetDocumentRequest request)

Returns relevant fields present in the requested document.

Parameter
Name	Description
`request`	`GetDocumentRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<GetDocumentResponse>`

importDocuments(ImportDocumentsRequest request)

public ListenableFuture<Operation> importDocuments(ImportDocumentsRequest request)

Import documents into a dataset.

Parameter
Name	Description
`request`	`ImportDocumentsRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Operation>`

listDocuments(ListDocumentsRequest request)

public ListenableFuture<ListDocumentsResponse> listDocuments(ListDocumentsRequest request)

Returns a list of documents present in the dataset.

Parameter
Name	Description
`request`	`ListDocumentsRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<ListDocumentsResponse>`

updateDataset(UpdateDatasetRequest request)

public ListenableFuture<Operation> updateDataset(UpdateDatasetRequest request)

Updates metadata associated with a dataset. Note that this method requires the documentai.googleapis.com/datasets.update permission on the project, which is highly privileged. A user or service account with this permission can create new processors that can interact with any gcs bucket in your project.

Parameter
Name	Description
`request`	`UpdateDatasetRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Operation>`

updateDatasetSchema(UpdateDatasetSchemaRequest request)

public ListenableFuture<DatasetSchema> updateDatasetSchema(UpdateDatasetSchemaRequest request)

Updates a DatasetSchema.

Parameter
Name	Description
`request`	`UpdateDatasetSchemaRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<DatasetSchema>`