Class DocumentProcessorServiceGrpc.DocumentProcessorServiceFutureStub (2.17.0)

public static final class DocumentProcessorServiceGrpc.DocumentProcessorServiceFutureStub extends AbstractFutureStub<DocumentProcessorServiceGrpc.DocumentProcessorServiceFutureStub>

Service to call Cloud DocumentAI to process documents according to the processor's definition. Processors are built using state-of-the-art Google AI such as natural language, computer vision, and translation to extract structured information from unstructured or semi-structured documents.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractFutureStub > DocumentProcessorServiceGrpc.DocumentProcessorServiceFutureStub

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

batchProcessDocuments(BatchProcessRequest request)

public ListenableFuture<Operation> batchProcessDocuments(BatchProcessRequest request)

LRO endpoint to batch process many documents. The output is written to Cloud Storage as JSON in the [Document] format.

Parameter
Name	Description
`request`	`BatchProcessRequest`

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

build(Channel channel, CallOptions callOptions)

protected DocumentProcessorServiceGrpc.DocumentProcessorServiceFutureStub build(Channel channel, CallOptions callOptions)

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

Returns
Type	Description
`DocumentProcessorServiceGrpc.DocumentProcessorServiceFutureStub`

Overrides

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

createProcessor(CreateProcessorRequest request)

public ListenableFuture<Processor> createProcessor(CreateProcessorRequest request)

Creates a processor from the type processor that the user chose. The processor will be at "ENABLED" state by default after its creation.

Parameter
Name	Description
`request`	`CreateProcessorRequest`

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

deleteProcessor(DeleteProcessorRequest request)

public ListenableFuture<Operation> deleteProcessor(DeleteProcessorRequest request)

Deletes the processor, unloads all deployed model artifacts if it was enabled and then deletes all artifacts associated with this processor.

Parameter
Name	Description
`request`	`DeleteProcessorRequest`

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

deleteProcessorVersion(DeleteProcessorVersionRequest request)

public ListenableFuture<Operation> deleteProcessorVersion(DeleteProcessorVersionRequest request)

Deletes the processor version, all artifacts under the processor version will be deleted.

Parameter
Name	Description
`request`	`DeleteProcessorVersionRequest`

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

deployProcessorVersion(DeployProcessorVersionRequest request)

public ListenableFuture<Operation> deployProcessorVersion(DeployProcessorVersionRequest request)

Deploys the processor version.

Parameter
Name	Description
`request`	`DeployProcessorVersionRequest`

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

disableProcessor(DisableProcessorRequest request)

public ListenableFuture<Operation> disableProcessor(DisableProcessorRequest request)

Disables a processor

Parameter
Name	Description
`request`	`DisableProcessorRequest`

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

enableProcessor(EnableProcessorRequest request)

public ListenableFuture<Operation> enableProcessor(EnableProcessorRequest request)

Enables a processor

Parameter
Name	Description
`request`	`EnableProcessorRequest`

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

evaluateProcessorVersion(EvaluateProcessorVersionRequest request)

public ListenableFuture<Operation> evaluateProcessorVersion(EvaluateProcessorVersionRequest request)

Evaluates a ProcessorVersion against annotated documents, producing an Evaluation.

Parameter
Name	Description
`request`	`EvaluateProcessorVersionRequest`

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

fetchProcessorTypes(FetchProcessorTypesRequest request)

public ListenableFuture<FetchProcessorTypesResponse> fetchProcessorTypes(FetchProcessorTypesRequest request)

Fetches processor types. Note that we do not use ListProcessorTypes here because it is not paginated.

Parameter
Name	Description
`request`	`FetchProcessorTypesRequest`

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

getEvaluation(GetEvaluationRequest request)

public ListenableFuture<Evaluation> getEvaluation(GetEvaluationRequest request)

Retrieves a specific evaluation.

Parameter
Name	Description
`request`	`GetEvaluationRequest`

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

getProcessor(GetProcessorRequest request)

public ListenableFuture<Processor> getProcessor(GetProcessorRequest request)

Gets a processor detail.

Parameter
Name	Description
`request`	`GetProcessorRequest`

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

getProcessorType(GetProcessorTypeRequest request)

public ListenableFuture<ProcessorType> getProcessorType(GetProcessorTypeRequest request)

Gets a processor type detail.

Parameter
Name	Description
`request`	`GetProcessorTypeRequest`

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

getProcessorVersion(GetProcessorVersionRequest request)

public ListenableFuture<ProcessorVersion> getProcessorVersion(GetProcessorVersionRequest request)

Gets a processor version detail.

Parameter
Name	Description
`request`	`GetProcessorVersionRequest`

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

listEvaluations(ListEvaluationsRequest request)

public ListenableFuture<ListEvaluationsResponse> listEvaluations(ListEvaluationsRequest request)

Retrieves a set of evaluations for a given processor version.

Parameter
Name	Description
`request`	`ListEvaluationsRequest`

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

listProcessorTypes(ListProcessorTypesRequest request)

public ListenableFuture<ListProcessorTypesResponse> listProcessorTypes(ListProcessorTypesRequest request)

Lists the processor types that exist.

Parameter
Name	Description
`request`	`ListProcessorTypesRequest`

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

listProcessorVersions(ListProcessorVersionsRequest request)

public ListenableFuture<ListProcessorVersionsResponse> listProcessorVersions(ListProcessorVersionsRequest request)

Lists all versions of a processor.

Parameter
Name	Description
`request`	`ListProcessorVersionsRequest`

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

listProcessors(ListProcessorsRequest request)

public ListenableFuture<ListProcessorsResponse> listProcessors(ListProcessorsRequest request)

Lists all processors which belong to this project.

Parameter
Name	Description
`request`	`ListProcessorsRequest`

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

processDocument(ProcessRequest request)

public ListenableFuture<ProcessResponse> processDocument(ProcessRequest request)

Processes a single document.

Parameter
Name	Description
`request`	`ProcessRequest`

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

reviewDocument(ReviewDocumentRequest request)

public ListenableFuture<Operation> reviewDocument(ReviewDocumentRequest request)

Send a document for Human Review. The input document should be processed by the specified processor.

Parameter
Name	Description
`request`	`ReviewDocumentRequest`

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

setDefaultProcessorVersion(SetDefaultProcessorVersionRequest request)

public ListenableFuture<Operation> setDefaultProcessorVersion(SetDefaultProcessorVersionRequest request)

Set the default (active) version of a Processor that will be used in ProcessDocument and BatchProcessDocuments.

Parameter
Name	Description
`request`	`SetDefaultProcessorVersionRequest`

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

trainProcessorVersion(TrainProcessorVersionRequest request)

public ListenableFuture<Operation> trainProcessorVersion(TrainProcessorVersionRequest request)

Trains a new processor version. Operation metadata is returned as cloud_documentai_core.TrainProcessorVersionMetadata.

Parameter
Name	Description
`request`	`TrainProcessorVersionRequest`

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

undeployProcessorVersion(UndeployProcessorVersionRequest request)

public ListenableFuture<Operation> undeployProcessorVersion(UndeployProcessorVersionRequest request)

Undeploys the processor version.

Parameter
Name	Description
`request`	`UndeployProcessorVersionRequest`

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