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: + * + *
{@code
+ * try (DocumentProcessorServiceClient documentProcessorServiceClient =
+ * DocumentProcessorServiceClient.create()) {
+ * ProcessorName 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: + * + *
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: + * + *
{@code
+ * DocumentProcessorServiceSettings documentProcessorServiceSettings =
+ * DocumentProcessorServiceSettings.newBuilder()
+ * .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
+ * .build();
+ * DocumentProcessorServiceClient documentProcessorServiceClient =
+ * DocumentProcessorServiceClient.create(documentProcessorServiceSettings);
+ * }
+ *
+ * To customize the endpoint: + * + *
{@code
+ * DocumentProcessorServiceSettings documentProcessorServiceSettings =
+ * DocumentProcessorServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
+ * DocumentProcessorServiceClient documentProcessorServiceClient =
+ * DocumentProcessorServiceClient.create(documentProcessorServiceSettings);
+ * }
+ *
+ * Please refer to the GitHub repository's samples for more quickstart code snippets. + */ +@Generated("by gapic-generator-java") +public class DocumentProcessorServiceClient implements BackgroundResource { + private final DocumentProcessorServiceSettings settings; + private final DocumentProcessorServiceStub stub; + private final OperationsClient operationsClient; + + /** Constructs an instance of DocumentProcessorServiceClient with default settings. */ + public static final DocumentProcessorServiceClient create() throws IOException { + return create(DocumentProcessorServiceSettings.newBuilder().build()); + } + + /** + * Constructs an instance of DocumentProcessorServiceClient, using the given settings. The + * channels are created based on the settings passed in, or defaults for any settings that are not + * set. + */ + public static final DocumentProcessorServiceClient create( + DocumentProcessorServiceSettings settings) throws IOException { + return new DocumentProcessorServiceClient(settings); + } + + /** + * Constructs an instance of DocumentProcessorServiceClient, using the given stub for making + * calls. This is for advanced usage - prefer using create(DocumentProcessorServiceSettings). + */ + @BetaApi("A restructuring of stub classes is planned, so this may break in the future") + public static final DocumentProcessorServiceClient create(DocumentProcessorServiceStub stub) { + return new DocumentProcessorServiceClient(stub); + } + + /** + * 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. + */ + protected DocumentProcessorServiceClient(DocumentProcessorServiceSettings settings) + throws IOException { + this.settings = settings; + this.stub = ((DocumentProcessorServiceStubSettings) settings.getStubSettings()).createStub(); + this.operationsClient = OperationsClient.create(this.stub.getOperationsStub()); + } + + @BetaApi("A restructuring of stub classes is planned, so this may break in the future") + protected DocumentProcessorServiceClient(DocumentProcessorServiceStub stub) { + this.settings = null; + this.stub = stub; + this.operationsClient = OperationsClient.create(this.stub.getOperationsStub()); + } + + public final DocumentProcessorServiceSettings getSettings() { + return settings; + } + + @BetaApi("A restructuring of stub classes is planned, so this may break in the future") + public DocumentProcessorServiceStub getStub() { + return stub; + } + + /** + * Returns the OperationsClient that can be used to query the status of a long-running operation + * returned by another API method call. + */ + public final OperationsClient getOperationsClient() { + return operationsClient; + } + + // AUTO-GENERATED DOCUMENTATION AND METHOD. + /** + * Processes a single document. + * + *
Sample code: + * + *
{@code
+ * try (DocumentProcessorServiceClient documentProcessorServiceClient =
+ * DocumentProcessorServiceClient.create()) {
+ * ProcessorName name = ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]");
+ * ProcessResponse response = documentProcessorServiceClient.processDocument(name);
+ * }
+ * }
+ *
+ * @param name Required. The processor resource name.
+ * @throws com.google.api.gax.rpc.ApiException if the remote call fails
+ */
+ public final ProcessResponse processDocument(ProcessorName name) {
+ ProcessRequest request =
+ ProcessRequest.newBuilder().setName(name == null ? null : name.toString()).build();
+ return processDocument(request);
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * Processes a single document.
+ *
+ * Sample code: + * + *
{@code
+ * try (DocumentProcessorServiceClient documentProcessorServiceClient =
+ * DocumentProcessorServiceClient.create()) {
+ * String name = ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString();
+ * ProcessResponse response = documentProcessorServiceClient.processDocument(name);
+ * }
+ * }
+ *
+ * @param name Required. The processor resource name.
+ * @throws com.google.api.gax.rpc.ApiException if the remote call fails
+ */
+ public final ProcessResponse processDocument(String name) {
+ ProcessRequest request = ProcessRequest.newBuilder().setName(name).build();
+ return processDocument(request);
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * Processes a single document.
+ *
+ * Sample code: + * + *
{@code
+ * try (DocumentProcessorServiceClient documentProcessorServiceClient =
+ * DocumentProcessorServiceClient.create()) {
+ * ProcessRequest request =
+ * ProcessRequest.newBuilder()
+ * .setName(ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString())
+ * .setSkipHumanReview(true)
+ * .build();
+ * ProcessResponse response = documentProcessorServiceClient.processDocument(request);
+ * }
+ * }
+ *
+ * @param 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
+ */
+ public final ProcessResponse processDocument(ProcessRequest request) {
+ return processDocumentCallable().call(request);
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * Processes a single document.
+ *
+ * Sample code: + * + *
{@code
+ * try (DocumentProcessorServiceClient documentProcessorServiceClient =
+ * DocumentProcessorServiceClient.create()) {
+ * ProcessRequest request =
+ * ProcessRequest.newBuilder()
+ * .setName(ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString())
+ * .setSkipHumanReview(true)
+ * .build();
+ * ApiFuture future =
+ * documentProcessorServiceClient.processDocumentCallable().futureCall(request);
+ * // Do something.
+ * ProcessResponse response = future.get();
+ * }
+ * }
+ */
+ public final UnaryCallableSample code: + * + *
{@code
+ * try (DocumentProcessorServiceClient documentProcessorServiceClient =
+ * DocumentProcessorServiceClient.create()) {
+ * ProcessorName name = ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]");
+ * BatchProcessResponse response =
+ * documentProcessorServiceClient.batchProcessDocumentsAsync(name).get();
+ * }
+ * }
+ *
+ * @param name Required. The processor resource name.
+ * @throws com.google.api.gax.rpc.ApiException if the remote call fails
+ */
+ public final OperationFutureSample code: + * + *
{@code
+ * try (DocumentProcessorServiceClient documentProcessorServiceClient =
+ * DocumentProcessorServiceClient.create()) {
+ * String name = ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString();
+ * BatchProcessResponse response =
+ * documentProcessorServiceClient.batchProcessDocumentsAsync(name).get();
+ * }
+ * }
+ *
+ * @param name Required. The processor resource name.
+ * @throws com.google.api.gax.rpc.ApiException if the remote call fails
+ */
+ public final OperationFutureSample code: + * + *
{@code
+ * try (DocumentProcessorServiceClient documentProcessorServiceClient =
+ * DocumentProcessorServiceClient.create()) {
+ * BatchProcessRequest request =
+ * BatchProcessRequest.newBuilder()
+ * .setName(ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString())
+ * .setInputDocuments(BatchDocumentsInputConfig.newBuilder().build())
+ * .setDocumentOutputConfig(DocumentOutputConfig.newBuilder().build())
+ * .setSkipHumanReview(true)
+ * .build();
+ * BatchProcessResponse response =
+ * documentProcessorServiceClient.batchProcessDocumentsAsync(request).get();
+ * }
+ * }
+ *
+ * @param 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
+ */
+ public final OperationFutureSample code: + * + *
{@code
+ * try (DocumentProcessorServiceClient documentProcessorServiceClient =
+ * DocumentProcessorServiceClient.create()) {
+ * BatchProcessRequest request =
+ * BatchProcessRequest.newBuilder()
+ * .setName(ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString())
+ * .setInputDocuments(BatchDocumentsInputConfig.newBuilder().build())
+ * .setDocumentOutputConfig(DocumentOutputConfig.newBuilder().build())
+ * .setSkipHumanReview(true)
+ * .build();
+ * OperationFuture future =
+ * documentProcessorServiceClient
+ * .batchProcessDocumentsOperationCallable()
+ * .futureCall(request);
+ * // Do something.
+ * BatchProcessResponse response = future.get();
+ * }
+ * }
+ */
+ public final OperationCallableSample code: + * + *
{@code
+ * try (DocumentProcessorServiceClient documentProcessorServiceClient =
+ * DocumentProcessorServiceClient.create()) {
+ * BatchProcessRequest request =
+ * BatchProcessRequest.newBuilder()
+ * .setName(ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString())
+ * .setInputDocuments(BatchDocumentsInputConfig.newBuilder().build())
+ * .setDocumentOutputConfig(DocumentOutputConfig.newBuilder().build())
+ * .setSkipHumanReview(true)
+ * .build();
+ * ApiFuture future =
+ * documentProcessorServiceClient.batchProcessDocumentsCallable().futureCall(request);
+ * // Do something.
+ * Operation response = future.get();
+ * }
+ * }
+ */
+ public final UnaryCallableSample code: + * + *
{@code
+ * try (DocumentProcessorServiceClient documentProcessorServiceClient =
+ * DocumentProcessorServiceClient.create()) {
+ * HumanReviewConfigName humanReviewConfig =
+ * HumanReviewConfigName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]");
+ * ReviewDocumentResponse response =
+ * documentProcessorServiceClient.reviewDocumentAsync(humanReviewConfig).get();
+ * }
+ * }
+ *
+ * @param humanReviewConfig Required. The resource name of the HumanReviewConfig that the document
+ * will be reviewed with.
+ * @throws com.google.api.gax.rpc.ApiException if the remote call fails
+ */
+ public final OperationFutureSample code: + * + *
{@code
+ * try (DocumentProcessorServiceClient documentProcessorServiceClient =
+ * DocumentProcessorServiceClient.create()) {
+ * String humanReviewConfig =
+ * HumanReviewConfigName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString();
+ * ReviewDocumentResponse response =
+ * documentProcessorServiceClient.reviewDocumentAsync(humanReviewConfig).get();
+ * }
+ * }
+ *
+ * @param humanReviewConfig Required. The resource name of the HumanReviewConfig that the document
+ * will be reviewed with.
+ * @throws com.google.api.gax.rpc.ApiException if the remote call fails
+ */
+ public final OperationFutureSample code: + * + *
{@code
+ * try (DocumentProcessorServiceClient documentProcessorServiceClient =
+ * DocumentProcessorServiceClient.create()) {
+ * ReviewDocumentRequest request =
+ * ReviewDocumentRequest.newBuilder()
+ * .setHumanReviewConfig(
+ * HumanReviewConfigName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString())
+ * .build();
+ * ReviewDocumentResponse response =
+ * documentProcessorServiceClient.reviewDocumentAsync(request).get();
+ * }
+ * }
+ *
+ * @param 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
+ */
+ public final OperationFutureSample code: + * + *
{@code
+ * try (DocumentProcessorServiceClient documentProcessorServiceClient =
+ * DocumentProcessorServiceClient.create()) {
+ * ReviewDocumentRequest request =
+ * ReviewDocumentRequest.newBuilder()
+ * .setHumanReviewConfig(
+ * HumanReviewConfigName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString())
+ * .build();
+ * OperationFuture future =
+ * documentProcessorServiceClient.reviewDocumentOperationCallable().futureCall(request);
+ * // Do something.
+ * ReviewDocumentResponse response = future.get();
+ * }
+ * }
+ */
+ public final OperationCallable<
+ ReviewDocumentRequest, ReviewDocumentResponse, ReviewDocumentOperationMetadata>
+ reviewDocumentOperationCallable() {
+ return stub.reviewDocumentOperationCallable();
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * Send a document for Human Review. The input document should be processed by the specified
+ * processor.
+ *
+ * Sample code: + * + *
{@code
+ * try (DocumentProcessorServiceClient documentProcessorServiceClient =
+ * DocumentProcessorServiceClient.create()) {
+ * ReviewDocumentRequest request =
+ * ReviewDocumentRequest.newBuilder()
+ * .setHumanReviewConfig(
+ * HumanReviewConfigName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString())
+ * .build();
+ * ApiFuture future =
+ * documentProcessorServiceClient.reviewDocumentCallable().futureCall(request);
+ * // Do something.
+ * Operation response = future.get();
+ * }
+ * }
+ */
+ public final UnaryCallableThe default instance has everything set to sensible defaults: + * + *
The builder of this class is recursive, so contained classes are themselves builders. When + * build() is called, the tree of builders is called to create the complete settings object. + * + *
For example, to set the total timeout of processDocument to 30 seconds: + * + *
{@code
+ * DocumentProcessorServiceSettings.Builder documentProcessorServiceSettingsBuilder =
+ * DocumentProcessorServiceSettings.newBuilder();
+ * documentProcessorServiceSettingsBuilder
+ * .processDocumentSettings()
+ * .setRetrySettings(
+ * documentProcessorServiceSettingsBuilder
+ * .processDocumentSettings()
+ * .getRetrySettings()
+ * .toBuilder()
+ * .setTotalTimeout(Duration.ofSeconds(30))
+ * .build());
+ * DocumentProcessorServiceSettings documentProcessorServiceSettings =
+ * documentProcessorServiceSettingsBuilder.build();
+ * }
+ */
+@Generated("by gapic-generator-java")
+public class DocumentProcessorServiceSettings
+ extends ClientSettingsNote: This method does not support applying settings to streaming methods.
+ */
+ public Builder applyToAllUnaryMethods(
+ ApiFunction ======================= DocumentProcessorServiceClient =======================
+ *
+ * Service Description: Service to call Cloud DocumentAI to process documents according to the
+ * processor's definition. Processors are built using state-of-the-art Google AI such as natural
+ * language, computer vision, and translation to extract structured information from unstructured or
+ * semi-structured documents.
+ *
+ * Sample for DocumentProcessorServiceClient:
+ *
+ * This class is for advanced usage and reflects the underlying API directly.
+ */
+@Generated("by gapic-generator-java")
+public abstract class DocumentProcessorServiceStub implements BackgroundResource {
+
+ public OperationsStub getOperationsStub() {
+ throw new UnsupportedOperationException("Not implemented: getOperationsStub()");
+ }
+
+ public UnaryCallable The default instance has everything set to sensible defaults:
+ *
+ * The builder of this class is recursive, so contained classes are themselves builders. When
+ * build() is called, the tree of builders is called to create the complete settings object.
+ *
+ * For example, to set the total timeout of processDocument to 30 seconds:
+ *
+ * Note: This method does not support applying settings to streaming methods.
+ */
+ public Builder applyToAllUnaryMethods(
+ ApiFunction This class is for advanced usage.
+ */
+@Generated("by gapic-generator-java")
+public class GrpcDocumentProcessorServiceCallableFactory implements GrpcStubCallableFactory {
+
+ @Override
+ public This class is for advanced usage and reflects the underlying API directly.
+ */
+@Generated("by gapic-generator-java")
+public class GrpcDocumentProcessorServiceStub extends DocumentProcessorServiceStub {
+ private static final MethodDescriptor{@code
+ * try (DocumentProcessorServiceClient documentProcessorServiceClient =
+ * DocumentProcessorServiceClient.create()) {
+ * ProcessorName name = ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]");
+ * ProcessResponse response = documentProcessorServiceClient.processDocument(name);
+ * }
+ * }
+ */
+@Generated("by gapic-generator-java")
+package com.google.cloud.documentai.v1;
+
+import javax.annotation.Generated;
diff --git a/google-cloud-document-ai/src/main/java/com/google/cloud/documentai/v1/stub/DocumentProcessorServiceStub.java b/google-cloud-document-ai/src/main/java/com/google/cloud/documentai/v1/stub/DocumentProcessorServiceStub.java
new file mode 100644
index 00000000..f60654b8
--- /dev/null
+++ b/google-cloud-document-ai/src/main/java/com/google/cloud/documentai/v1/stub/DocumentProcessorServiceStub.java
@@ -0,0 +1,73 @@
+/*
+ * Copyright 2021 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.google.cloud.documentai.v1.stub;
+
+import com.google.api.gax.core.BackgroundResource;
+import com.google.api.gax.rpc.OperationCallable;
+import com.google.api.gax.rpc.UnaryCallable;
+import com.google.cloud.documentai.v1.BatchProcessMetadata;
+import com.google.cloud.documentai.v1.BatchProcessRequest;
+import com.google.cloud.documentai.v1.BatchProcessResponse;
+import com.google.cloud.documentai.v1.ProcessRequest;
+import com.google.cloud.documentai.v1.ProcessResponse;
+import com.google.cloud.documentai.v1.ReviewDocumentOperationMetadata;
+import com.google.cloud.documentai.v1.ReviewDocumentRequest;
+import com.google.cloud.documentai.v1.ReviewDocumentResponse;
+import com.google.longrunning.Operation;
+import com.google.longrunning.stub.OperationsStub;
+import javax.annotation.Generated;
+
+// AUTO-GENERATED DOCUMENTATION AND CLASS.
+/**
+ * Base stub class for the DocumentProcessorService service API.
+ *
+ *
+ *
+ *
+ * {@code
+ * DocumentProcessorServiceStubSettings.Builder documentProcessorServiceSettingsBuilder =
+ * DocumentProcessorServiceStubSettings.newBuilder();
+ * documentProcessorServiceSettingsBuilder
+ * .processDocumentSettings()
+ * .setRetrySettings(
+ * documentProcessorServiceSettingsBuilder
+ * .processDocumentSettings()
+ * .getRetrySettings()
+ * .toBuilder()
+ * .setTotalTimeout(Duration.ofSeconds(30))
+ * .build());
+ * DocumentProcessorServiceStubSettings documentProcessorServiceSettings =
+ * documentProcessorServiceSettingsBuilder.build();
+ * }
+ */
+@Generated("by gapic-generator-java")
+public class DocumentProcessorServiceStubSettings
+ extends StubSettings