Package com.google.cloud.documentai.v1

Class DocumentProcessorServiceClient

  • All Implemented Interfaces:
    com.google.api.gax.core.BackgroundResource, AutoCloseable
    @Generated("by gapic-generator-java")
public class DocumentProcessorServiceClient
extends Object
implements com.google.api.gax.core.BackgroundResource
    Service Description: Service to call Document AI 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.

    • Constructor Detail

      • DocumentProcessorServiceClient

        protected DocumentProcessorServiceClient​(DocumentProcessorServiceSettings settings)
                                  throws IOException
        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.
        Throws:
        IOException

    • Method Detail

      • getOperationsClient

        public final com.google.longrunning.OperationsClient getOperationsClient()
        Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

      • getHttpJsonOperationsClient

        @BetaApi
public final com.google.api.gax.httpjson.longrunning.OperationsClient getHttpJsonOperationsClient()
        Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

      • processDocument

        public final ProcessResponse processDocument​(com.google.api.resourcenames.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);
 }
        Parameters:
        name - Required. The resource name of the [Processor][google.cloud.documentai.v1.Processor] or [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] to use for processing. If a [Processor][google.cloud.documentai.v1.Processor] is specified, the server will use its [default version][google.cloud.documentai.v1.Processor.default_processor_version]. Format: `projects/{project}/locations/{location}/processors/{processor}`, or `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • processDocument

        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);
 }
        Parameters:
        name - Required. The resource name of the [Processor][google.cloud.documentai.v1.Processor] or [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] to use for processing. If a [Processor][google.cloud.documentai.v1.Processor] is specified, the server will use its [default version][google.cloud.documentai.v1.Processor.default_processor_version]. Format: `projects/{project}/locations/{location}/processors/{processor}`, or `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • processDocument

        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())
           .setProcessOptions(ProcessOptions.newBuilder().build())
           .build();
   ProcessResponse response = documentProcessorServiceClient.processDocument(request);
 }
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • processDocumentCallable

        public final com.google.api.gax.rpc.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())
           .setProcessOptions(ProcessOptions.newBuilder().build())
           .build();
   ApiFuture<ProcessResponse> future =
       documentProcessorServiceClient.processDocumentCallable().futureCall(request);
   // Do something.
   ProcessResponse response = future.get();
 }

      • batchProcessDocumentsAsync

        public final com.google.api.gax.longrunning.OperationFuture<BatchProcessResponse,​BatchProcessMetadata> batchProcessDocumentsAsync​(com.google.api.resourcenames.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();
 }
        Parameters:
        name - Required. The resource name of [Processor][google.cloud.documentai.v1.Processor] or [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion]. Format: `projects/{project}/locations/{location}/processors/{processor}`, or `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • batchProcessDocumentsAsync

        public final com.google.api.gax.longrunning.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();
 }
        Parameters:
        name - Required. The resource name of [Processor][google.cloud.documentai.v1.Processor] or [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion]. Format: `projects/{project}/locations/{location}/processors/{processor}`, or `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • batchProcessDocumentsAsync

        public final com.google.api.gax.longrunning.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)
           .setProcessOptions(ProcessOptions.newBuilder().build())
           .build();
   BatchProcessResponse response =
       documentProcessorServiceClient.batchProcessDocumentsAsync(request).get();
 }
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • batchProcessDocumentsOperationCallable

        public final com.google.api.gax.rpc.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)
           .setProcessOptions(ProcessOptions.newBuilder().build())
           .build();
   OperationFuture<BatchProcessResponse, BatchProcessMetadata> future =
       documentProcessorServiceClient
           .batchProcessDocumentsOperationCallable()
           .futureCall(request);
   // Do something.
   BatchProcessResponse response = future.get();
 }

      • batchProcessDocumentsCallable

        public final com.google.api.gax.rpc.UnaryCallable<BatchProcessRequest,​com.google.longrunning.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)
           .setProcessOptions(ProcessOptions.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       documentProcessorServiceClient.batchProcessDocumentsCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

      • fetchProcessorTypes

        public final FetchProcessorTypesResponse fetchProcessorTypes​(LocationName parent)
        Fetches processor types. Note that we don't use [ListProcessorTypes][google.cloud.documentai.v1.DocumentProcessorService.ListProcessorTypes] here, because it isn't 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);
 }
        Parameters:
        parent - Required. The location of processor types to list. Format: `projects/{project}/locations/{location}`.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • fetchProcessorTypes

        public final FetchProcessorTypesResponse fetchProcessorTypes​(String parent)
        Fetches processor types. Note that we don't use [ListProcessorTypes][google.cloud.documentai.v1.DocumentProcessorService.ListProcessorTypes] here, because it isn't 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);
 }
        Parameters:
        parent - Required. The location of processor types to list. Format: `projects/{project}/locations/{location}`.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • fetchProcessorTypes

        public final FetchProcessorTypesResponse fetchProcessorTypes​(FetchProcessorTypesRequest request)
        Fetches processor types. Note that we don't use [ListProcessorTypes][google.cloud.documentai.v1.DocumentProcessorService.ListProcessorTypes] here, because it isn't 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);
 }
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • fetchProcessorTypesCallable

        public final com.google.api.gax.rpc.UnaryCallable<FetchProcessorTypesRequest,​FetchProcessorTypesResponse> fetchProcessorTypesCallable()
        Fetches processor types. Note that we don't use [ListProcessorTypes][google.cloud.documentai.v1.DocumentProcessorService.ListProcessorTypes] here, because it isn't 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();
 }

      • listProcessorTypes

        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);
   }
 }
        Parameters:
        parent - Required. The location of processor types to list. Format: `projects/{project}/locations/{location}`.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • listProcessorTypes

        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);
   }
 }
        Parameters:
        parent - Required. The location of processor types to list. Format: `projects/{project}/locations/{location}`.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • listProcessorTypes

        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);
   }
 }
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • listProcessorTypesPagedCallable

        public final com.google.api.gax.rpc.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);
   }
 }

      • listProcessorTypesCallable

        public final com.google.api.gax.rpc.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;
     }
   }
 }

      • getProcessorType

        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);
 }
        Parameters:
        name - Required. The processor type resource name.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • getProcessorType

        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);
 }
        Parameters:
        name - Required. The processor type resource name.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • getProcessorType

        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);
 }
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • getProcessorTypeCallable

        public final com.google.api.gax.rpc.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();
 }

      • listProcessors

        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);
   }
 }
        Parameters:
        parent - Required. The parent (project and location) which owns this collection of Processors. Format: `projects/{project}/locations/{location}`
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • listProcessors

        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);
   }
 }
        Parameters:
        parent - Required. The parent (project and location) which owns this collection of Processors. Format: `projects/{project}/locations/{location}`
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • listProcessors

        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);
   }
 }
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • listProcessorsPagedCallable

        public final com.google.api.gax.rpc.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);
   }
 }

      • listProcessorsCallable

        public final com.google.api.gax.rpc.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;
     }
   }
 }

      • getProcessor

        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);
 }
        Parameters:
        name - Required. The processor resource name.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • getProcessor

        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);
 }
        Parameters:
        name - Required. The processor resource name.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • getProcessor

        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);
 }
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • getProcessorCallable

        public final com.google.api.gax.rpc.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();
 }

      • trainProcessorVersionAsync

        public final com.google.api.gax.longrunning.OperationFuture<TrainProcessorVersionResponse,​TrainProcessorVersionMetadata> trainProcessorVersionAsync​(ProcessorName parent,
                                                                                                                                                          ProcessorVersion processorVersion)
        Trains a new processor version. Operation metadata is returned as [TrainProcessorVersionMetadata][google.cloud.documentai.v1.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:
        parent - Required. The parent (project, location and processor) to create the new version for. Format: `projects/{project}/locations/{location}/processors/{processor}`.
        processorVersion - Required. The processor version to be created.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • trainProcessorVersionAsync

        public final com.google.api.gax.longrunning.OperationFuture<TrainProcessorVersionResponse,​TrainProcessorVersionMetadata> trainProcessorVersionAsync​(String parent,
                                                                                                                                                          ProcessorVersion processorVersion)
        Trains a new processor version. Operation metadata is returned as [TrainProcessorVersionMetadata][google.cloud.documentai.v1.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:
        parent - Required. The parent (project, location and processor) to create the new version for. Format: `projects/{project}/locations/{location}/processors/{processor}`.
        processorVersion - Required. The processor version to be created.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • trainProcessorVersionAsync

        public final com.google.api.gax.longrunning.OperationFuture<TrainProcessorVersionResponse,​TrainProcessorVersionMetadata> trainProcessorVersionAsync​(TrainProcessorVersionRequest request)
        Trains a new processor version. Operation metadata is returned as [TrainProcessorVersionMetadata][google.cloud.documentai.v1.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();
 }
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • trainProcessorVersionOperationCallable

        public final com.google.api.gax.rpc.OperationCallable<TrainProcessorVersionRequest,​TrainProcessorVersionResponse,​TrainProcessorVersionMetadata> trainProcessorVersionOperationCallable()
        Trains a new processor version. Operation metadata is returned as [TrainProcessorVersionMetadata][google.cloud.documentai.v1.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();
 }

      • trainProcessorVersionCallable

        public final com.google.api.gax.rpc.UnaryCallable<TrainProcessorVersionRequest,​com.google.longrunning.Operation> trainProcessorVersionCallable()
        Trains a new processor version. Operation metadata is returned as [TrainProcessorVersionMetadata][google.cloud.documentai.v1.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();
 }

      • getProcessorVersion

        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);
 }
        Parameters:
        name - Required. The processor resource name.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • getProcessorVersion

        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);
 }
        Parameters:
        name - Required. The processor resource name.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • getProcessorVersion

        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);
 }
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • getProcessorVersionCallable

        public final com.google.api.gax.rpc.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();
 }

      • listProcessorVersions

        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);
   }
 }
        Parameters:
        parent - Required. The parent (project, location and processor) to list all versions. Format: `projects/{project}/locations/{location}/processors/{processor}`
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • listProcessorVersions

        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);
   }
 }
        Parameters:
        parent - Required. The parent (project, location and processor) to list all versions. Format: `projects/{project}/locations/{location}/processors/{processor}`
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • listProcessorVersions

        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);
   }
 }
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • listProcessorVersionsPagedCallable

        public final com.google.api.gax.rpc.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);
   }
 }

      • listProcessorVersionsCallable

        public final com.google.api.gax.rpc.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;
     }
   }
 }

      • deleteProcessorVersionAsync

        public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.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();
 }
        Parameters:
        name - Required. The processor version resource name to be deleted.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • deleteProcessorVersionAsync

        public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.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();
 }
        Parameters:
        name - Required. The processor version resource name to be deleted.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • deleteProcessorVersionAsync

        public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.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();
 }
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • deleteProcessorVersionOperationCallable

        public final com.google.api.gax.rpc.OperationCallable<DeleteProcessorVersionRequest,​com.google.protobuf.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();
 }

      • deleteProcessorVersionCallable

        public final com.google.api.gax.rpc.UnaryCallable<DeleteProcessorVersionRequest,​com.google.longrunning.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();
 }

      • deployProcessorVersionAsync

        public final com.google.api.gax.longrunning.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();
 }
        Parameters:
        name - Required. The processor version resource name to be deployed.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • deployProcessorVersionAsync

        public final com.google.api.gax.longrunning.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();
 }
        Parameters:
        name - Required. The processor version resource name to be deployed.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • deployProcessorVersionAsync

        public final com.google.api.gax.longrunning.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();
 }
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • deployProcessorVersionOperationCallable

        public final com.google.api.gax.rpc.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();
 }

      • deployProcessorVersionCallable

        public final com.google.api.gax.rpc.UnaryCallable<DeployProcessorVersionRequest,​com.google.longrunning.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();
 }

      • undeployProcessorVersionAsync

        public final com.google.api.gax.longrunning.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();
 }
        Parameters:
        name - Required. The processor version resource name to be undeployed.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • undeployProcessorVersionAsync

        public final com.google.api.gax.longrunning.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();
 }
        Parameters:
        name - Required. The processor version resource name to be undeployed.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • undeployProcessorVersionAsync

        public final com.google.api.gax.longrunning.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();
 }
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • undeployProcessorVersionOperationCallable

        public final com.google.api.gax.rpc.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();
 }

      • undeployProcessorVersionCallable

        public final com.google.api.gax.rpc.UnaryCallable<UndeployProcessorVersionRequest,​com.google.longrunning.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();
 }

      • createProcessor

        public final Processor createProcessor​(LocationName parent,
                                       Processor processor)
        Creates a processor from the [ProcessorType][google.cloud.documentai.v1.ProcessorType] provided. 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:
        parent - Required. The parent (project and location) under which to create the processor. Format: `projects/{project}/locations/{location}`
        processor - Required. The processor to be created, requires [Processor.type][google.cloud.documentai.v1.Processor.type] and [Processor.display_name]][] to be set. Also, the [Processor.kms_key_name][google.cloud.documentai.v1.Processor.kms_key_name] field must be set if the processor is under CMEK.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • createProcessor

        public final Processor createProcessor​(String parent,
                                       Processor processor)
        Creates a processor from the [ProcessorType][google.cloud.documentai.v1.ProcessorType] provided. 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:
        parent - Required. The parent (project and location) under which to create the processor. Format: `projects/{project}/locations/{location}`
        processor - Required. The processor to be created, requires [Processor.type][google.cloud.documentai.v1.Processor.type] and [Processor.display_name]][] to be set. Also, the [Processor.kms_key_name][google.cloud.documentai.v1.Processor.kms_key_name] field must be set if the processor is under CMEK.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • createProcessor

        public final Processor createProcessor​(CreateProcessorRequest request)
        Creates a processor from the [ProcessorType][google.cloud.documentai.v1.ProcessorType] provided. 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);
 }
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • createProcessorCallable

        public final com.google.api.gax.rpc.UnaryCallable<CreateProcessorRequest,​Processor> createProcessorCallable()
        Creates a processor from the [ProcessorType][google.cloud.documentai.v1.ProcessorType] provided. 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();
 }

      • deleteProcessorAsync

        public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.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();
 }
        Parameters:
        name - Required. The processor resource name to be deleted.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • deleteProcessorAsync

        public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.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();
 }
        Parameters:
        name - Required. The processor resource name to be deleted.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • deleteProcessorAsync

        public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.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();
 }
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • deleteProcessorOperationCallable

        public final com.google.api.gax.rpc.OperationCallable<DeleteProcessorRequest,​com.google.protobuf.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();
 }

      • deleteProcessorCallable

        public final com.google.api.gax.rpc.UnaryCallable<DeleteProcessorRequest,​com.google.longrunning.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();
 }

      • enableProcessorAsync

        public final com.google.api.gax.longrunning.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();
 }
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • enableProcessorOperationCallable

        public final com.google.api.gax.rpc.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();
 }

      • enableProcessorCallable

        public final com.google.api.gax.rpc.UnaryCallable<EnableProcessorRequest,​com.google.longrunning.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();
 }

      • disableProcessorAsync

        public final com.google.api.gax.longrunning.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();
 }
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • disableProcessorOperationCallable

        public final com.google.api.gax.rpc.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();
 }

      • disableProcessorCallable

        public final com.google.api.gax.rpc.UnaryCallable<DisableProcessorRequest,​com.google.longrunning.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();
 }

      • setDefaultProcessorVersionAsync

        public final com.google.api.gax.longrunning.OperationFuture<SetDefaultProcessorVersionResponse,​SetDefaultProcessorVersionMetadata> setDefaultProcessorVersionAsync​(SetDefaultProcessorVersionRequest request)
        Set the default (active) version of a [Processor][google.cloud.documentai.v1.Processor] that will be used in [ProcessDocument][google.cloud.documentai.v1.DocumentProcessorService.ProcessDocument] and [BatchProcessDocuments][google.cloud.documentai.v1.DocumentProcessorService.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();
 }
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • setDefaultProcessorVersionOperationCallable

        public final com.google.api.gax.rpc.OperationCallable<SetDefaultProcessorVersionRequest,​SetDefaultProcessorVersionResponse,​SetDefaultProcessorVersionMetadata> setDefaultProcessorVersionOperationCallable()
        Set the default (active) version of a [Processor][google.cloud.documentai.v1.Processor] that will be used in [ProcessDocument][google.cloud.documentai.v1.DocumentProcessorService.ProcessDocument] and [BatchProcessDocuments][google.cloud.documentai.v1.DocumentProcessorService.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();
 }

      • setDefaultProcessorVersionCallable

        public final com.google.api.gax.rpc.UnaryCallable<SetDefaultProcessorVersionRequest,​com.google.longrunning.Operation> setDefaultProcessorVersionCallable()
        Set the default (active) version of a [Processor][google.cloud.documentai.v1.Processor] that will be used in [ProcessDocument][google.cloud.documentai.v1.DocumentProcessorService.ProcessDocument] and [BatchProcessDocuments][google.cloud.documentai.v1.DocumentProcessorService.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();
 }

      • reviewDocumentAsync

        public final com.google.api.gax.longrunning.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();
 }
        Parameters:
        humanReviewConfig - Required. The resource name of the [HumanReviewConfig][google.cloud.documentai.v1.HumanReviewConfig] that the document will be reviewed with.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • reviewDocumentAsync

        public final com.google.api.gax.longrunning.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();
 }
        Parameters:
        humanReviewConfig - Required. The resource name of the [HumanReviewConfig][google.cloud.documentai.v1.HumanReviewConfig] that the document will be reviewed with.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • reviewDocumentAsync

        public final com.google.api.gax.longrunning.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();
 }
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • reviewDocumentOperationCallable

        public final com.google.api.gax.rpc.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();
 }

      • reviewDocumentCallable

        public final com.google.api.gax.rpc.UnaryCallable<ReviewDocumentRequest,​com.google.longrunning.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();
 }

      • evaluateProcessorVersionAsync

        public final com.google.api.gax.longrunning.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();
 }
        Parameters:
        processorVersion - Required. The resource name of the [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] to evaluate. `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • evaluateProcessorVersionAsync

        public final com.google.api.gax.longrunning.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();
 }
        Parameters:
        processorVersion - Required. The resource name of the [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] to evaluate. `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • evaluateProcessorVersionAsync

        public final com.google.api.gax.longrunning.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();
 }
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • evaluateProcessorVersionOperationCallable

        public final com.google.api.gax.rpc.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();
 }

      • evaluateProcessorVersionCallable

        public final com.google.api.gax.rpc.UnaryCallable<EvaluateProcessorVersionRequest,​com.google.longrunning.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();
 }

      • getEvaluation

        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);
 }
        Parameters:
        name - Required. The resource name of the [Evaluation][google.cloud.documentai.v1.Evaluation] to get. `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}/evaluations/{evaluation}`
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • getEvaluation

        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);
 }
        Parameters:
        name - Required. The resource name of the [Evaluation][google.cloud.documentai.v1.Evaluation] to get. `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}/evaluations/{evaluation}`
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • getEvaluation

        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);
 }
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • getEvaluationCallable

        public final com.google.api.gax.rpc.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();
 }

      • listEvaluations

        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);
   }
 }
        Parameters:
        parent - Required. The resource name of the [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] to list evaluations for. `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • listEvaluations

        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);
   }
 }
        Parameters:
        parent - Required. The resource name of the [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] to list evaluations for. `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • listEvaluations

        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);
   }
 }
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • listEvaluationsPagedCallable

        public final com.google.api.gax.rpc.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);
   }
 }

      • listEvaluationsCallable

        public final com.google.api.gax.rpc.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;
     }
   }
 }

      • listLocations

        public final DocumentProcessorServiceClient.ListLocationsPagedResponse listLocations​(com.google.cloud.location.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);
   }
 }
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • listLocationsPagedCallable

        public final com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.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);
   }
 }

      • listLocationsCallable

        public final com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,​com.google.cloud.location.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;
     }
   }
 }

      • getLocation

        public final com.google.cloud.location.Location getLocation​(com.google.cloud.location.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);
 }
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • getLocationCallable

        public final com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.GetLocationRequest,​com.google.cloud.location.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();
 }

      • shutdown

        public void shutdown()
        Specified by:
        shutdown in interface com.google.api.gax.core.BackgroundResource

      • isShutdown

        public boolean isShutdown()
        Specified by:
        isShutdown in interface com.google.api.gax.core.BackgroundResource

      • isTerminated

        public boolean isTerminated()
        Specified by:
        isTerminated in interface com.google.api.gax.core.BackgroundResource

      • shutdownNow

        public void shutdownNow()
        Specified by:
        shutdownNow in interface com.google.api.gax.core.BackgroundResource