public class DocumentProcessorServiceClient implements BackgroundResourceService Description: Service to call Cloud DocumentAI to process documents according to the processor's definition. Processors are built using state-of-the-art Google AI such as natural language, computer vision, and translation to extract structured information from unstructured or semi-structured documents.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create()) {
ResourceName name = ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]");
ProcessResponse response = documentProcessorServiceClient.processDocument(name);
}
Note: close() needs to be called on the DocumentProcessorServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
- 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.
- 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.
- 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.newBuilder()
.setTransportChannelProvider(
DocumentProcessorServiceSettings.defaultHttpJsonTransportProviderBuilder().build())
.build();
DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create(documentProcessorServiceSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Implements
BackgroundResourceStatic Methods
create()
public static final DocumentProcessorServiceClient create()Constructs an instance of DocumentProcessorServiceClient with default settings.
| Type | Description |
| DocumentProcessorServiceClient |
| Type | Description |
| IOException |
create(DocumentProcessorServiceSettings settings)
public static final DocumentProcessorServiceClient create(DocumentProcessorServiceSettings settings)Constructs an instance of DocumentProcessorServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.
| Name | Description |
| settings | DocumentProcessorServiceSettings |
| Type | Description |
| DocumentProcessorServiceClient |
| Type | Description |
| IOException |
create(DocumentProcessorServiceStub stub)
public static final DocumentProcessorServiceClient create(DocumentProcessorServiceStub stub)Constructs an instance of DocumentProcessorServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(DocumentProcessorServiceSettings).
| Name | Description |
| stub | DocumentProcessorServiceStub |
| Type | Description |
| DocumentProcessorServiceClient |
Constructors
DocumentProcessorServiceClient(DocumentProcessorServiceSettings settings)
protected DocumentProcessorServiceClient(DocumentProcessorServiceSettings settings)Constructs an instance of DocumentProcessorServiceClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.
| Name | Description |
| settings | DocumentProcessorServiceSettings |
DocumentProcessorServiceClient(DocumentProcessorServiceStub stub)
protected DocumentProcessorServiceClient(DocumentProcessorServiceStub stub)| Name | Description |
| stub | DocumentProcessorServiceStub |
Methods
awaitTermination(long duration, TimeUnit unit)
public boolean awaitTermination(long duration, TimeUnit unit)| Name | Description |
| duration | long |
| unit | TimeUnit |
| Type | Description |
| boolean |
| Type | Description |
| InterruptedException |
batchProcessDocumentsAsync(ResourceName name)
public final OperationFuture<BatchProcessResponse,BatchProcessMetadata> batchProcessDocumentsAsync(ResourceName name)LRO endpoint to batch process many documents. The output is written to Cloud Storage as JSON in the [Document] format.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create()) {
ResourceName name = ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]");
BatchProcessResponse response =
documentProcessorServiceClient.batchProcessDocumentsAsync(name).get();
}
| Name | Description |
| name | com.google.api.resourcenames.ResourceNameRequired. The resource name of
Processor or
ProcessorVersion. Format:
|
| Type | Description |
| OperationFuture<BatchProcessResponse,BatchProcessMetadata> |
batchProcessDocumentsAsync(BatchProcessRequest request)
public final OperationFuture<BatchProcessResponse,BatchProcessMetadata> batchProcessDocumentsAsync(BatchProcessRequest request)LRO endpoint to batch process many documents. The output is written to Cloud Storage as JSON in the [Document] format.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create()) {
BatchProcessRequest request =
BatchProcessRequest.newBuilder()
.setName(ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString())
.addAllInputConfigs(new ArrayList<BatchProcessRequest.BatchInputConfig>())
.setOutputConfig(BatchProcessRequest.BatchOutputConfig.newBuilder().build())
.setInputDocuments(BatchDocumentsInputConfig.newBuilder().build())
.setDocumentOutputConfig(DocumentOutputConfig.newBuilder().build())
.setSkipHumanReview(true)
.build();
BatchProcessResponse response =
documentProcessorServiceClient.batchProcessDocumentsAsync(request).get();
}
| Name | Description |
| request | BatchProcessRequestThe request object containing all of the parameters for the API call. |
| Type | Description |
| OperationFuture<BatchProcessResponse,BatchProcessMetadata> |
batchProcessDocumentsAsync(String name)
public final OperationFuture<BatchProcessResponse,BatchProcessMetadata> batchProcessDocumentsAsync(String name)LRO endpoint to batch process many documents. The output is written to Cloud Storage as JSON in the [Document] format.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create()) {
String name = HumanReviewConfigName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString();
BatchProcessResponse response =
documentProcessorServiceClient.batchProcessDocumentsAsync(name).get();
}
| Name | Description |
| name | StringRequired. The resource name of
Processor or
ProcessorVersion. Format:
|
| Type | Description |
| OperationFuture<BatchProcessResponse,BatchProcessMetadata> |
batchProcessDocumentsCallable()
public final UnaryCallable<BatchProcessRequest,Operation> batchProcessDocumentsCallable()LRO endpoint to batch process many documents. The output is written to Cloud Storage as JSON in the [Document] format.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create()) {
BatchProcessRequest request =
BatchProcessRequest.newBuilder()
.setName(ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString())
.addAllInputConfigs(new ArrayList<BatchProcessRequest.BatchInputConfig>())
.setOutputConfig(BatchProcessRequest.BatchOutputConfig.newBuilder().build())
.setInputDocuments(BatchDocumentsInputConfig.newBuilder().build())
.setDocumentOutputConfig(DocumentOutputConfig.newBuilder().build())
.setSkipHumanReview(true)
.build();
ApiFuture<Operation> future =
documentProcessorServiceClient.batchProcessDocumentsCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
| Type | Description |
| UnaryCallable<BatchProcessRequest,Operation> |
batchProcessDocumentsOperationCallable()
public final OperationCallable<BatchProcessRequest,BatchProcessResponse,BatchProcessMetadata> batchProcessDocumentsOperationCallable()LRO endpoint to batch process many documents. The output is written to Cloud Storage as JSON in the [Document] format.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create()) {
BatchProcessRequest request =
BatchProcessRequest.newBuilder()
.setName(ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString())
.addAllInputConfigs(new ArrayList<BatchProcessRequest.BatchInputConfig>())
.setOutputConfig(BatchProcessRequest.BatchOutputConfig.newBuilder().build())
.setInputDocuments(BatchDocumentsInputConfig.newBuilder().build())
.setDocumentOutputConfig(DocumentOutputConfig.newBuilder().build())
.setSkipHumanReview(true)
.build();
OperationFuture<BatchProcessResponse, BatchProcessMetadata> future =
documentProcessorServiceClient
.batchProcessDocumentsOperationCallable()
.futureCall(request);
// Do something.
BatchProcessResponse response = future.get();
}
| Type | Description |
| OperationCallable<BatchProcessRequest,BatchProcessResponse,BatchProcessMetadata> |
close()
public final void close()createProcessor(CreateProcessorRequest request)
public final Processor createProcessor(CreateProcessorRequest request)Creates a processor from the type processor that the user chose. The processor will be at "ENABLED" state by default after its creation.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create()) {
CreateProcessorRequest request =
CreateProcessorRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setProcessor(Processor.newBuilder().build())
.build();
Processor response = documentProcessorServiceClient.createProcessor(request);
}
| Name | Description |
| request | CreateProcessorRequestThe request object containing all of the parameters for the API call. |
| Type | Description |
| Processor |
createProcessor(LocationName parent, Processor processor)
public final Processor createProcessor(LocationName parent, Processor processor)Creates a processor from the type processor that the user chose. The processor will be at "ENABLED" state by default after its creation.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
Processor processor = Processor.newBuilder().build();
Processor response = documentProcessorServiceClient.createProcessor(parent, processor);
}
| Name | Description |
| parent | LocationNameRequired. The parent (project and location) under which to create the processor.
Format: |
| processor | ProcessorRequired. The processor to be created, requires [processor_type] and [display_name] to be set. Also, the processor is under CMEK if CMEK fields are set. |
| Type | Description |
| Processor |
createProcessor(String parent, Processor processor)
public final Processor createProcessor(String parent, Processor processor)Creates a processor from the type processor that the user chose. The processor will be at "ENABLED" state by default after its creation.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
Processor processor = Processor.newBuilder().build();
Processor response = documentProcessorServiceClient.createProcessor(parent, processor);
}
| Name | Description |
| parent | StringRequired. The parent (project and location) under which to create the processor.
Format: |
| processor | ProcessorRequired. The processor to be created, requires [processor_type] and [display_name] to be set. Also, the processor is under CMEK if CMEK fields are set. |
| Type | Description |
| Processor |
createProcessorCallable()
public final UnaryCallable<CreateProcessorRequest,Processor> createProcessorCallable()Creates a processor from the type processor that the user chose. The processor will be at "ENABLED" state by default after its creation.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create()) {
CreateProcessorRequest request =
CreateProcessorRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setProcessor(Processor.newBuilder().build())
.build();
ApiFuture<Processor> future =
documentProcessorServiceClient.createProcessorCallable().futureCall(request);
// Do something.
Processor response = future.get();
}
| Type | Description |
| UnaryCallable<CreateProcessorRequest,Processor> |
deleteProcessorAsync(DeleteProcessorRequest request)
public final OperationFuture<Empty,DeleteProcessorMetadata> deleteProcessorAsync(DeleteProcessorRequest request)Deletes the processor, unloads all deployed model artifacts if it was enabled and then deletes all artifacts associated with this processor.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create()) {
DeleteProcessorRequest request =
DeleteProcessorRequest.newBuilder()
.setName(ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString())
.build();
documentProcessorServiceClient.deleteProcessorAsync(request).get();
}
| Name | Description |
| request | DeleteProcessorRequestThe request object containing all of the parameters for the API call. |
| Type | Description |
| OperationFuture<Empty,DeleteProcessorMetadata> |
deleteProcessorAsync(ProcessorName name)
public final OperationFuture<Empty,DeleteProcessorMetadata> deleteProcessorAsync(ProcessorName name)Deletes the processor, unloads all deployed model artifacts if it was enabled and then deletes all artifacts associated with this processor.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create()) {
ProcessorName name = ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]");
documentProcessorServiceClient.deleteProcessorAsync(name).get();
}
| Name | Description |
| name | ProcessorNameRequired. The processor resource name to be deleted. |
| Type | Description |
| OperationFuture<Empty,DeleteProcessorMetadata> |
deleteProcessorAsync(String name)
public final OperationFuture<Empty,DeleteProcessorMetadata> deleteProcessorAsync(String name)Deletes the processor, unloads all deployed model artifacts if it was enabled and then deletes all artifacts associated with this processor.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create()) {
String name = ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString();
documentProcessorServiceClient.deleteProcessorAsync(name).get();
}
| Name | Description |
| name | StringRequired. The processor resource name to be deleted. |
| Type | Description |
| OperationFuture<Empty,DeleteProcessorMetadata> |
deleteProcessorCallable()
public final UnaryCallable<DeleteProcessorRequest,Operation> deleteProcessorCallable()Deletes the processor, unloads all deployed model artifacts if it was enabled and then deletes all artifacts associated with this processor.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create()) {
DeleteProcessorRequest request =
DeleteProcessorRequest.newBuilder()
.setName(ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString())
.build();
ApiFuture<Operation> future =
documentProcessorServiceClient.deleteProcessorCallable().futureCall(request);
// Do something.
future.get();
}
| Type | Description |
| UnaryCallable<DeleteProcessorRequest,Operation> |
deleteProcessorOperationCallable()
public final OperationCallable<DeleteProcessorRequest,Empty,DeleteProcessorMetadata> deleteProcessorOperationCallable()Deletes the processor, unloads all deployed model artifacts if it was enabled and then deletes all artifacts associated with this processor.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create()) {
DeleteProcessorRequest request =
DeleteProcessorRequest.newBuilder()
.setName(ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString())
.build();
OperationFuture<Empty, DeleteProcessorMetadata> future =
documentProcessorServiceClient.deleteProcessorOperationCallable().futureCall(request);
// Do something.
future.get();
}
| Type | Description |
| OperationCallable<DeleteProcessorRequest,Empty,DeleteProcessorMetadata> |
deleteProcessorVersionAsync(DeleteProcessorVersionRequest request)
public final OperationFuture<Empty,DeleteProcessorVersionMetadata> deleteProcessorVersionAsync(DeleteProcessorVersionRequest request)Deletes the processor version, all artifacts under the processor version will be deleted.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create()) {
DeleteProcessorVersionRequest request =
DeleteProcessorVersionRequest.newBuilder()
.setName(
ProcessorVersionName.of(
"[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]")
.toString())
.build();
documentProcessorServiceClient.deleteProcessorVersionAsync(request).get();
}
| Name | Description |
| request | DeleteProcessorVersionRequestThe request object containing all of the parameters for the API call. |
| Type | Description |
| OperationFuture<Empty,DeleteProcessorVersionMetadata> |
deleteProcessorVersionAsync(ProcessorVersionName name)
public final OperationFuture<Empty,DeleteProcessorVersionMetadata> deleteProcessorVersionAsync(ProcessorVersionName name)Deletes the processor version, all artifacts under the processor version will be deleted.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create()) {
ProcessorVersionName name =
ProcessorVersionName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]");
documentProcessorServiceClient.deleteProcessorVersionAsync(name).get();
}
| Name | Description |
| name | ProcessorVersionNameRequired. The processor version resource name to be deleted. |
| Type | Description |
| OperationFuture<Empty,DeleteProcessorVersionMetadata> |
deleteProcessorVersionAsync(String name)
public final OperationFuture<Empty,DeleteProcessorVersionMetadata> deleteProcessorVersionAsync(String name)Deletes the processor version, all artifacts under the processor version will be deleted.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create()) {
String name =
ProcessorVersionName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]")
.toString();
documentProcessorServiceClient.deleteProcessorVersionAsync(name).get();
}
| Name | Description |
| name | StringRequired. The processor version resource name to be deleted. |
| Type | Description |
| OperationFuture<Empty,DeleteProcessorVersionMetadata> |
deleteProcessorVersionCallable()
public final UnaryCallable<DeleteProcessorVersionRequest,Operation> deleteProcessorVersionCallable()Deletes the processor version, all artifacts under the processor version will be deleted.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create()) {
DeleteProcessorVersionRequest request =
DeleteProcessorVersionRequest.newBuilder()
.setName(
ProcessorVersionName.of(
"[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]")
.toString())
.build();
ApiFuture<Operation> future =
documentProcessorServiceClient.deleteProcessorVersionCallable().futureCall(request);
// Do something.
future.get();
}
| Type | Description |
| UnaryCallable<DeleteProcessorVersionRequest,Operation> |
deleteProcessorVersionOperationCallable()
public final OperationCallable<DeleteProcessorVersionRequest,Empty,DeleteProcessorVersionMetadata> deleteProcessorVersionOperationCallable()Deletes the processor version, all artifacts under the processor version will be deleted.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create()) {
DeleteProcessorVersionRequest request =
DeleteProcessorVersionRequest.newBuilder()
.setName(
ProcessorVersionName.of(
"[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]")
.toString())
.build();
OperationFuture<Empty, DeleteProcessorVersionMetadata> future =
documentProcessorServiceClient
.deleteProcessorVersionOperationCallable()
.futureCall(request);
// Do something.
future.get();
}
| Type | Description |
| OperationCallable<DeleteProcessorVersionRequest,Empty,DeleteProcessorVersionMetadata> |
deployProcessorVersionAsync(DeployProcessorVersionRequest request)
public final OperationFuture<DeployProcessorVersionResponse,DeployProcessorVersionMetadata> deployProcessorVersionAsync(DeployProcessorVersionRequest request)Deploys the processor version.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create()) {
DeployProcessorVersionRequest request =
DeployProcessorVersionRequest.newBuilder()
.setName(
ProcessorVersionName.of(
"[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]")
.toString())
.build();
DeployProcessorVersionResponse response =
documentProcessorServiceClient.deployProcessorVersionAsync(request).get();
}
| Name | Description |
| request | DeployProcessorVersionRequestThe request object containing all of the parameters for the API call. |
| Type | Description |
| OperationFuture<DeployProcessorVersionResponse,DeployProcessorVersionMetadata> |
deployProcessorVersionAsync(ProcessorVersionName name)
public final OperationFuture<DeployProcessorVersionResponse,DeployProcessorVersionMetadata> deployProcessorVersionAsync(ProcessorVersionName name)Deploys the processor version.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create()) {
ProcessorVersionName name =
ProcessorVersionName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]");
DeployProcessorVersionResponse response =
documentProcessorServiceClient.deployProcessorVersionAsync(name).get();
}
| Name | Description |
| name | ProcessorVersionNameRequired. The processor version resource name to be deployed. |
| Type | Description |
| OperationFuture<DeployProcessorVersionResponse,DeployProcessorVersionMetadata> |
deployProcessorVersionAsync(String name)
public final OperationFuture<DeployProcessorVersionResponse,DeployProcessorVersionMetadata> deployProcessorVersionAsync(String name)Deploys the processor version.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create()) {
String name =
ProcessorVersionName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]")
.toString();
DeployProcessorVersionResponse response =
documentProcessorServiceClient.deployProcessorVersionAsync(name).get();
}
| Name | Description |
| name | StringRequired. The processor version resource name to be deployed. |
| Type | Description |
| OperationFuture<DeployProcessorVersionResponse,DeployProcessorVersionMetadata> |
deployProcessorVersionCallable()
public final UnaryCallable<DeployProcessorVersionRequest,Operation> deployProcessorVersionCallable()Deploys the processor version.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create()) {
DeployProcessorVersionRequest request =
DeployProcessorVersionRequest.newBuilder()
.setName(
ProcessorVersionName.of(
"[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]")
.toString())
.build();
ApiFuture<Operation> future =
documentProcessorServiceClient.deployProcessorVersionCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
| Type | Description |
| UnaryCallable<DeployProcessorVersionRequest,Operation> |
deployProcessorVersionOperationCallable()
public final OperationCallable<DeployProcessorVersionRequest,DeployProcessorVersionResponse,DeployProcessorVersionMetadata> deployProcessorVersionOperationCallable()Deploys the processor version.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create()) {
DeployProcessorVersionRequest request =
DeployProcessorVersionRequest.newBuilder()
.setName(
ProcessorVersionName.of(
"[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]")
.toString())
.build();
OperationFuture<DeployProcessorVersionResponse, DeployProcessorVersionMetadata> future =
documentProcessorServiceClient
.deployProcessorVersionOperationCallable()
.futureCall(request);
// Do something.
DeployProcessorVersionResponse response = future.get();
}
| Type | Description |
| OperationCallable<DeployProcessorVersionRequest,DeployProcessorVersionResponse,DeployProcessorVersionMetadata> |
disableProcessorAsync(DisableProcessorRequest request)
public final OperationFuture<DisableProcessorResponse,DisableProcessorMetadata> disableProcessorAsync(DisableProcessorRequest request)Disables a processor
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create()) {
DisableProcessorRequest request =
DisableProcessorRequest.newBuilder()
.setName(ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString())
.build();
DisableProcessorResponse response =
documentProcessorServiceClient.disableProcessorAsync(request).get();
}
| Name | Description |
| request | DisableProcessorRequestThe request object containing all of the parameters for the API call. |
| Type | Description |
| OperationFuture<DisableProcessorResponse,DisableProcessorMetadata> |
disableProcessorCallable()
public final UnaryCallable<DisableProcessorRequest,Operation> disableProcessorCallable()Disables a processor
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create()) {
DisableProcessorRequest request =
DisableProcessorRequest.newBuilder()
.setName(ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString())
.build();
ApiFuture<Operation> future =
documentProcessorServiceClient.disableProcessorCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
| Type | Description |
| UnaryCallable<DisableProcessorRequest,Operation> |
disableProcessorOperationCallable()
public final OperationCallable<DisableProcessorRequest,DisableProcessorResponse,DisableProcessorMetadata> disableProcessorOperationCallable()Disables a processor
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create()) {
DisableProcessorRequest request =
DisableProcessorRequest.newBuilder()
.setName(ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString())
.build();
OperationFuture<DisableProcessorResponse, DisableProcessorMetadata> future =
documentProcessorServiceClient.disableProcessorOperationCallable().futureCall(request);
// Do something.
DisableProcessorResponse response = future.get();
}
| Type | Description |
| OperationCallable<DisableProcessorRequest,DisableProcessorResponse,DisableProcessorMetadata> |
enableProcessorAsync(EnableProcessorRequest request)
public final OperationFuture<EnableProcessorResponse,EnableProcessorMetadata> enableProcessorAsync(EnableProcessorRequest request)Enables a processor
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create()) {
EnableProcessorRequest request =
EnableProcessorRequest.newBuilder()
.setName(ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString())
.build();
EnableProcessorResponse response =
documentProcessorServiceClient.enableProcessorAsync(request).get();
}
| Name | Description |
| request | EnableProcessorRequestThe request object containing all of the parameters for the API call. |
| Type | Description |
| OperationFuture<EnableProcessorResponse,EnableProcessorMetadata> |
enableProcessorCallable()
public final UnaryCallable<EnableProcessorRequest,Operation> enableProcessorCallable()Enables a processor
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create()) {
EnableProcessorRequest request =
EnableProcessorRequest.newBuilder()
.setName(ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString())
.build();
ApiFuture<Operation> future =
documentProcessorServiceClient.enableProcessorCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
| Type | Description |
| UnaryCallable<EnableProcessorRequest,Operation> |
enableProcessorOperationCallable()
public final OperationCallable<EnableProcessorRequest,EnableProcessorResponse,EnableProcessorMetadata> enableProcessorOperationCallable()Enables a processor
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create()) {
EnableProcessorRequest request =
EnableProcessorRequest.newBuilder()
.setName(ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString())
.build();
OperationFuture<EnableProcessorResponse, EnableProcessorMetadata> future =
documentProcessorServiceClient.enableProcessorOperationCallable().futureCall(request);
// Do something.
EnableProcessorResponse response = future.get();
}
| Type | Description |
| OperationCallable<EnableProcessorRequest,EnableProcessorResponse,EnableProcessorMetadata> |
fetchProcessorTypes(FetchProcessorTypesRequest request)
public final FetchProcessorTypesResponse fetchProcessorTypes(FetchProcessorTypesRequest request)Fetches processor types. Note that we do not use ListProcessorTypes here because it is not paginated.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create()) {
FetchProcessorTypesRequest request =
FetchProcessorTypesRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.build();
FetchProcessorTypesResponse response =
documentProcessorServiceClient.fetchProcessorTypes(request);
}
| Name | Description |
| request | FetchProcessorTypesRequestThe request object containing all of the parameters for the API call. |
| Type | Description |
| FetchProcessorTypesResponse |
fetchProcessorTypes(LocationName parent)
public final FetchProcessorTypesResponse fetchProcessorTypes(LocationName parent)Fetches processor types. Note that we do not use ListProcessorTypes here because it is not paginated.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
FetchProcessorTypesResponse response =
documentProcessorServiceClient.fetchProcessorTypes(parent);
}
| Name | Description |
| parent | LocationNameRequired. The project of processor type to list. The available processor types
may depend on the allow-listing on projects. Format:
|
| Type | Description |
| FetchProcessorTypesResponse |
fetchProcessorTypes(String parent)
public final FetchProcessorTypesResponse fetchProcessorTypes(String parent)Fetches processor types. Note that we do not use ListProcessorTypes here because it is not paginated.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
FetchProcessorTypesResponse response =
documentProcessorServiceClient.fetchProcessorTypes(parent);
}
| Name | Description |
| parent | StringRequired. The project of processor type to list. The available processor types
may depend on the allow-listing on projects. Format:
|
| Type | Description |
| FetchProcessorTypesResponse |
fetchProcessorTypesCallable()
public final UnaryCallable<FetchProcessorTypesRequest,FetchProcessorTypesResponse> fetchProcessorTypesCallable()Fetches processor types. Note that we do not use ListProcessorTypes here because it is not paginated.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create()) {
FetchProcessorTypesRequest request =
FetchProcessorTypesRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.build();
ApiFuture<FetchProcessorTypesResponse> future =
documentProcessorServiceClient.fetchProcessorTypesCallable().futureCall(request);
// Do something.
FetchProcessorTypesResponse response = future.get();
}
| Type | Description |
| UnaryCallable<FetchProcessorTypesRequest,FetchProcessorTypesResponse> |
getHttpJsonOperationsClient()
public final OperationsClient getHttpJsonOperationsClient()Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
| Type | Description |
| OperationsClient |
getLocation(GetLocationRequest request)
public final Location getLocation(GetLocationRequest request)Gets information about a location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create()) {
GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
Location response = documentProcessorServiceClient.getLocation(request);
}
| Name | Description |
| request | com.google.cloud.location.GetLocationRequestThe request object containing all of the parameters for the API call. |
| Type | Description |
| com.google.cloud.location.Location |
getLocationCallable()
public final UnaryCallable<GetLocationRequest,Location> getLocationCallable()Gets information about a location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create()) {
GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
ApiFuture<Location> future =
documentProcessorServiceClient.getLocationCallable().futureCall(request);
// Do something.
Location response = future.get();
}
| Type | Description |
| UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location> |
getOperationsClient()
public final OperationsClient getOperationsClient()Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
| Type | Description |
| OperationsClient |
getProcessor(GetProcessorRequest request)
public final Processor getProcessor(GetProcessorRequest request)Gets a processor detail.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create()) {
GetProcessorRequest request =
GetProcessorRequest.newBuilder()
.setName(ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString())
.build();
Processor response = documentProcessorServiceClient.getProcessor(request);
}
| Name | Description |
| request | GetProcessorRequestThe request object containing all of the parameters for the API call. |
| Type | Description |
| Processor |
getProcessor(ProcessorName name)
public final Processor getProcessor(ProcessorName name)Gets a processor detail.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create()) {
ProcessorName name = ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]");
Processor response = documentProcessorServiceClient.getProcessor(name);
}
| Name | Description |
| name | ProcessorNameRequired. The processor resource name. |
| Type | Description |
| Processor |
getProcessor(String name)
public final Processor getProcessor(String name)Gets a processor detail.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create()) {
String name = ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString();
Processor response = documentProcessorServiceClient.getProcessor(name);
}
| Name | Description |
| name | StringRequired. The processor resource name. |
| Type | Description |
| Processor |
getProcessorCallable()
public final UnaryCallable<GetProcessorRequest,Processor> getProcessorCallable()Gets a processor detail.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create()) {
GetProcessorRequest request =
GetProcessorRequest.newBuilder()
.setName(ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString())
.build();
ApiFuture<Processor> future =
documentProcessorServiceClient.getProcessorCallable().futureCall(request);
// Do something.
Processor response = future.get();
}
| Type | Description |
| UnaryCallable<GetProcessorRequest,Processor> |
getProcessorVersion(GetProcessorVersionRequest request)
public final ProcessorVersion getProcessorVersion(GetProcessorVersionRequest request)Gets a processor version detail.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create()) {
GetProcessorVersionRequest request =
GetProcessorVersionRequest.newBuilder()
.setName(
ProcessorVersionName.of(
"[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]")
.toString())
.build();
ProcessorVersion response = documentProcessorServiceClient.getProcessorVersion(request);
}
| Name | Description |
| request | GetProcessorVersionRequestThe request object containing all of the parameters for the API call. |
| Type | Description |
| ProcessorVersion |
getProcessorVersion(ProcessorVersionName name)
public final ProcessorVersion getProcessorVersion(ProcessorVersionName name)Gets a processor version detail.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create()) {
ProcessorVersionName name =
ProcessorVersionName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]");
ProcessorVersion response = documentProcessorServiceClient.getProcessorVersion(name);
}
| Name | Description |
| name | ProcessorVersionNameRequired. The processor resource name. |
| Type | Description |
| ProcessorVersion |
getProcessorVersion(String name)
public final ProcessorVersion getProcessorVersion(String name)Gets a processor version detail.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create()) {
String name =
ProcessorVersionName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]")
.toString();
ProcessorVersion response = documentProcessorServiceClient.getProcessorVersion(name);
}
| Name | Description |
| name | StringRequired. The processor resource name. |
| Type | Description |
| ProcessorVersion |
getProcessorVersionCallable()
public final UnaryCallable<GetProcessorVersionRequest,ProcessorVersion> getProcessorVersionCallable()Gets a processor version detail.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create()) {
GetProcessorVersionRequest request =
GetProcessorVersionRequest.newBuilder()
.setName(
ProcessorVersionName.of(
"[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]")
.toString())
.build();
ApiFuture<ProcessorVersion> future =
documentProcessorServiceClient.getProcessorVersionCallable().futureCall(request);
// Do something.
ProcessorVersion response = future.get();
}
| Type | Description |
| UnaryCallable<GetProcessorVersionRequest,ProcessorVersion> |
getSettings()
public final DocumentProcessorServiceSettings getSettings()| Type | Description |
| DocumentProcessorServiceSettings |
getStub()
public DocumentProcessorServiceStub getStub()| Type | Description |
| DocumentProcessorServiceStub |
isShutdown()
public boolean isShutdown()| Type | Description |
| boolean |
isTerminated()
public boolean isTerminated()| Type | Description |
| boolean |
listLocations(ListLocationsRequest request)
public final DocumentProcessorServiceClient.ListLocationsPagedResponse listLocations(ListLocationsRequest request)Lists information about the supported locations for this service.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create()) {
ListLocationsRequest request =
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for (Location element : documentProcessorServiceClient.listLocations(request).iterateAll()) {
// doThingsWith(element);
}
}
| Name | Description |
| request | com.google.cloud.location.ListLocationsRequestThe request object containing all of the parameters for the API call. |
| Type | Description |
| DocumentProcessorServiceClient.ListLocationsPagedResponse |
listLocationsCallable()
public final UnaryCallable<ListLocationsRequest,ListLocationsResponse> listLocationsCallable()Lists information about the supported locations for this service.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create()) {
ListLocationsRequest request =
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while (true) {
ListLocationsResponse response =
documentProcessorServiceClient.listLocationsCallable().call(request);
for (Location element : response.getLocationsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
| Type | Description |
| UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse> |
listLocationsPagedCallable()
public final UnaryCallable<ListLocationsRequest,DocumentProcessorServiceClient.ListLocationsPagedResponse> listLocationsPagedCallable()Lists information about the supported locations for this service.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create()) {
ListLocationsRequest request =
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<Location> future =
documentProcessorServiceClient.listLocationsPagedCallable().futureCall(request);
// Do something.
for (Location element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
| Type | Description |
| UnaryCallable<com.google.cloud.location.ListLocationsRequest,ListLocationsPagedResponse> |
listProcessorTypes(ListProcessorTypesRequest request)
public final DocumentProcessorServiceClient.ListProcessorTypesPagedResponse listProcessorTypes(ListProcessorTypesRequest request)Lists the processor types that exist.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create()) {
ListProcessorTypesRequest request =
ListProcessorTypesRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for (ProcessorType element :
documentProcessorServiceClient.listProcessorTypes(request).iterateAll()) {
// doThingsWith(element);
}
}
| Name | Description |
| request | ListProcessorTypesRequestThe request object containing all of the parameters for the API call. |
| Type | Description |
| DocumentProcessorServiceClient.ListProcessorTypesPagedResponse |
listProcessorTypes(LocationName parent)
public final DocumentProcessorServiceClient.ListProcessorTypesPagedResponse listProcessorTypes(LocationName parent)Lists the processor types that exist.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
for (ProcessorType element :
documentProcessorServiceClient.listProcessorTypes(parent).iterateAll()) {
// doThingsWith(element);
}
}
| Name | Description |
| parent | LocationNameRequired. The location of processor type to list. The available processor types
may depend on the allow-listing on projects. Format:
|
| Type | Description |
| DocumentProcessorServiceClient.ListProcessorTypesPagedResponse |
listProcessorTypes(String parent)
public final DocumentProcessorServiceClient.ListProcessorTypesPagedResponse listProcessorTypes(String parent)Lists the processor types that exist.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
for (ProcessorType element :
documentProcessorServiceClient.listProcessorTypes(parent).iterateAll()) {
// doThingsWith(element);
}
}
| Name | Description |
| parent | StringRequired. The location of processor type to list. The available processor types
may depend on the allow-listing on projects. Format:
|
| Type | Description |
| DocumentProcessorServiceClient.ListProcessorTypesPagedResponse |
listProcessorTypesCallable()
public final UnaryCallable<ListProcessorTypesRequest,ListProcessorTypesResponse> listProcessorTypesCallable()Lists the processor types that exist.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create()) {
ListProcessorTypesRequest request =
ListProcessorTypesRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while (true) {
ListProcessorTypesResponse response =
documentProcessorServiceClient.listProcessorTypesCallable().call(request);
for (ProcessorType element : response.getProcessorTypesList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
| Type | Description |
| UnaryCallable<ListProcessorTypesRequest,ListProcessorTypesResponse> |
listProcessorTypesPagedCallable()
public final UnaryCallable<ListProcessorTypesRequest,DocumentProcessorServiceClient.ListProcessorTypesPagedResponse> listProcessorTypesPagedCallable()Lists the processor types that exist.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create()) {
ListProcessorTypesRequest request =
ListProcessorTypesRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<ProcessorType> future =
documentProcessorServiceClient.listProcessorTypesPagedCallable().futureCall(request);
// Do something.
for (ProcessorType element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
| Type | Description |
| UnaryCallable<ListProcessorTypesRequest,ListProcessorTypesPagedResponse> |
listProcessorVersions(ListProcessorVersionsRequest request)
public final DocumentProcessorServiceClient.ListProcessorVersionsPagedResponse listProcessorVersions(ListProcessorVersionsRequest request)Lists all versions of a processor.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create()) {
ListProcessorVersionsRequest request =
ListProcessorVersionsRequest.newBuilder()
.setParent(ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for (ProcessorVersion element :
documentProcessorServiceClient.listProcessorVersions(request).iterateAll()) {
// doThingsWith(element);
}
}
| Name | Description |
| request | ListProcessorVersionsRequestThe request object containing all of the parameters for the API call. |
| Type | Description |
| DocumentProcessorServiceClient.ListProcessorVersionsPagedResponse |
listProcessorVersions(ProcessorName parent)
public final DocumentProcessorServiceClient.ListProcessorVersionsPagedResponse listProcessorVersions(ProcessorName parent)Lists all versions of a processor.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create()) {
ProcessorName parent = ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]");
for (ProcessorVersion element :
documentProcessorServiceClient.listProcessorVersions(parent).iterateAll()) {
// doThingsWith(element);
}
}
| Name | Description |
| parent | ProcessorNameRequired. The parent (project, location and processor) to list all versions.
Format: |
| Type | Description |
| DocumentProcessorServiceClient.ListProcessorVersionsPagedResponse |
listProcessorVersions(String parent)
public final DocumentProcessorServiceClient.ListProcessorVersionsPagedResponse listProcessorVersions(String parent)Lists all versions of a processor.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create()) {
String parent = ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString();
for (ProcessorVersion element :
documentProcessorServiceClient.listProcessorVersions(parent).iterateAll()) {
// doThingsWith(element);
}
}
| Name | Description |
| parent | StringRequired. The parent (project, location and processor) to list all versions.
Format: |
| Type | Description |
| DocumentProcessorServiceClient.ListProcessorVersionsPagedResponse |
listProcessorVersionsCallable()
public final UnaryCallable<ListProcessorVersionsRequest,ListProcessorVersionsResponse> listProcessorVersionsCallable()Lists all versions of a processor.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create()) {
ListProcessorVersionsRequest request =
ListProcessorVersionsRequest.newBuilder()
.setParent(ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while (true) {
ListProcessorVersionsResponse response =
documentProcessorServiceClient.listProcessorVersionsCallable().call(request);
for (ProcessorVersion element : response.getProcessorVersionsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
| Type | Description |
| UnaryCallable<ListProcessorVersionsRequest,ListProcessorVersionsResponse> |
listProcessorVersionsPagedCallable()
public final UnaryCallable<ListProcessorVersionsRequest,DocumentProcessorServiceClient.ListProcessorVersionsPagedResponse> listProcessorVersionsPagedCallable()Lists all versions of a processor.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create()) {
ListProcessorVersionsRequest request =
ListProcessorVersionsRequest.newBuilder()
.setParent(ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<ProcessorVersion> future =
documentProcessorServiceClient.listProcessorVersionsPagedCallable().futureCall(request);
// Do something.
for (ProcessorVersion element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
| Type | Description |
| UnaryCallable<ListProcessorVersionsRequest,ListProcessorVersionsPagedResponse> |
listProcessors(ListProcessorsRequest request)
public final DocumentProcessorServiceClient.ListProcessorsPagedResponse listProcessors(ListProcessorsRequest request)Lists all processors which belong to this project.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create()) {
ListProcessorsRequest request =
ListProcessorsRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for (Processor element :
documentProcessorServiceClient.listProcessors(request).iterateAll()) {
// doThingsWith(element);
}
}
| Name | Description |
| request | ListProcessorsRequestThe request object containing all of the parameters for the API call. |
| Type | Description |
| DocumentProcessorServiceClient.ListProcessorsPagedResponse |
listProcessors(LocationName parent)
public final DocumentProcessorServiceClient.ListProcessorsPagedResponse listProcessors(LocationName parent)Lists all processors which belong to this project.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
for (Processor element : documentProcessorServiceClient.listProcessors(parent).iterateAll()) {
// doThingsWith(element);
}
}
| Name | Description |
| parent | LocationNameRequired. The parent (project and location) which owns this collection of
Processors. Format: |
| Type | Description |
| DocumentProcessorServiceClient.ListProcessorsPagedResponse |
listProcessors(String parent)
public final DocumentProcessorServiceClient.ListProcessorsPagedResponse listProcessors(String parent)Lists all processors which belong to this project.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
for (Processor element : documentProcessorServiceClient.listProcessors(parent).iterateAll()) {
// doThingsWith(element);
}
}
| Name | Description |
| parent | StringRequired. The parent (project and location) which owns this collection of
Processors. Format: |
| Type | Description |
| DocumentProcessorServiceClient.ListProcessorsPagedResponse |
listProcessorsCallable()
public final UnaryCallable<ListProcessorsRequest,ListProcessorsResponse> listProcessorsCallable()Lists all processors which belong to this project.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create()) {
ListProcessorsRequest request =
ListProcessorsRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while (true) {
ListProcessorsResponse response =
documentProcessorServiceClient.listProcessorsCallable().call(request);
for (Processor element : response.getProcessorsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
| Type | Description |
| UnaryCallable<ListProcessorsRequest,ListProcessorsResponse> |
listProcessorsPagedCallable()
public final UnaryCallable<ListProcessorsRequest,DocumentProcessorServiceClient.ListProcessorsPagedResponse> listProcessorsPagedCallable()Lists all processors which belong to this project.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create()) {
ListProcessorsRequest request =
ListProcessorsRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<Processor> future =
documentProcessorServiceClient.listProcessorsPagedCallable().futureCall(request);
// Do something.
for (Processor element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
| Type | Description |
| UnaryCallable<ListProcessorsRequest,ListProcessorsPagedResponse> |
processDocument(ResourceName name)
public final ProcessResponse processDocument(ResourceName name)Processes a single document.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create()) {
ResourceName name = ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]");
ProcessResponse response = documentProcessorServiceClient.processDocument(name);
}
| Name | Description |
| name | com.google.api.resourcenames.ResourceNameRequired. The resource name of the
Processor or
ProcessorVersion to use for processing.
If a Processor is specified, the server will
use its default
version. Format:
|
| Type | Description |
| ProcessResponse |
processDocument(ProcessRequest request)
public final ProcessResponse processDocument(ProcessRequest request)Processes a single document.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create()) {
ProcessRequest request =
ProcessRequest.newBuilder()
.setName(ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString())
.setDocument(Document.newBuilder().build())
.setSkipHumanReview(true)
.setFieldMask(FieldMask.newBuilder().build())
.build();
ProcessResponse response = documentProcessorServiceClient.processDocument(request);
}
| Name | Description |
| request | ProcessRequestThe request object containing all of the parameters for the API call. |
| Type | Description |
| ProcessResponse |
processDocument(String name)
public final ProcessResponse processDocument(String name)Processes a single document.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create()) {
String name = HumanReviewConfigName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString();
ProcessResponse response = documentProcessorServiceClient.processDocument(name);
}
| Name | Description |
| name | StringRequired. The resource name of the
Processor or
ProcessorVersion to use for processing.
If a Processor is specified, the server will
use its default
version. Format:
|
| Type | Description |
| ProcessResponse |
processDocumentCallable()
public final UnaryCallable<ProcessRequest,ProcessResponse> processDocumentCallable()Processes a single document.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create()) {
ProcessRequest request =
ProcessRequest.newBuilder()
.setName(ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString())
.setDocument(Document.newBuilder().build())
.setSkipHumanReview(true)
.setFieldMask(FieldMask.newBuilder().build())
.build();
ApiFuture<ProcessResponse> future =
documentProcessorServiceClient.processDocumentCallable().futureCall(request);
// Do something.
ProcessResponse response = future.get();
}
| Type | Description |
| UnaryCallable<ProcessRequest,ProcessResponse> |
reviewDocumentAsync(HumanReviewConfigName humanReviewConfig)
public final OperationFuture<ReviewDocumentResponse,ReviewDocumentOperationMetadata> reviewDocumentAsync(HumanReviewConfigName humanReviewConfig)Send a document for Human Review. The input document should be processed by the specified processor.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create()) {
HumanReviewConfigName humanReviewConfig =
HumanReviewConfigName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]");
ReviewDocumentResponse response =
documentProcessorServiceClient.reviewDocumentAsync(humanReviewConfig).get();
}
| Name | Description |
| humanReviewConfig | HumanReviewConfigNameRequired. The resource name of the HumanReviewConfig that the document will be reviewed with. |
| Type | Description |
| OperationFuture<ReviewDocumentResponse,ReviewDocumentOperationMetadata> |
reviewDocumentAsync(ReviewDocumentRequest request)
public final OperationFuture<ReviewDocumentResponse,ReviewDocumentOperationMetadata> reviewDocumentAsync(ReviewDocumentRequest request)Send a document for Human Review. The input document should be processed by the specified processor.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create()) {
ReviewDocumentRequest request =
ReviewDocumentRequest.newBuilder()
.setHumanReviewConfig(
HumanReviewConfigName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString())
.setDocument(Document.newBuilder().build())
.setEnableSchemaValidation(true)
.setDocumentSchema(DocumentSchema.newBuilder().build())
.build();
ReviewDocumentResponse response =
documentProcessorServiceClient.reviewDocumentAsync(request).get();
}
| Name | Description |
| request | ReviewDocumentRequestThe request object containing all of the parameters for the API call. |
| Type | Description |
| OperationFuture<ReviewDocumentResponse,ReviewDocumentOperationMetadata> |
reviewDocumentAsync(String humanReviewConfig)
public final OperationFuture<ReviewDocumentResponse,ReviewDocumentOperationMetadata> reviewDocumentAsync(String humanReviewConfig)Send a document for Human Review. The input document should be processed by the specified processor.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create()) {
String humanReviewConfig =
HumanReviewConfigName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString();
ReviewDocumentResponse response =
documentProcessorServiceClient.reviewDocumentAsync(humanReviewConfig).get();
}
| Name | Description |
| humanReviewConfig | StringRequired. The resource name of the HumanReviewConfig that the document will be reviewed with. |
| Type | Description |
| OperationFuture<ReviewDocumentResponse,ReviewDocumentOperationMetadata> |
reviewDocumentCallable()
public final UnaryCallable<ReviewDocumentRequest,Operation> reviewDocumentCallable()Send a document for Human Review. The input document should be processed by the specified processor.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create()) {
ReviewDocumentRequest request =
ReviewDocumentRequest.newBuilder()
.setHumanReviewConfig(
HumanReviewConfigName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString())
.setDocument(Document.newBuilder().build())
.setEnableSchemaValidation(true)
.setDocumentSchema(DocumentSchema.newBuilder().build())
.build();
ApiFuture<Operation> future =
documentProcessorServiceClient.reviewDocumentCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
| Type | Description |
| UnaryCallable<ReviewDocumentRequest,Operation> |
reviewDocumentOperationCallable()
public final OperationCallable<ReviewDocumentRequest,ReviewDocumentResponse,ReviewDocumentOperationMetadata> reviewDocumentOperationCallable()Send a document for Human Review. The input document should be processed by the specified processor.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create()) {
ReviewDocumentRequest request =
ReviewDocumentRequest.newBuilder()
.setHumanReviewConfig(
HumanReviewConfigName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString())
.setDocument(Document.newBuilder().build())
.setEnableSchemaValidation(true)
.setDocumentSchema(DocumentSchema.newBuilder().build())
.build();
OperationFuture<ReviewDocumentResponse, ReviewDocumentOperationMetadata> future =
documentProcessorServiceClient.reviewDocumentOperationCallable().futureCall(request);
// Do something.
ReviewDocumentResponse response = future.get();
}
| Type | Description |
| OperationCallable<ReviewDocumentRequest,ReviewDocumentResponse,ReviewDocumentOperationMetadata> |
setDefaultProcessorVersionAsync(SetDefaultProcessorVersionRequest request)
public final OperationFuture<SetDefaultProcessorVersionResponse,SetDefaultProcessorVersionMetadata> setDefaultProcessorVersionAsync(SetDefaultProcessorVersionRequest request)Set the default (active) version of a Processor that will be used in ProcessDocument and BatchProcessDocuments.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create()) {
SetDefaultProcessorVersionRequest request =
SetDefaultProcessorVersionRequest.newBuilder()
.setProcessor(ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString())
.setDefaultProcessorVersion(
ProcessorVersionName.of(
"[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]")
.toString())
.build();
SetDefaultProcessorVersionResponse response =
documentProcessorServiceClient.setDefaultProcessorVersionAsync(request).get();
}
| Name | Description |
| request | SetDefaultProcessorVersionRequestThe request object containing all of the parameters for the API call. |
| Type | Description |
| OperationFuture<SetDefaultProcessorVersionResponse,SetDefaultProcessorVersionMetadata> |
setDefaultProcessorVersionCallable()
public final UnaryCallable<SetDefaultProcessorVersionRequest,Operation> setDefaultProcessorVersionCallable()Set the default (active) version of a Processor that will be used in ProcessDocument and BatchProcessDocuments.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create()) {
SetDefaultProcessorVersionRequest request =
SetDefaultProcessorVersionRequest.newBuilder()
.setProcessor(ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString())
.setDefaultProcessorVersion(
ProcessorVersionName.of(
"[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]")
.toString())
.build();
ApiFuture<Operation> future =
documentProcessorServiceClient.setDefaultProcessorVersionCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
| Type | Description |
| UnaryCallable<SetDefaultProcessorVersionRequest,Operation> |
setDefaultProcessorVersionOperationCallable()
public final OperationCallable<SetDefaultProcessorVersionRequest,SetDefaultProcessorVersionResponse,SetDefaultProcessorVersionMetadata> setDefaultProcessorVersionOperationCallable()Set the default (active) version of a Processor that will be used in ProcessDocument and BatchProcessDocuments.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create()) {
SetDefaultProcessorVersionRequest request =
SetDefaultProcessorVersionRequest.newBuilder()
.setProcessor(ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString())
.setDefaultProcessorVersion(
ProcessorVersionName.of(
"[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]")
.toString())
.build();
OperationFuture<SetDefaultProcessorVersionResponse, SetDefaultProcessorVersionMetadata>
future =
documentProcessorServiceClient
.setDefaultProcessorVersionOperationCallable()
.futureCall(request);
// Do something.
SetDefaultProcessorVersionResponse response = future.get();
}
| Type | Description |
| OperationCallable<SetDefaultProcessorVersionRequest,SetDefaultProcessorVersionResponse,SetDefaultProcessorVersionMetadata> |
shutdown()
public void shutdown()shutdownNow()
public void shutdownNow()undeployProcessorVersionAsync(ProcessorVersionName name)
public final OperationFuture<UndeployProcessorVersionResponse,UndeployProcessorVersionMetadata> undeployProcessorVersionAsync(ProcessorVersionName name)Undeploys the processor version.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create()) {
ProcessorVersionName name =
ProcessorVersionName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]");
UndeployProcessorVersionResponse response =
documentProcessorServiceClient.undeployProcessorVersionAsync(name).get();
}
| Name | Description |
| name | ProcessorVersionNameRequired. The processor version resource name to be undeployed. |
| Type | Description |
| OperationFuture<UndeployProcessorVersionResponse,UndeployProcessorVersionMetadata> |
undeployProcessorVersionAsync(UndeployProcessorVersionRequest request)
public final OperationFuture<UndeployProcessorVersionResponse,UndeployProcessorVersionMetadata> undeployProcessorVersionAsync(UndeployProcessorVersionRequest request)Undeploys the processor version.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create()) {
UndeployProcessorVersionRequest request =
UndeployProcessorVersionRequest.newBuilder()
.setName(
ProcessorVersionName.of(
"[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]")
.toString())
.build();
UndeployProcessorVersionResponse response =
documentProcessorServiceClient.undeployProcessorVersionAsync(request).get();
}
| Name | Description |
| request | UndeployProcessorVersionRequestThe request object containing all of the parameters for the API call. |
| Type | Description |
| OperationFuture<UndeployProcessorVersionResponse,UndeployProcessorVersionMetadata> |
undeployProcessorVersionAsync(String name)
public final OperationFuture<UndeployProcessorVersionResponse,UndeployProcessorVersionMetadata> undeployProcessorVersionAsync(String name)Undeploys the processor version.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create()) {
String name =
ProcessorVersionName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]")
.toString();
UndeployProcessorVersionResponse response =
documentProcessorServiceClient.undeployProcessorVersionAsync(name).get();
}
| Name | Description |
| name | StringRequired. The processor version resource name to be undeployed. |
| Type | Description |
| OperationFuture<UndeployProcessorVersionResponse,UndeployProcessorVersionMetadata> |
undeployProcessorVersionCallable()
public final UnaryCallable<UndeployProcessorVersionRequest,Operation> undeployProcessorVersionCallable()Undeploys the processor version.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create()) {
UndeployProcessorVersionRequest request =
UndeployProcessorVersionRequest.newBuilder()
.setName(
ProcessorVersionName.of(
"[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]")
.toString())
.build();
ApiFuture<Operation> future =
documentProcessorServiceClient.undeployProcessorVersionCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
| Type | Description |
| UnaryCallable<UndeployProcessorVersionRequest,Operation> |
undeployProcessorVersionOperationCallable()
public final OperationCallable<UndeployProcessorVersionRequest,UndeployProcessorVersionResponse,UndeployProcessorVersionMetadata> undeployProcessorVersionOperationCallable()Undeploys the processor version.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create()) {
UndeployProcessorVersionRequest request =
UndeployProcessorVersionRequest.newBuilder()
.setName(
ProcessorVersionName.of(
"[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]")
.toString())
.build();
OperationFuture<UndeployProcessorVersionResponse, UndeployProcessorVersionMetadata> future =
documentProcessorServiceClient
.undeployProcessorVersionOperationCallable()
.futureCall(request);
// Do something.
UndeployProcessorVersionResponse response = future.get();
}
| Type | Description |
| OperationCallable<UndeployProcessorVersionRequest,UndeployProcessorVersionResponse,UndeployProcessorVersionMetadata> |