Class DocumentProcessorServiceClient (2.17.0)

public class DocumentProcessorServiceClient implements BackgroundResource

Service Description: 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.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   ResourceName name = ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]");
   ProcessResponse response = documentProcessorServiceClient.processDocument(name);
 }
 

Note: close() needs to be called on the DocumentProcessorServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

  1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
  2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
  3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of DocumentProcessorServiceSettings to create(). For example:

To customize credentials:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 DocumentProcessorServiceSettings documentProcessorServiceSettings =
     DocumentProcessorServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create(documentProcessorServiceSettings);
 

To customize the endpoint:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 DocumentProcessorServiceSettings documentProcessorServiceSettings =
     DocumentProcessorServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create(documentProcessorServiceSettings);
 

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 DocumentProcessorServiceSettings documentProcessorServiceSettings =
     DocumentProcessorServiceSettings.newHttpJsonBuilder().build();
 DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create(documentProcessorServiceSettings);
 

Please refer to the GitHub repository's samples for more quickstart code snippets.

Inheritance

java.lang.Object > DocumentProcessorServiceClient

Implements

BackgroundResource

Static Methods

create()

public static final DocumentProcessorServiceClient create()

Constructs an instance of DocumentProcessorServiceClient with default settings.

Returns
TypeDescription
DocumentProcessorServiceClient
Exceptions
TypeDescription
IOException

create(DocumentProcessorServiceSettings settings)

public static final DocumentProcessorServiceClient create(DocumentProcessorServiceSettings settings)

Constructs an instance of DocumentProcessorServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Parameter
NameDescription
settingsDocumentProcessorServiceSettings
Returns
TypeDescription
DocumentProcessorServiceClient
Exceptions
TypeDescription
IOException

create(DocumentProcessorServiceStub stub)

public static final DocumentProcessorServiceClient create(DocumentProcessorServiceStub stub)

Constructs an instance of DocumentProcessorServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(DocumentProcessorServiceSettings).

Parameter
NameDescription
stubDocumentProcessorServiceStub
Returns
TypeDescription
DocumentProcessorServiceClient

Constructors

DocumentProcessorServiceClient(DocumentProcessorServiceSettings settings)

protected DocumentProcessorServiceClient(DocumentProcessorServiceSettings settings)

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

Parameter
NameDescription
settingsDocumentProcessorServiceSettings

DocumentProcessorServiceClient(DocumentProcessorServiceStub stub)

protected DocumentProcessorServiceClient(DocumentProcessorServiceStub stub)
Parameter
NameDescription
stubDocumentProcessorServiceStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
NameDescription
durationlong
unitTimeUnit
Returns
TypeDescription
boolean
Exceptions
TypeDescription
InterruptedException

batchProcessDocumentsAsync(ResourceName name)

public final OperationFuture<BatchProcessResponse,BatchProcessMetadata> batchProcessDocumentsAsync(ResourceName name)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   ResourceName name = ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]");
   BatchProcessResponse response =
       documentProcessorServiceClient.batchProcessDocumentsAsync(name).get();
 }
 
Parameter
NameDescription
namecom.google.api.resourcenames.ResourceName

Required. The resource name of Processor or ProcessorVersion. Format: projects/{project}/locations/{location}/processors/{processor}, or projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}

Returns
TypeDescription
OperationFuture<BatchProcessResponse,BatchProcessMetadata>

batchProcessDocumentsAsync(BatchProcessRequest request)

public final OperationFuture<BatchProcessResponse,BatchProcessMetadata> batchProcessDocumentsAsync(BatchProcessRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   BatchProcessRequest request =
       BatchProcessRequest.newBuilder()
           .setName(ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString())
           .setInputDocuments(BatchDocumentsInputConfig.newBuilder().build())
           .setDocumentOutputConfig(DocumentOutputConfig.newBuilder().build())
           .setSkipHumanReview(true)
           .build();
   BatchProcessResponse response =
       documentProcessorServiceClient.batchProcessDocumentsAsync(request).get();
 }
 
Parameter
NameDescription
requestBatchProcessRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
OperationFuture<BatchProcessResponse,BatchProcessMetadata>

batchProcessDocumentsAsync(String name)

public final OperationFuture<BatchProcessResponse,BatchProcessMetadata> batchProcessDocumentsAsync(String name)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   String name =
       EvaluationName.of(
               "[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]", "[EVALUATION]")
           .toString();
   BatchProcessResponse response =
       documentProcessorServiceClient.batchProcessDocumentsAsync(name).get();
 }
 
Parameter
NameDescription
nameString

Required. The resource name of Processor or ProcessorVersion. Format: projects/{project}/locations/{location}/processors/{processor}, or projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}

Returns
TypeDescription
OperationFuture<BatchProcessResponse,BatchProcessMetadata>

batchProcessDocumentsCallable()

public final UnaryCallable<BatchProcessRequest,Operation> batchProcessDocumentsCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   BatchProcessRequest request =
       BatchProcessRequest.newBuilder()
           .setName(ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString())
           .setInputDocuments(BatchDocumentsInputConfig.newBuilder().build())
           .setDocumentOutputConfig(DocumentOutputConfig.newBuilder().build())
           .setSkipHumanReview(true)
           .build();
   ApiFuture<Operation> future =
       documentProcessorServiceClient.batchProcessDocumentsCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<BatchProcessRequest,Operation>

batchProcessDocumentsOperationCallable()

public final OperationCallable<BatchProcessRequest,BatchProcessResponse,BatchProcessMetadata> batchProcessDocumentsOperationCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   BatchProcessRequest request =
       BatchProcessRequest.newBuilder()
           .setName(ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString())
           .setInputDocuments(BatchDocumentsInputConfig.newBuilder().build())
           .setDocumentOutputConfig(DocumentOutputConfig.newBuilder().build())
           .setSkipHumanReview(true)
           .build();
   OperationFuture<BatchProcessResponse, BatchProcessMetadata> future =
       documentProcessorServiceClient
           .batchProcessDocumentsOperationCallable()
           .futureCall(request);
   // Do something.
   BatchProcessResponse response = future.get();
 }
 
Returns
TypeDescription
OperationCallable<BatchProcessRequest,BatchProcessResponse,BatchProcessMetadata>

close()

public final void close()

createProcessor(CreateProcessorRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   CreateProcessorRequest request =
       CreateProcessorRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setProcessor(Processor.newBuilder().build())
           .build();
   Processor response = documentProcessorServiceClient.createProcessor(request);
 }
 
Parameter
NameDescription
requestCreateProcessorRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
Processor

createProcessor(LocationName parent, Processor processor)

public final Processor createProcessor(LocationName parent, Processor processor)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Processor processor = Processor.newBuilder().build();
   Processor response = documentProcessorServiceClient.createProcessor(parent, processor);
 }
 
Parameters
NameDescription
parentLocationName

Required. The parent (project and location) under which to create the processor. Format: projects/{project}/locations/{location}

processorProcessor

Required. The processor to be created, requires [processor_type] and [display_name] to be set. Also, the processor is under CMEK if CMEK fields are set.

Returns
TypeDescription
Processor

createProcessor(String parent, Processor processor)

public final Processor createProcessor(String parent, Processor processor)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   Processor processor = Processor.newBuilder().build();
   Processor response = documentProcessorServiceClient.createProcessor(parent, processor);
 }
 
Parameters
NameDescription
parentString

Required. The parent (project and location) under which to create the processor. Format: projects/{project}/locations/{location}

processorProcessor

Required. The processor to be created, requires [processor_type] and [display_name] to be set. Also, the processor is under CMEK if CMEK fields are set.

Returns
TypeDescription
Processor

createProcessorCallable()

public final UnaryCallable<CreateProcessorRequest,Processor> createProcessorCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   CreateProcessorRequest request =
       CreateProcessorRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setProcessor(Processor.newBuilder().build())
           .build();
   ApiFuture<Processor> future =
       documentProcessorServiceClient.createProcessorCallable().futureCall(request);
   // Do something.
   Processor response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<CreateProcessorRequest,Processor>

deleteProcessorAsync(DeleteProcessorRequest request)

public final OperationFuture<Empty,DeleteProcessorMetadata> deleteProcessorAsync(DeleteProcessorRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   DeleteProcessorRequest request =
       DeleteProcessorRequest.newBuilder()
           .setName(ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString())
           .build();
   documentProcessorServiceClient.deleteProcessorAsync(request).get();
 }
 
Parameter
NameDescription
requestDeleteProcessorRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
OperationFuture<Empty,DeleteProcessorMetadata>

deleteProcessorAsync(ProcessorName name)

public final OperationFuture<Empty,DeleteProcessorMetadata> deleteProcessorAsync(ProcessorName name)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   ProcessorName name = ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]");
   documentProcessorServiceClient.deleteProcessorAsync(name).get();
 }
 
Parameter
NameDescription
nameProcessorName

Required. The processor resource name to be deleted.

Returns
TypeDescription
OperationFuture<Empty,DeleteProcessorMetadata>

deleteProcessorAsync(String name)

public final OperationFuture<Empty,DeleteProcessorMetadata> deleteProcessorAsync(String name)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   String name = ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString();
   documentProcessorServiceClient.deleteProcessorAsync(name).get();
 }
 
Parameter
NameDescription
nameString

Required. The processor resource name to be deleted.

Returns
TypeDescription
OperationFuture<Empty,DeleteProcessorMetadata>

deleteProcessorCallable()

public final UnaryCallable<DeleteProcessorRequest,Operation> deleteProcessorCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   DeleteProcessorRequest request =
       DeleteProcessorRequest.newBuilder()
           .setName(ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString())
           .build();
   ApiFuture<Operation> future =
       documentProcessorServiceClient.deleteProcessorCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
TypeDescription
UnaryCallable<DeleteProcessorRequest,Operation>

deleteProcessorOperationCallable()

public final OperationCallable<DeleteProcessorRequest,Empty,DeleteProcessorMetadata> deleteProcessorOperationCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   DeleteProcessorRequest request =
       DeleteProcessorRequest.newBuilder()
           .setName(ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString())
           .build();
   OperationFuture<Empty, DeleteProcessorMetadata> future =
       documentProcessorServiceClient.deleteProcessorOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
TypeDescription
OperationCallable<DeleteProcessorRequest,Empty,DeleteProcessorMetadata>

deleteProcessorVersionAsync(DeleteProcessorVersionRequest request)

public final OperationFuture<Empty,DeleteProcessorVersionMetadata> deleteProcessorVersionAsync(DeleteProcessorVersionRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   DeleteProcessorVersionRequest request =
       DeleteProcessorVersionRequest.newBuilder()
           .setName(
               ProcessorVersionName.of(
                       "[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]")
                   .toString())
           .build();
   documentProcessorServiceClient.deleteProcessorVersionAsync(request).get();
 }
 
Parameter
NameDescription
requestDeleteProcessorVersionRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
OperationFuture<Empty,DeleteProcessorVersionMetadata>

deleteProcessorVersionAsync(ProcessorVersionName name)

public final OperationFuture<Empty,DeleteProcessorVersionMetadata> deleteProcessorVersionAsync(ProcessorVersionName name)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   ProcessorVersionName name =
       ProcessorVersionName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]");
   documentProcessorServiceClient.deleteProcessorVersionAsync(name).get();
 }
 
Parameter
NameDescription
nameProcessorVersionName

Required. The processor version resource name to be deleted.

Returns
TypeDescription
OperationFuture<Empty,DeleteProcessorVersionMetadata>

deleteProcessorVersionAsync(String name)

public final OperationFuture<Empty,DeleteProcessorVersionMetadata> deleteProcessorVersionAsync(String name)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   String name =
       ProcessorVersionName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]")
           .toString();
   documentProcessorServiceClient.deleteProcessorVersionAsync(name).get();
 }
 
Parameter
NameDescription
nameString

Required. The processor version resource name to be deleted.

Returns
TypeDescription
OperationFuture<Empty,DeleteProcessorVersionMetadata>

deleteProcessorVersionCallable()

public final UnaryCallable<DeleteProcessorVersionRequest,Operation> deleteProcessorVersionCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   DeleteProcessorVersionRequest request =
       DeleteProcessorVersionRequest.newBuilder()
           .setName(
               ProcessorVersionName.of(
                       "[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]")
                   .toString())
           .build();
   ApiFuture<Operation> future =
       documentProcessorServiceClient.deleteProcessorVersionCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
TypeDescription
UnaryCallable<DeleteProcessorVersionRequest,Operation>

deleteProcessorVersionOperationCallable()

public final OperationCallable<DeleteProcessorVersionRequest,Empty,DeleteProcessorVersionMetadata> deleteProcessorVersionOperationCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   DeleteProcessorVersionRequest request =
       DeleteProcessorVersionRequest.newBuilder()
           .setName(
               ProcessorVersionName.of(
                       "[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]")
                   .toString())
           .build();
   OperationFuture<Empty, DeleteProcessorVersionMetadata> future =
       documentProcessorServiceClient
           .deleteProcessorVersionOperationCallable()
           .futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
TypeDescription
OperationCallable<DeleteProcessorVersionRequest,Empty,DeleteProcessorVersionMetadata>

deployProcessorVersionAsync(DeployProcessorVersionRequest request)

public final OperationFuture<DeployProcessorVersionResponse,DeployProcessorVersionMetadata> deployProcessorVersionAsync(DeployProcessorVersionRequest request)

Deploys the processor version.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   DeployProcessorVersionRequest request =
       DeployProcessorVersionRequest.newBuilder()
           .setName(
               ProcessorVersionName.of(
                       "[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]")
                   .toString())
           .build();
   DeployProcessorVersionResponse response =
       documentProcessorServiceClient.deployProcessorVersionAsync(request).get();
 }
 
Parameter
NameDescription
requestDeployProcessorVersionRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
OperationFuture<DeployProcessorVersionResponse,DeployProcessorVersionMetadata>

deployProcessorVersionAsync(ProcessorVersionName name)

public final OperationFuture<DeployProcessorVersionResponse,DeployProcessorVersionMetadata> deployProcessorVersionAsync(ProcessorVersionName name)

Deploys the processor version.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   ProcessorVersionName name =
       ProcessorVersionName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]");
   DeployProcessorVersionResponse response =
       documentProcessorServiceClient.deployProcessorVersionAsync(name).get();
 }
 
Parameter
NameDescription
nameProcessorVersionName

Required. The processor version resource name to be deployed.

Returns
TypeDescription
OperationFuture<DeployProcessorVersionResponse,DeployProcessorVersionMetadata>

deployProcessorVersionAsync(String name)

public final OperationFuture<DeployProcessorVersionResponse,DeployProcessorVersionMetadata> deployProcessorVersionAsync(String name)

Deploys the processor version.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   String name =
       ProcessorVersionName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]")
           .toString();
   DeployProcessorVersionResponse response =
       documentProcessorServiceClient.deployProcessorVersionAsync(name).get();
 }
 
Parameter
NameDescription
nameString

Required. The processor version resource name to be deployed.

Returns
TypeDescription
OperationFuture<DeployProcessorVersionResponse,DeployProcessorVersionMetadata>

deployProcessorVersionCallable()

public final UnaryCallable<DeployProcessorVersionRequest,Operation> deployProcessorVersionCallable()

Deploys the processor version.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   DeployProcessorVersionRequest request =
       DeployProcessorVersionRequest.newBuilder()
           .setName(
               ProcessorVersionName.of(
                       "[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]")
                   .toString())
           .build();
   ApiFuture<Operation> future =
       documentProcessorServiceClient.deployProcessorVersionCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<DeployProcessorVersionRequest,Operation>

deployProcessorVersionOperationCallable()

public final OperationCallable<DeployProcessorVersionRequest,DeployProcessorVersionResponse,DeployProcessorVersionMetadata> deployProcessorVersionOperationCallable()

Deploys the processor version.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   DeployProcessorVersionRequest request =
       DeployProcessorVersionRequest.newBuilder()
           .setName(
               ProcessorVersionName.of(
                       "[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]")
                   .toString())
           .build();
   OperationFuture<DeployProcessorVersionResponse, DeployProcessorVersionMetadata> future =
       documentProcessorServiceClient
           .deployProcessorVersionOperationCallable()
           .futureCall(request);
   // Do something.
   DeployProcessorVersionResponse response = future.get();
 }
 
Returns
TypeDescription
OperationCallable<DeployProcessorVersionRequest,DeployProcessorVersionResponse,DeployProcessorVersionMetadata>

disableProcessorAsync(DisableProcessorRequest request)

public final OperationFuture<DisableProcessorResponse,DisableProcessorMetadata> disableProcessorAsync(DisableProcessorRequest request)

Disables a processor

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   DisableProcessorRequest request =
       DisableProcessorRequest.newBuilder()
           .setName(ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString())
           .build();
   DisableProcessorResponse response =
       documentProcessorServiceClient.disableProcessorAsync(request).get();
 }
 
Parameter
NameDescription
requestDisableProcessorRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
OperationFuture<DisableProcessorResponse,DisableProcessorMetadata>

disableProcessorCallable()

public final UnaryCallable<DisableProcessorRequest,Operation> disableProcessorCallable()

Disables a processor

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   DisableProcessorRequest request =
       DisableProcessorRequest.newBuilder()
           .setName(ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString())
           .build();
   ApiFuture<Operation> future =
       documentProcessorServiceClient.disableProcessorCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<DisableProcessorRequest,Operation>

disableProcessorOperationCallable()

public final OperationCallable<DisableProcessorRequest,DisableProcessorResponse,DisableProcessorMetadata> disableProcessorOperationCallable()

Disables a processor

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   DisableProcessorRequest request =
       DisableProcessorRequest.newBuilder()
           .setName(ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString())
           .build();
   OperationFuture<DisableProcessorResponse, DisableProcessorMetadata> future =
       documentProcessorServiceClient.disableProcessorOperationCallable().futureCall(request);
   // Do something.
   DisableProcessorResponse response = future.get();
 }
 
Returns
TypeDescription
OperationCallable<DisableProcessorRequest,DisableProcessorResponse,DisableProcessorMetadata>

enableProcessorAsync(EnableProcessorRequest request)

public final OperationFuture<EnableProcessorResponse,EnableProcessorMetadata> enableProcessorAsync(EnableProcessorRequest request)

Enables a processor

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   EnableProcessorRequest request =
       EnableProcessorRequest.newBuilder()
           .setName(ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString())
           .build();
   EnableProcessorResponse response =
       documentProcessorServiceClient.enableProcessorAsync(request).get();
 }
 
Parameter
NameDescription
requestEnableProcessorRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
OperationFuture<EnableProcessorResponse,EnableProcessorMetadata>

enableProcessorCallable()

public final UnaryCallable<EnableProcessorRequest,Operation> enableProcessorCallable()

Enables a processor

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   EnableProcessorRequest request =
       EnableProcessorRequest.newBuilder()
           .setName(ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString())
           .build();
   ApiFuture<Operation> future =
       documentProcessorServiceClient.enableProcessorCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<EnableProcessorRequest,Operation>

enableProcessorOperationCallable()

public final OperationCallable<EnableProcessorRequest,EnableProcessorResponse,EnableProcessorMetadata> enableProcessorOperationCallable()

Enables a processor

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   EnableProcessorRequest request =
       EnableProcessorRequest.newBuilder()
           .setName(ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString())
           .build();
   OperationFuture<EnableProcessorResponse, EnableProcessorMetadata> future =
       documentProcessorServiceClient.enableProcessorOperationCallable().futureCall(request);
   // Do something.
   EnableProcessorResponse response = future.get();
 }
 
Returns
TypeDescription
OperationCallable<EnableProcessorRequest,EnableProcessorResponse,EnableProcessorMetadata>

evaluateProcessorVersionAsync(EvaluateProcessorVersionRequest request)

public final OperationFuture<EvaluateProcessorVersionResponse,EvaluateProcessorVersionMetadata> evaluateProcessorVersionAsync(EvaluateProcessorVersionRequest request)

Evaluates a ProcessorVersion against annotated documents, producing an Evaluation.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   EvaluateProcessorVersionRequest request =
       EvaluateProcessorVersionRequest.newBuilder()
           .setProcessorVersion(
               ProcessorVersionName.of(
                       "[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]")
                   .toString())
           .setEvaluationDocuments(BatchDocumentsInputConfig.newBuilder().build())
           .build();
   EvaluateProcessorVersionResponse response =
       documentProcessorServiceClient.evaluateProcessorVersionAsync(request).get();
 }
 
Parameter
NameDescription
requestEvaluateProcessorVersionRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
OperationFuture<EvaluateProcessorVersionResponse,EvaluateProcessorVersionMetadata>

evaluateProcessorVersionAsync(ProcessorVersionName processorVersion)

public final OperationFuture<EvaluateProcessorVersionResponse,EvaluateProcessorVersionMetadata> evaluateProcessorVersionAsync(ProcessorVersionName processorVersion)

Evaluates a ProcessorVersion against annotated documents, producing an Evaluation.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   ProcessorVersionName processorVersion =
       ProcessorVersionName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]");
   EvaluateProcessorVersionResponse response =
       documentProcessorServiceClient.evaluateProcessorVersionAsync(processorVersion).get();
 }
 
Parameter
NameDescription
processorVersionProcessorVersionName

Required. The resource name of the ProcessorVersion to evaluate. projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}

Returns
TypeDescription
OperationFuture<EvaluateProcessorVersionResponse,EvaluateProcessorVersionMetadata>

evaluateProcessorVersionAsync(String processorVersion)

public final OperationFuture<EvaluateProcessorVersionResponse,EvaluateProcessorVersionMetadata> evaluateProcessorVersionAsync(String processorVersion)

Evaluates a ProcessorVersion against annotated documents, producing an Evaluation.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   String processorVersion =
       ProcessorVersionName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]")
           .toString();
   EvaluateProcessorVersionResponse response =
       documentProcessorServiceClient.evaluateProcessorVersionAsync(processorVersion).get();
 }
 
Parameter
NameDescription
processorVersionString

Required. The resource name of the ProcessorVersion to evaluate. projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}

Returns
TypeDescription
OperationFuture<EvaluateProcessorVersionResponse,EvaluateProcessorVersionMetadata>

evaluateProcessorVersionCallable()

public final UnaryCallable<EvaluateProcessorVersionRequest,Operation> evaluateProcessorVersionCallable()

Evaluates a ProcessorVersion against annotated documents, producing an Evaluation.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   EvaluateProcessorVersionRequest request =
       EvaluateProcessorVersionRequest.newBuilder()
           .setProcessorVersion(
               ProcessorVersionName.of(
                       "[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]")
                   .toString())
           .setEvaluationDocuments(BatchDocumentsInputConfig.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       documentProcessorServiceClient.evaluateProcessorVersionCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<EvaluateProcessorVersionRequest,Operation>

evaluateProcessorVersionOperationCallable()

public final OperationCallable<EvaluateProcessorVersionRequest,EvaluateProcessorVersionResponse,EvaluateProcessorVersionMetadata> evaluateProcessorVersionOperationCallable()

Evaluates a ProcessorVersion against annotated documents, producing an Evaluation.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   EvaluateProcessorVersionRequest request =
       EvaluateProcessorVersionRequest.newBuilder()
           .setProcessorVersion(
               ProcessorVersionName.of(
                       "[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]")
                   .toString())
           .setEvaluationDocuments(BatchDocumentsInputConfig.newBuilder().build())
           .build();
   OperationFuture<EvaluateProcessorVersionResponse, EvaluateProcessorVersionMetadata> future =
       documentProcessorServiceClient
           .evaluateProcessorVersionOperationCallable()
           .futureCall(request);
   // Do something.
   EvaluateProcessorVersionResponse response = future.get();
 }
 
Returns
TypeDescription
OperationCallable<EvaluateProcessorVersionRequest,EvaluateProcessorVersionResponse,EvaluateProcessorVersionMetadata>

fetchProcessorTypes(FetchProcessorTypesRequest request)

public final FetchProcessorTypesResponse fetchProcessorTypes(FetchProcessorTypesRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   FetchProcessorTypesRequest request =
       FetchProcessorTypesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .build();
   FetchProcessorTypesResponse response =
       documentProcessorServiceClient.fetchProcessorTypes(request);
 }
 
Parameter
NameDescription
requestFetchProcessorTypesRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
FetchProcessorTypesResponse

fetchProcessorTypes(LocationName parent)

public final FetchProcessorTypesResponse fetchProcessorTypes(LocationName parent)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   FetchProcessorTypesResponse response =
       documentProcessorServiceClient.fetchProcessorTypes(parent);
 }
 
Parameter
NameDescription
parentLocationName

Required. The project of processor type to list. The available processor types may depend on the allow-listing on projects. Format: projects/{project}/locations/{location}

Returns
TypeDescription
FetchProcessorTypesResponse

fetchProcessorTypes(String parent)

public final FetchProcessorTypesResponse fetchProcessorTypes(String parent)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   FetchProcessorTypesResponse response =
       documentProcessorServiceClient.fetchProcessorTypes(parent);
 }
 
Parameter
NameDescription
parentString

Required. The project of processor type to list. The available processor types may depend on the allow-listing on projects. Format: projects/{project}/locations/{location}

Returns
TypeDescription
FetchProcessorTypesResponse

fetchProcessorTypesCallable()

public final UnaryCallable<FetchProcessorTypesRequest,FetchProcessorTypesResponse> fetchProcessorTypesCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   FetchProcessorTypesRequest request =
       FetchProcessorTypesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .build();
   ApiFuture<FetchProcessorTypesResponse> future =
       documentProcessorServiceClient.fetchProcessorTypesCallable().futureCall(request);
   // Do something.
   FetchProcessorTypesResponse response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<FetchProcessorTypesRequest,FetchProcessorTypesResponse>

getEvaluation(EvaluationName name)

public final Evaluation getEvaluation(EvaluationName name)

Retrieves a specific evaluation.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   EvaluationName name =
       EvaluationName.of(
           "[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]", "[EVALUATION]");
   Evaluation response = documentProcessorServiceClient.getEvaluation(name);
 }
 
Parameter
NameDescription
nameEvaluationName

Required. The resource name of the Evaluation to get. projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}/evaluations/{evaluation}

Returns
TypeDescription
Evaluation

getEvaluation(GetEvaluationRequest request)

public final Evaluation getEvaluation(GetEvaluationRequest request)

Retrieves a specific evaluation.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   GetEvaluationRequest request =
       GetEvaluationRequest.newBuilder()
           .setName(
               EvaluationName.of(
                       "[PROJECT]",
                       "[LOCATION]",
                       "[PROCESSOR]",
                       "[PROCESSOR_VERSION]",
                       "[EVALUATION]")
                   .toString())
           .build();
   Evaluation response = documentProcessorServiceClient.getEvaluation(request);
 }
 
Parameter
NameDescription
requestGetEvaluationRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
Evaluation

getEvaluation(String name)

public final Evaluation getEvaluation(String name)

Retrieves a specific evaluation.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   String name =
       EvaluationName.of(
               "[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]", "[EVALUATION]")
           .toString();
   Evaluation response = documentProcessorServiceClient.getEvaluation(name);
 }
 
Parameter
NameDescription
nameString

Required. The resource name of the Evaluation to get. projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}/evaluations/{evaluation}

Returns
TypeDescription
Evaluation

getEvaluationCallable()

public final UnaryCallable<GetEvaluationRequest,Evaluation> getEvaluationCallable()

Retrieves a specific evaluation.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   GetEvaluationRequest request =
       GetEvaluationRequest.newBuilder()
           .setName(
               EvaluationName.of(
                       "[PROJECT]",
                       "[LOCATION]",
                       "[PROCESSOR]",
                       "[PROCESSOR_VERSION]",
                       "[EVALUATION]")
                   .toString())
           .build();
   ApiFuture<Evaluation> future =
       documentProcessorServiceClient.getEvaluationCallable().futureCall(request);
   // Do something.
   Evaluation response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<GetEvaluationRequest,Evaluation>

getHttpJsonOperationsClient()

public final OperationsClient getHttpJsonOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

Returns
TypeDescription
OperationsClient

getLocation(GetLocationRequest request)

public final Location getLocation(GetLocationRequest request)

Gets information about a location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   Location response = documentProcessorServiceClient.getLocation(request);
 }
 
Parameter
NameDescription
requestcom.google.cloud.location.GetLocationRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
com.google.cloud.location.Location

getLocationCallable()

public final UnaryCallable<GetLocationRequest,Location> getLocationCallable()

Gets information about a location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   ApiFuture<Location> future =
       documentProcessorServiceClient.getLocationCallable().futureCall(request);
   // Do something.
   Location response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>

getOperationsClient()

public final OperationsClient getOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

Returns
TypeDescription
OperationsClient

getProcessor(GetProcessorRequest request)

public final Processor getProcessor(GetProcessorRequest request)

Gets a processor detail.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   GetProcessorRequest request =
       GetProcessorRequest.newBuilder()
           .setName(ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString())
           .build();
   Processor response = documentProcessorServiceClient.getProcessor(request);
 }
 
Parameter
NameDescription
requestGetProcessorRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
Processor

getProcessor(ProcessorName name)

public final Processor getProcessor(ProcessorName name)

Gets a processor detail.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   ProcessorName name = ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]");
   Processor response = documentProcessorServiceClient.getProcessor(name);
 }
 
Parameter
NameDescription
nameProcessorName

Required. The processor resource name.

Returns
TypeDescription
Processor

getProcessor(String name)

public final Processor getProcessor(String name)

Gets a processor detail.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   String name = ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString();
   Processor response = documentProcessorServiceClient.getProcessor(name);
 }
 
Parameter
NameDescription
nameString

Required. The processor resource name.

Returns
TypeDescription
Processor

getProcessorCallable()

public final UnaryCallable<GetProcessorRequest,Processor> getProcessorCallable()

Gets a processor detail.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   GetProcessorRequest request =
       GetProcessorRequest.newBuilder()
           .setName(ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString())
           .build();
   ApiFuture<Processor> future =
       documentProcessorServiceClient.getProcessorCallable().futureCall(request);
   // Do something.
   Processor response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<GetProcessorRequest,Processor>

getProcessorType(GetProcessorTypeRequest request)

public final ProcessorType getProcessorType(GetProcessorTypeRequest request)

Gets a processor type detail.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   GetProcessorTypeRequest request =
       GetProcessorTypeRequest.newBuilder()
           .setName(
               ProcessorTypeName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR_TYPE]").toString())
           .build();
   ProcessorType response = documentProcessorServiceClient.getProcessorType(request);
 }
 
Parameter
NameDescription
requestGetProcessorTypeRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
ProcessorType

getProcessorType(ProcessorTypeName name)

public final ProcessorType getProcessorType(ProcessorTypeName name)

Gets a processor type detail.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   ProcessorTypeName name = ProcessorTypeName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR_TYPE]");
   ProcessorType response = documentProcessorServiceClient.getProcessorType(name);
 }
 
Parameter
NameDescription
nameProcessorTypeName

Required. The processor type resource name.

Returns
TypeDescription
ProcessorType

getProcessorType(String name)

public final ProcessorType getProcessorType(String name)

Gets a processor type detail.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   String name = ProcessorTypeName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR_TYPE]").toString();
   ProcessorType response = documentProcessorServiceClient.getProcessorType(name);
 }
 
Parameter
NameDescription
nameString

Required. The processor type resource name.

Returns
TypeDescription
ProcessorType

getProcessorTypeCallable()

public final UnaryCallable<GetProcessorTypeRequest,ProcessorType> getProcessorTypeCallable()

Gets a processor type detail.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   GetProcessorTypeRequest request =
       GetProcessorTypeRequest.newBuilder()
           .setName(
               ProcessorTypeName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR_TYPE]").toString())
           .build();
   ApiFuture<ProcessorType> future =
       documentProcessorServiceClient.getProcessorTypeCallable().futureCall(request);
   // Do something.
   ProcessorType response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<GetProcessorTypeRequest,ProcessorType>

getProcessorVersion(GetProcessorVersionRequest request)

public final ProcessorVersion getProcessorVersion(GetProcessorVersionRequest request)

Gets a processor version detail.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   GetProcessorVersionRequest request =
       GetProcessorVersionRequest.newBuilder()
           .setName(
               ProcessorVersionName.of(
                       "[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]")
                   .toString())
           .build();
   ProcessorVersion response = documentProcessorServiceClient.getProcessorVersion(request);
 }
 
Parameter
NameDescription
requestGetProcessorVersionRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
ProcessorVersion

getProcessorVersion(ProcessorVersionName name)

public final ProcessorVersion getProcessorVersion(ProcessorVersionName name)

Gets a processor version detail.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   ProcessorVersionName name =
       ProcessorVersionName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]");
   ProcessorVersion response = documentProcessorServiceClient.getProcessorVersion(name);
 }
 
Parameter
NameDescription
nameProcessorVersionName

Required. The processor resource name.

Returns
TypeDescription
ProcessorVersion

getProcessorVersion(String name)

public final ProcessorVersion getProcessorVersion(String name)

Gets a processor version detail.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   String name =
       ProcessorVersionName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]")
           .toString();
   ProcessorVersion response = documentProcessorServiceClient.getProcessorVersion(name);
 }
 
Parameter
NameDescription
nameString

Required. The processor resource name.

Returns
TypeDescription
ProcessorVersion

getProcessorVersionCallable()

public final UnaryCallable<GetProcessorVersionRequest,ProcessorVersion> getProcessorVersionCallable()

Gets a processor version detail.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   GetProcessorVersionRequest request =
       GetProcessorVersionRequest.newBuilder()
           .setName(
               ProcessorVersionName.of(
                       "[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]")
                   .toString())
           .build();
   ApiFuture<ProcessorVersion> future =
       documentProcessorServiceClient.getProcessorVersionCallable().futureCall(request);
   // Do something.
   ProcessorVersion response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<GetProcessorVersionRequest,ProcessorVersion>

getSettings()

public final DocumentProcessorServiceSettings getSettings()
Returns
TypeDescription
DocumentProcessorServiceSettings

getStub()

public DocumentProcessorServiceStub getStub()
Returns
TypeDescription
DocumentProcessorServiceStub

isShutdown()

public boolean isShutdown()
Returns
TypeDescription
boolean

isTerminated()

public boolean isTerminated()
Returns
TypeDescription
boolean

listEvaluations(ListEvaluationsRequest request)

public final DocumentProcessorServiceClient.ListEvaluationsPagedResponse listEvaluations(ListEvaluationsRequest request)

Retrieves a set of evaluations for a given processor version.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   ListEvaluationsRequest request =
       ListEvaluationsRequest.newBuilder()
           .setParent(
               ProcessorVersionName.of(
                       "[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Evaluation element :
       documentProcessorServiceClient.listEvaluations(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
requestListEvaluationsRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
DocumentProcessorServiceClient.ListEvaluationsPagedResponse

listEvaluations(ProcessorVersionName parent)

public final DocumentProcessorServiceClient.ListEvaluationsPagedResponse listEvaluations(ProcessorVersionName parent)

Retrieves a set of evaluations for a given processor version.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   ProcessorVersionName parent =
       ProcessorVersionName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]");
   for (Evaluation element :
       documentProcessorServiceClient.listEvaluations(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
parentProcessorVersionName

Required. The resource name of the ProcessorVersion to list evaluations for. projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}

Returns
TypeDescription
DocumentProcessorServiceClient.ListEvaluationsPagedResponse

listEvaluations(String parent)

public final DocumentProcessorServiceClient.ListEvaluationsPagedResponse listEvaluations(String parent)

Retrieves a set of evaluations for a given processor version.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   String parent =
       ProcessorVersionName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]")
           .toString();
   for (Evaluation element :
       documentProcessorServiceClient.listEvaluations(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
parentString

Required. The resource name of the ProcessorVersion to list evaluations for. projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}

Returns
TypeDescription
DocumentProcessorServiceClient.ListEvaluationsPagedResponse

listEvaluationsCallable()

public final UnaryCallable<ListEvaluationsRequest,ListEvaluationsResponse> listEvaluationsCallable()

Retrieves a set of evaluations for a given processor version.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   ListEvaluationsRequest request =
       ListEvaluationsRequest.newBuilder()
           .setParent(
               ProcessorVersionName.of(
                       "[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListEvaluationsResponse response =
         documentProcessorServiceClient.listEvaluationsCallable().call(request);
     for (Evaluation element : response.getEvaluationsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
TypeDescription
UnaryCallable<ListEvaluationsRequest,ListEvaluationsResponse>

listEvaluationsPagedCallable()

public final UnaryCallable<ListEvaluationsRequest,DocumentProcessorServiceClient.ListEvaluationsPagedResponse> listEvaluationsPagedCallable()

Retrieves a set of evaluations for a given processor version.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   ListEvaluationsRequest request =
       ListEvaluationsRequest.newBuilder()
           .setParent(
               ProcessorVersionName.of(
                       "[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Evaluation> future =
       documentProcessorServiceClient.listEvaluationsPagedCallable().futureCall(request);
   // Do something.
   for (Evaluation element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
TypeDescription
UnaryCallable<ListEvaluationsRequest,ListEvaluationsPagedResponse>

listLocations(ListLocationsRequest request)

public final DocumentProcessorServiceClient.ListLocationsPagedResponse listLocations(ListLocationsRequest request)

Lists information about the supported locations for this service.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Location element : documentProcessorServiceClient.listLocations(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
requestcom.google.cloud.location.ListLocationsRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
DocumentProcessorServiceClient.ListLocationsPagedResponse

listLocationsCallable()

public final UnaryCallable<ListLocationsRequest,ListLocationsResponse> listLocationsCallable()

Lists information about the supported locations for this service.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListLocationsResponse response =
         documentProcessorServiceClient.listLocationsCallable().call(request);
     for (Location element : response.getLocationsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
TypeDescription
UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse>

listLocationsPagedCallable()

public final UnaryCallable<ListLocationsRequest,DocumentProcessorServiceClient.ListLocationsPagedResponse> listLocationsPagedCallable()

Lists information about the supported locations for this service.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Location> future =
       documentProcessorServiceClient.listLocationsPagedCallable().futureCall(request);
   // Do something.
   for (Location element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
TypeDescription
UnaryCallable<com.google.cloud.location.ListLocationsRequest,ListLocationsPagedResponse>

listProcessorTypes(ListProcessorTypesRequest request)

public final DocumentProcessorServiceClient.ListProcessorTypesPagedResponse listProcessorTypes(ListProcessorTypesRequest request)

Lists the processor types that exist.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   ListProcessorTypesRequest request =
       ListProcessorTypesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (ProcessorType element :
       documentProcessorServiceClient.listProcessorTypes(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
requestListProcessorTypesRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
DocumentProcessorServiceClient.ListProcessorTypesPagedResponse

listProcessorTypes(LocationName parent)

public final DocumentProcessorServiceClient.ListProcessorTypesPagedResponse listProcessorTypes(LocationName parent)

Lists the processor types that exist.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (ProcessorType element :
       documentProcessorServiceClient.listProcessorTypes(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
parentLocationName

Required. The location of processor type to list. The available processor types may depend on the allow-listing on projects. Format: projects/{project}/locations/{location}

Returns
TypeDescription
DocumentProcessorServiceClient.ListProcessorTypesPagedResponse

listProcessorTypes(String parent)

public final DocumentProcessorServiceClient.ListProcessorTypesPagedResponse listProcessorTypes(String parent)

Lists the processor types that exist.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (ProcessorType element :
       documentProcessorServiceClient.listProcessorTypes(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
parentString

Required. The location of processor type to list. The available processor types may depend on the allow-listing on projects. Format: projects/{project}/locations/{location}

Returns
TypeDescription
DocumentProcessorServiceClient.ListProcessorTypesPagedResponse

listProcessorTypesCallable()

public final UnaryCallable<ListProcessorTypesRequest,ListProcessorTypesResponse> listProcessorTypesCallable()

Lists the processor types that exist.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   ListProcessorTypesRequest request =
       ListProcessorTypesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListProcessorTypesResponse response =
         documentProcessorServiceClient.listProcessorTypesCallable().call(request);
     for (ProcessorType element : response.getProcessorTypesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
TypeDescription
UnaryCallable<ListProcessorTypesRequest,ListProcessorTypesResponse>

listProcessorTypesPagedCallable()

public final UnaryCallable<ListProcessorTypesRequest,DocumentProcessorServiceClient.ListProcessorTypesPagedResponse> listProcessorTypesPagedCallable()

Lists the processor types that exist.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   ListProcessorTypesRequest request =
       ListProcessorTypesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<ProcessorType> future =
       documentProcessorServiceClient.listProcessorTypesPagedCallable().futureCall(request);
   // Do something.
   for (ProcessorType element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
TypeDescription
UnaryCallable<ListProcessorTypesRequest,ListProcessorTypesPagedResponse>

listProcessorVersions(ListProcessorVersionsRequest request)

public final DocumentProcessorServiceClient.ListProcessorVersionsPagedResponse listProcessorVersions(ListProcessorVersionsRequest request)

Lists all versions of a processor.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   ListProcessorVersionsRequest request =
       ListProcessorVersionsRequest.newBuilder()
           .setParent(ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (ProcessorVersion element :
       documentProcessorServiceClient.listProcessorVersions(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
requestListProcessorVersionsRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
DocumentProcessorServiceClient.ListProcessorVersionsPagedResponse

listProcessorVersions(ProcessorName parent)

public final DocumentProcessorServiceClient.ListProcessorVersionsPagedResponse listProcessorVersions(ProcessorName parent)

Lists all versions of a processor.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   ProcessorName parent = ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]");
   for (ProcessorVersion element :
       documentProcessorServiceClient.listProcessorVersions(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
parentProcessorName

Required. The parent (project, location and processor) to list all versions. Format: projects/{project}/locations/{location}/processors/{processor}

Returns
TypeDescription
DocumentProcessorServiceClient.ListProcessorVersionsPagedResponse

listProcessorVersions(String parent)

public final DocumentProcessorServiceClient.ListProcessorVersionsPagedResponse listProcessorVersions(String parent)

Lists all versions of a processor.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   String parent = ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString();
   for (ProcessorVersion element :
       documentProcessorServiceClient.listProcessorVersions(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
parentString

Required. The parent (project, location and processor) to list all versions. Format: projects/{project}/locations/{location}/processors/{processor}

Returns
TypeDescription
DocumentProcessorServiceClient.ListProcessorVersionsPagedResponse

listProcessorVersionsCallable()

public final UnaryCallable<ListProcessorVersionsRequest,ListProcessorVersionsResponse> listProcessorVersionsCallable()

Lists all versions of a processor.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   ListProcessorVersionsRequest request =
       ListProcessorVersionsRequest.newBuilder()
           .setParent(ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListProcessorVersionsResponse response =
         documentProcessorServiceClient.listProcessorVersionsCallable().call(request);
     for (ProcessorVersion element : response.getProcessorVersionsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
TypeDescription
UnaryCallable<ListProcessorVersionsRequest,ListProcessorVersionsResponse>

listProcessorVersionsPagedCallable()

public final UnaryCallable<ListProcessorVersionsRequest,DocumentProcessorServiceClient.ListProcessorVersionsPagedResponse> listProcessorVersionsPagedCallable()

Lists all versions of a processor.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   ListProcessorVersionsRequest request =
       ListProcessorVersionsRequest.newBuilder()
           .setParent(ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<ProcessorVersion> future =
       documentProcessorServiceClient.listProcessorVersionsPagedCallable().futureCall(request);
   // Do something.
   for (ProcessorVersion element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
TypeDescription
UnaryCallable<ListProcessorVersionsRequest,ListProcessorVersionsPagedResponse>

listProcessors(ListProcessorsRequest request)

public final DocumentProcessorServiceClient.ListProcessorsPagedResponse listProcessors(ListProcessorsRequest request)

Lists all processors which belong to this project.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   ListProcessorsRequest request =
       ListProcessorsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Processor element :
       documentProcessorServiceClient.listProcessors(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
requestListProcessorsRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
DocumentProcessorServiceClient.ListProcessorsPagedResponse

listProcessors(LocationName parent)

public final DocumentProcessorServiceClient.ListProcessorsPagedResponse listProcessors(LocationName parent)

Lists all processors which belong to this project.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (Processor element : documentProcessorServiceClient.listProcessors(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
parentLocationName

Required. The parent (project and location) which owns this collection of Processors. Format: projects/{project}/locations/{location}

Returns
TypeDescription
DocumentProcessorServiceClient.ListProcessorsPagedResponse

listProcessors(String parent)

public final DocumentProcessorServiceClient.ListProcessorsPagedResponse listProcessors(String parent)

Lists all processors which belong to this project.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (Processor element : documentProcessorServiceClient.listProcessors(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
parentString

Required. The parent (project and location) which owns this collection of Processors. Format: projects/{project}/locations/{location}

Returns
TypeDescription
DocumentProcessorServiceClient.ListProcessorsPagedResponse

listProcessorsCallable()

public final UnaryCallable<ListProcessorsRequest,ListProcessorsResponse> listProcessorsCallable()

Lists all processors which belong to this project.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   ListProcessorsRequest request =
       ListProcessorsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListProcessorsResponse response =
         documentProcessorServiceClient.listProcessorsCallable().call(request);
     for (Processor element : response.getProcessorsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
TypeDescription
UnaryCallable<ListProcessorsRequest,ListProcessorsResponse>

listProcessorsPagedCallable()

public final UnaryCallable<ListProcessorsRequest,DocumentProcessorServiceClient.ListProcessorsPagedResponse> listProcessorsPagedCallable()

Lists all processors which belong to this project.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   ListProcessorsRequest request =
       ListProcessorsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Processor> future =
       documentProcessorServiceClient.listProcessorsPagedCallable().futureCall(request);
   // Do something.
   for (Processor element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
TypeDescription
UnaryCallable<ListProcessorsRequest,ListProcessorsPagedResponse>

processDocument(ResourceName name)

public final ProcessResponse processDocument(ResourceName name)

Processes a single document.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   ResourceName name = ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]");
   ProcessResponse response = documentProcessorServiceClient.processDocument(name);
 }
 
Parameter
NameDescription
namecom.google.api.resourcenames.ResourceName

Required. The resource name of the Processor or ProcessorVersion to use for processing. If a Processor is specified, the server will use its default version. Format: projects/{project}/locations/{location}/processors/{processor}, or projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}

Returns
TypeDescription
ProcessResponse

processDocument(ProcessRequest request)

public final ProcessResponse processDocument(ProcessRequest request)

Processes a single document.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   ProcessRequest request =
       ProcessRequest.newBuilder()
           .setName(ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString())
           .setSkipHumanReview(true)
           .setFieldMask(FieldMask.newBuilder().build())
           .build();
   ProcessResponse response = documentProcessorServiceClient.processDocument(request);
 }
 
Parameter
NameDescription
requestProcessRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
ProcessResponse

processDocument(String name)

public final ProcessResponse processDocument(String name)

Processes a single document.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   String name =
       EvaluationName.of(
               "[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]", "[EVALUATION]")
           .toString();
   ProcessResponse response = documentProcessorServiceClient.processDocument(name);
 }
 
Parameter
NameDescription
nameString

Required. The resource name of the Processor or ProcessorVersion to use for processing. If a Processor is specified, the server will use its default version. Format: projects/{project}/locations/{location}/processors/{processor}, or projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}

Returns
TypeDescription
ProcessResponse

processDocumentCallable()

public final UnaryCallable<ProcessRequest,ProcessResponse> processDocumentCallable()

Processes a single document.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   ProcessRequest request =
       ProcessRequest.newBuilder()
           .setName(ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString())
           .setSkipHumanReview(true)
           .setFieldMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<ProcessResponse> future =
       documentProcessorServiceClient.processDocumentCallable().futureCall(request);
   // Do something.
   ProcessResponse response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<ProcessRequest,ProcessResponse>

reviewDocumentAsync(HumanReviewConfigName humanReviewConfig)

public final OperationFuture<ReviewDocumentResponse,ReviewDocumentOperationMetadata> reviewDocumentAsync(HumanReviewConfigName humanReviewConfig)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   HumanReviewConfigName humanReviewConfig =
       HumanReviewConfigName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]");
   ReviewDocumentResponse response =
       documentProcessorServiceClient.reviewDocumentAsync(humanReviewConfig).get();
 }
 
Parameter
NameDescription
humanReviewConfigHumanReviewConfigName

Required. The resource name of the HumanReviewConfig that the document will be reviewed with.

Returns
TypeDescription
OperationFuture<ReviewDocumentResponse,ReviewDocumentOperationMetadata>

reviewDocumentAsync(ReviewDocumentRequest request)

public final OperationFuture<ReviewDocumentResponse,ReviewDocumentOperationMetadata> reviewDocumentAsync(ReviewDocumentRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   ReviewDocumentRequest request =
       ReviewDocumentRequest.newBuilder()
           .setHumanReviewConfig(
               HumanReviewConfigName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString())
           .setEnableSchemaValidation(true)
           .setDocumentSchema(DocumentSchema.newBuilder().build())
           .build();
   ReviewDocumentResponse response =
       documentProcessorServiceClient.reviewDocumentAsync(request).get();
 }
 
Parameter
NameDescription
requestReviewDocumentRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
OperationFuture<ReviewDocumentResponse,ReviewDocumentOperationMetadata>

reviewDocumentAsync(String humanReviewConfig)

public final OperationFuture<ReviewDocumentResponse,ReviewDocumentOperationMetadata> reviewDocumentAsync(String humanReviewConfig)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   String humanReviewConfig =
       HumanReviewConfigName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString();
   ReviewDocumentResponse response =
       documentProcessorServiceClient.reviewDocumentAsync(humanReviewConfig).get();
 }
 
Parameter
NameDescription
humanReviewConfigString

Required. The resource name of the HumanReviewConfig that the document will be reviewed with.

Returns
TypeDescription
OperationFuture<ReviewDocumentResponse,ReviewDocumentOperationMetadata>

reviewDocumentCallable()

public final UnaryCallable<ReviewDocumentRequest,Operation> reviewDocumentCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   ReviewDocumentRequest request =
       ReviewDocumentRequest.newBuilder()
           .setHumanReviewConfig(
               HumanReviewConfigName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString())
           .setEnableSchemaValidation(true)
           .setDocumentSchema(DocumentSchema.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       documentProcessorServiceClient.reviewDocumentCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<ReviewDocumentRequest,Operation>

reviewDocumentOperationCallable()

public final OperationCallable<ReviewDocumentRequest,ReviewDocumentResponse,ReviewDocumentOperationMetadata> reviewDocumentOperationCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   ReviewDocumentRequest request =
       ReviewDocumentRequest.newBuilder()
           .setHumanReviewConfig(
               HumanReviewConfigName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString())
           .setEnableSchemaValidation(true)
           .setDocumentSchema(DocumentSchema.newBuilder().build())
           .build();
   OperationFuture<ReviewDocumentResponse, ReviewDocumentOperationMetadata> future =
       documentProcessorServiceClient.reviewDocumentOperationCallable().futureCall(request);
   // Do something.
   ReviewDocumentResponse response = future.get();
 }
 
Returns
TypeDescription
OperationCallable<ReviewDocumentRequest,ReviewDocumentResponse,ReviewDocumentOperationMetadata>

setDefaultProcessorVersionAsync(SetDefaultProcessorVersionRequest request)

public final OperationFuture<SetDefaultProcessorVersionResponse,SetDefaultProcessorVersionMetadata> setDefaultProcessorVersionAsync(SetDefaultProcessorVersionRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   SetDefaultProcessorVersionRequest request =
       SetDefaultProcessorVersionRequest.newBuilder()
           .setProcessor(ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString())
           .setDefaultProcessorVersion(
               ProcessorVersionName.of(
                       "[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]")
                   .toString())
           .build();
   SetDefaultProcessorVersionResponse response =
       documentProcessorServiceClient.setDefaultProcessorVersionAsync(request).get();
 }
 
Parameter
NameDescription
requestSetDefaultProcessorVersionRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
OperationFuture<SetDefaultProcessorVersionResponse,SetDefaultProcessorVersionMetadata>

setDefaultProcessorVersionCallable()

public final UnaryCallable<SetDefaultProcessorVersionRequest,Operation> setDefaultProcessorVersionCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   SetDefaultProcessorVersionRequest request =
       SetDefaultProcessorVersionRequest.newBuilder()
           .setProcessor(ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString())
           .setDefaultProcessorVersion(
               ProcessorVersionName.of(
                       "[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]")
                   .toString())
           .build();
   ApiFuture<Operation> future =
       documentProcessorServiceClient.setDefaultProcessorVersionCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<SetDefaultProcessorVersionRequest,Operation>

setDefaultProcessorVersionOperationCallable()

public final OperationCallable<SetDefaultProcessorVersionRequest,SetDefaultProcessorVersionResponse,SetDefaultProcessorVersionMetadata> setDefaultProcessorVersionOperationCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   SetDefaultProcessorVersionRequest request =
       SetDefaultProcessorVersionRequest.newBuilder()
           .setProcessor(ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString())
           .setDefaultProcessorVersion(
               ProcessorVersionName.of(
                       "[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]")
                   .toString())
           .build();
   OperationFuture<SetDefaultProcessorVersionResponse, SetDefaultProcessorVersionMetadata>
       future =
           documentProcessorServiceClient
               .setDefaultProcessorVersionOperationCallable()
               .futureCall(request);
   // Do something.
   SetDefaultProcessorVersionResponse response = future.get();
 }
 
Returns
TypeDescription
OperationCallable<SetDefaultProcessorVersionRequest,SetDefaultProcessorVersionResponse,SetDefaultProcessorVersionMetadata>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

trainProcessorVersionAsync(ProcessorName parent, ProcessorVersion processorVersion)

public final OperationFuture<TrainProcessorVersionResponse,TrainProcessorVersionMetadata> trainProcessorVersionAsync(ProcessorName parent, ProcessorVersion processorVersion)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   ProcessorName parent = ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]");
   ProcessorVersion processorVersion = ProcessorVersion.newBuilder().build();
   TrainProcessorVersionResponse response =
       documentProcessorServiceClient.trainProcessorVersionAsync(parent, processorVersion).get();
 }
 
Parameters
NameDescription
parentProcessorName

Required. The parent (project, location and processor) to create the new version for. Format: projects/{project}/locations/{location}/processors/{processor}.

processorVersionProcessorVersion

Required. The processor version to be created.

Returns
TypeDescription
OperationFuture<TrainProcessorVersionResponse,TrainProcessorVersionMetadata>

trainProcessorVersionAsync(TrainProcessorVersionRequest request)

public final OperationFuture<TrainProcessorVersionResponse,TrainProcessorVersionMetadata> trainProcessorVersionAsync(TrainProcessorVersionRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   TrainProcessorVersionRequest request =
       TrainProcessorVersionRequest.newBuilder()
           .setParent(ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString())
           .setProcessorVersion(ProcessorVersion.newBuilder().build())
           .setDocumentSchema(DocumentSchema.newBuilder().build())
           .setInputData(TrainProcessorVersionRequest.InputData.newBuilder().build())
           .setBaseProcessorVersion("baseProcessorVersion337709271")
           .build();
   TrainProcessorVersionResponse response =
       documentProcessorServiceClient.trainProcessorVersionAsync(request).get();
 }
 
Parameter
NameDescription
requestTrainProcessorVersionRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
OperationFuture<TrainProcessorVersionResponse,TrainProcessorVersionMetadata>

trainProcessorVersionAsync(String parent, ProcessorVersion processorVersion)

public final OperationFuture<TrainProcessorVersionResponse,TrainProcessorVersionMetadata> trainProcessorVersionAsync(String parent, ProcessorVersion processorVersion)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   String parent = ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString();
   ProcessorVersion processorVersion = ProcessorVersion.newBuilder().build();
   TrainProcessorVersionResponse response =
       documentProcessorServiceClient.trainProcessorVersionAsync(parent, processorVersion).get();
 }
 
Parameters
NameDescription
parentString

Required. The parent (project, location and processor) to create the new version for. Format: projects/{project}/locations/{location}/processors/{processor}.

processorVersionProcessorVersion

Required. The processor version to be created.

Returns
TypeDescription
OperationFuture<TrainProcessorVersionResponse,TrainProcessorVersionMetadata>

trainProcessorVersionCallable()

public final UnaryCallable<TrainProcessorVersionRequest,Operation> trainProcessorVersionCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   TrainProcessorVersionRequest request =
       TrainProcessorVersionRequest.newBuilder()
           .setParent(ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString())
           .setProcessorVersion(ProcessorVersion.newBuilder().build())
           .setDocumentSchema(DocumentSchema.newBuilder().build())
           .setInputData(TrainProcessorVersionRequest.InputData.newBuilder().build())
           .setBaseProcessorVersion("baseProcessorVersion337709271")
           .build();
   ApiFuture<Operation> future =
       documentProcessorServiceClient.trainProcessorVersionCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<TrainProcessorVersionRequest,Operation>

trainProcessorVersionOperationCallable()

public final OperationCallable<TrainProcessorVersionRequest,TrainProcessorVersionResponse,TrainProcessorVersionMetadata> trainProcessorVersionOperationCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   TrainProcessorVersionRequest request =
       TrainProcessorVersionRequest.newBuilder()
           .setParent(ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString())
           .setProcessorVersion(ProcessorVersion.newBuilder().build())
           .setDocumentSchema(DocumentSchema.newBuilder().build())
           .setInputData(TrainProcessorVersionRequest.InputData.newBuilder().build())
           .setBaseProcessorVersion("baseProcessorVersion337709271")
           .build();
   OperationFuture<TrainProcessorVersionResponse, TrainProcessorVersionMetadata> future =
       documentProcessorServiceClient
           .trainProcessorVersionOperationCallable()
           .futureCall(request);
   // Do something.
   TrainProcessorVersionResponse response = future.get();
 }
 
Returns
TypeDescription
OperationCallable<TrainProcessorVersionRequest,TrainProcessorVersionResponse,TrainProcessorVersionMetadata>

undeployProcessorVersionAsync(ProcessorVersionName name)

public final OperationFuture<UndeployProcessorVersionResponse,UndeployProcessorVersionMetadata> undeployProcessorVersionAsync(ProcessorVersionName name)

Undeploys the processor version.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   ProcessorVersionName name =
       ProcessorVersionName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]");
   UndeployProcessorVersionResponse response =
       documentProcessorServiceClient.undeployProcessorVersionAsync(name).get();
 }
 
Parameter
NameDescription
nameProcessorVersionName

Required. The processor version resource name to be undeployed.

Returns
TypeDescription
OperationFuture<UndeployProcessorVersionResponse,UndeployProcessorVersionMetadata>

undeployProcessorVersionAsync(UndeployProcessorVersionRequest request)

public final OperationFuture<UndeployProcessorVersionResponse,UndeployProcessorVersionMetadata> undeployProcessorVersionAsync(UndeployProcessorVersionRequest request)

Undeploys the processor version.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   UndeployProcessorVersionRequest request =
       UndeployProcessorVersionRequest.newBuilder()
           .setName(
               ProcessorVersionName.of(
                       "[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]")
                   .toString())
           .build();
   UndeployProcessorVersionResponse response =
       documentProcessorServiceClient.undeployProcessorVersionAsync(request).get();
 }
 
Parameter
NameDescription
requestUndeployProcessorVersionRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
OperationFuture<UndeployProcessorVersionResponse,UndeployProcessorVersionMetadata>

undeployProcessorVersionAsync(String name)

public final OperationFuture<UndeployProcessorVersionResponse,UndeployProcessorVersionMetadata> undeployProcessorVersionAsync(String name)

Undeploys the processor version.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   String name =
       ProcessorVersionName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]")
           .toString();
   UndeployProcessorVersionResponse response =
       documentProcessorServiceClient.undeployProcessorVersionAsync(name).get();
 }
 
Parameter
NameDescription
nameString

Required. The processor version resource name to be undeployed.

Returns
TypeDescription
OperationFuture<UndeployProcessorVersionResponse,UndeployProcessorVersionMetadata>

undeployProcessorVersionCallable()

public final UnaryCallable<UndeployProcessorVersionRequest,Operation> undeployProcessorVersionCallable()

Undeploys the processor version.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   UndeployProcessorVersionRequest request =
       UndeployProcessorVersionRequest.newBuilder()
           .setName(
               ProcessorVersionName.of(
                       "[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]")
                   .toString())
           .build();
   ApiFuture<Operation> future =
       documentProcessorServiceClient.undeployProcessorVersionCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<UndeployProcessorVersionRequest,Operation>

undeployProcessorVersionOperationCallable()

public final OperationCallable<UndeployProcessorVersionRequest,UndeployProcessorVersionResponse,UndeployProcessorVersionMetadata> undeployProcessorVersionOperationCallable()

Undeploys the processor version.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   UndeployProcessorVersionRequest request =
       UndeployProcessorVersionRequest.newBuilder()
           .setName(
               ProcessorVersionName.of(
                       "[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]")
                   .toString())
           .build();
   OperationFuture<UndeployProcessorVersionResponse, UndeployProcessorVersionMetadata> future =
       documentProcessorServiceClient
           .undeployProcessorVersionOperationCallable()
           .futureCall(request);
   // Do something.
   UndeployProcessorVersionResponse response = future.get();
 }
 
Returns
TypeDescription
OperationCallable<UndeployProcessorVersionRequest,UndeployProcessorVersionResponse,UndeployProcessorVersionMetadata>