DocumentServiceClient (Google Cloud Document AI 2.57.0 API)

java.lang.Object
- com.google.cloud.documentai.v1beta3.DocumentServiceClient

All Implemented Interfaces:: com.google.api.gax.core.BackgroundResource, AutoCloseable

@BetaApi
 @Generated(value="by gapic-generator-java")
public class DocumentServiceClient
extends Object
implements com.google.api.gax.core.BackgroundResource

Service Description: Service to call Cloud DocumentAI to manage document collection (dataset).

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 (DocumentServiceClient documentServiceClient = DocumentServiceClient.create()) {
   DatasetName dataset = DatasetName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]");
   GetDocumentResponse response = documentServiceClient.getDocument(dataset);
 }

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

Methods
Method	Description	Method Variants
UpdateDataset	Updates metadata associated with a dataset. Note that this method requires the `documentai.googleapis.com/datasets.update` permission on the project, which is highly privileged. A user or service account with this permission can create new processors that can interact with any gcs bucket in your project.	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateDatasetAsync(UpdateDatasetRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. updateDatasetAsync(Dataset dataset, FieldMask updateMask) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updateDatasetOperationCallable() updateDatasetCallable()
ImportDocuments	Import documents into a dataset.	Request object method variants only take one parameter, a request object, which must be constructed before the call. importDocumentsAsync(ImportDocumentsRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. importDocumentsAsync(DatasetName dataset) importDocumentsAsync(String dataset) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. importDocumentsOperationCallable() importDocumentsCallable()
GetDocument	Returns relevant fields present in the requested document.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getDocument(GetDocumentRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getDocument(DatasetName dataset) getDocument(String dataset) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getDocumentCallable()
ListDocuments	Returns a list of documents present in the dataset.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listDocuments(ListDocumentsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listDocuments(DatasetName dataset) listDocuments(String dataset) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listDocumentsPagedCallable() listDocumentsCallable()
BatchDeleteDocuments	Deletes a set of documents.	Request object method variants only take one parameter, a request object, which must be constructed before the call. batchDeleteDocumentsAsync(BatchDeleteDocumentsRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. batchDeleteDocumentsAsync(String dataset) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. batchDeleteDocumentsOperationCallable() batchDeleteDocumentsCallable()
GetDatasetSchema	Gets the `DatasetSchema` of a `Dataset`.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getDatasetSchema(GetDatasetSchemaRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getDatasetSchema(DatasetSchemaName name) getDatasetSchema(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getDatasetSchemaCallable()
UpdateDatasetSchema	Updates a `DatasetSchema`.	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateDatasetSchema(UpdateDatasetSchemaRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. updateDatasetSchema(DatasetSchema datasetSchema, FieldMask updateMask) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updateDatasetSchemaCallable()
ListLocations	Lists information about the supported locations for this service.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listLocations(ListLocationsRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listLocationsPagedCallable() listLocationsCallable()
GetLocation	Gets information about a location.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getLocation(GetLocationRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getLocationCallable()

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 DocumentServiceSettings 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
 DocumentServiceSettings documentServiceSettings =
     DocumentServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 DocumentServiceClient documentServiceClient =
     DocumentServiceClient.create(documentServiceSettings);

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
 DocumentServiceSettings documentServiceSettings =
     DocumentServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 DocumentServiceClient documentServiceClient =
     DocumentServiceClient.create(documentServiceSettings);

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
 DocumentServiceSettings documentServiceSettings =
     DocumentServiceSettings.newHttpJsonBuilder().build();
 DocumentServiceClient documentServiceClient =
     DocumentServiceClient.create(documentServiceSettings);

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

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`DocumentServiceClient.ListDocumentsFixedSizeCollection`
`static class`	`DocumentServiceClient.ListDocumentsPage`
`static class`	`DocumentServiceClient.ListDocumentsPagedResponse`
`static class`	`DocumentServiceClient.ListLocationsFixedSizeCollection`
`static class`	`DocumentServiceClient.ListLocationsPage`
`static class`	`DocumentServiceClient.ListLocationsPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`DocumentServiceClient(DocumentServiceSettings settings)` Constructs an instance of DocumentServiceClient, using the given settings.
`protected`	`DocumentServiceClient(DocumentServiceStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`com.google.api.gax.longrunning.OperationFuture<BatchDeleteDocumentsResponse,BatchDeleteDocumentsMetadata>`	`batchDeleteDocumentsAsync(BatchDeleteDocumentsRequest request)` Deletes a set of documents.
`com.google.api.gax.longrunning.OperationFuture<BatchDeleteDocumentsResponse,BatchDeleteDocumentsMetadata>`	`batchDeleteDocumentsAsync(String dataset)` Deletes a set of documents.
`com.google.api.gax.rpc.UnaryCallable<BatchDeleteDocumentsRequest,com.google.longrunning.Operation>`	`batchDeleteDocumentsCallable()` Deletes a set of documents.
`com.google.api.gax.rpc.OperationCallable<BatchDeleteDocumentsRequest,BatchDeleteDocumentsResponse,BatchDeleteDocumentsMetadata>`	`batchDeleteDocumentsOperationCallable()` Deletes a set of documents.
`void`	`close()`
`static DocumentServiceClient`	`create()` Constructs an instance of DocumentServiceClient with default settings.
`static DocumentServiceClient`	`create(DocumentServiceSettings settings)` Constructs an instance of DocumentServiceClient, using the given settings.
`static DocumentServiceClient`	`create(DocumentServiceStub stub)` Constructs an instance of DocumentServiceClient, using the given stub for making calls.
`DatasetSchema`	`getDatasetSchema(DatasetSchemaName name)` Gets the `DatasetSchema` of a `Dataset`.
`DatasetSchema`	`getDatasetSchema(GetDatasetSchemaRequest request)` Gets the `DatasetSchema` of a `Dataset`.
`DatasetSchema`	`getDatasetSchema(String name)` Gets the `DatasetSchema` of a `Dataset`.
`com.google.api.gax.rpc.UnaryCallable<GetDatasetSchemaRequest,DatasetSchema>`	`getDatasetSchemaCallable()` Gets the `DatasetSchema` of a `Dataset`.
`GetDocumentResponse`	`getDocument(DatasetName dataset)` Returns relevant fields present in the requested document.
`GetDocumentResponse`	`getDocument(GetDocumentRequest request)` Returns relevant fields present in the requested document.
`GetDocumentResponse`	`getDocument(String dataset)` Returns relevant fields present in the requested document.
`com.google.api.gax.rpc.UnaryCallable<GetDocumentRequest,GetDocumentResponse>`	`getDocumentCallable()` Returns relevant fields present in the requested document.
`com.google.api.gax.httpjson.longrunning.OperationsClient`	`getHttpJsonOperationsClient()` Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
`com.google.cloud.location.Location`	`getLocation(com.google.cloud.location.GetLocationRequest request)` Gets information about a location.
`com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>`	`getLocationCallable()` Gets information about a location.
`com.google.longrunning.OperationsClient`	`getOperationsClient()` Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
`DocumentServiceSettings`	`getSettings()`
`DocumentServiceStub`	`getStub()`
`com.google.api.gax.longrunning.OperationFuture<ImportDocumentsResponse,ImportDocumentsMetadata>`	`importDocumentsAsync(DatasetName dataset)` Import documents into a dataset.
`com.google.api.gax.longrunning.OperationFuture<ImportDocumentsResponse,ImportDocumentsMetadata>`	`importDocumentsAsync(ImportDocumentsRequest request)` Import documents into a dataset.
`com.google.api.gax.longrunning.OperationFuture<ImportDocumentsResponse,ImportDocumentsMetadata>`	`importDocumentsAsync(String dataset)` Import documents into a dataset.
`com.google.api.gax.rpc.UnaryCallable<ImportDocumentsRequest,com.google.longrunning.Operation>`	`importDocumentsCallable()` Import documents into a dataset.
`com.google.api.gax.rpc.OperationCallable<ImportDocumentsRequest,ImportDocumentsResponse,ImportDocumentsMetadata>`	`importDocumentsOperationCallable()` Import documents into a dataset.
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`DocumentServiceClient.ListDocumentsPagedResponse`	`listDocuments(DatasetName dataset)` Returns a list of documents present in the dataset.
`DocumentServiceClient.ListDocumentsPagedResponse`	`listDocuments(ListDocumentsRequest request)` Returns a list of documents present in the dataset.
`DocumentServiceClient.ListDocumentsPagedResponse`	`listDocuments(String dataset)` Returns a list of documents present in the dataset.
`com.google.api.gax.rpc.UnaryCallable<ListDocumentsRequest,ListDocumentsResponse>`	`listDocumentsCallable()` Returns a list of documents present in the dataset.
`com.google.api.gax.rpc.UnaryCallable<ListDocumentsRequest,DocumentServiceClient.ListDocumentsPagedResponse>`	`listDocumentsPagedCallable()` Returns a list of documents present in the dataset.
`DocumentServiceClient.ListLocationsPagedResponse`	`listLocations(com.google.cloud.location.ListLocationsRequest request)` Lists information about the supported locations for this service.
`com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse>`	`listLocationsCallable()` Lists information about the supported locations for this service.
`com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,DocumentServiceClient.ListLocationsPagedResponse>`	`listLocationsPagedCallable()` Lists information about the supported locations for this service.
`void`	`shutdown()`
`void`	`shutdownNow()`
`com.google.api.gax.longrunning.OperationFuture<Dataset,UpdateDatasetOperationMetadata>`	`updateDatasetAsync(Dataset dataset, com.google.protobuf.FieldMask updateMask)` Updates metadata associated with a dataset.
`com.google.api.gax.longrunning.OperationFuture<Dataset,UpdateDatasetOperationMetadata>`	`updateDatasetAsync(UpdateDatasetRequest request)` Updates metadata associated with a dataset.
`com.google.api.gax.rpc.UnaryCallable<UpdateDatasetRequest,com.google.longrunning.Operation>`	`updateDatasetCallable()` Updates metadata associated with a dataset.
`com.google.api.gax.rpc.OperationCallable<UpdateDatasetRequest,Dataset,UpdateDatasetOperationMetadata>`	`updateDatasetOperationCallable()` Updates metadata associated with a dataset.
`DatasetSchema`	`updateDatasetSchema(DatasetSchema datasetSchema, com.google.protobuf.FieldMask updateMask)` Updates a `DatasetSchema`.
`DatasetSchema`	`updateDatasetSchema(UpdateDatasetSchemaRequest request)` Updates a `DatasetSchema`.
`com.google.api.gax.rpc.UnaryCallable<UpdateDatasetSchemaRequest,DatasetSchema>`	`updateDatasetSchemaCallable()` Updates a `DatasetSchema`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- DocumentServiceClient
```
protected DocumentServiceClient(DocumentServiceSettings settings)
                         throws IOException
```
  Constructs an instance of DocumentServiceClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.
  
  Throws:
  
  IOException
- DocumentServiceClient
```
protected DocumentServiceClient(DocumentServiceStub stub)
```

Method Detail

create

public static final DocumentServiceClient create()
                                          throws IOException

Constructs an instance of DocumentServiceClient with default settings.

Throws:: IOException

create
```
public static final DocumentServiceClient create(DocumentServiceSettings settings)
                                          throws IOException
```
Constructs an instance of DocumentServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Throws:

IOException

create
```
public static final DocumentServiceClient create(DocumentServiceStub stub)
```
Constructs an instance of DocumentServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(DocumentServiceSettings).

getSettings

public final DocumentServiceSettings getSettings()

getStub
```
public DocumentServiceStub getStub()
```

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

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

updateDatasetAsync

public final com.google.api.gax.longrunning.OperationFuture<Dataset,UpdateDatasetOperationMetadata> updateDatasetAsync(Dataset dataset,
                                                                                                                       com.google.protobuf.FieldMask updateMask)

Updates metadata associated with a dataset. Note that this method requires the `documentai.googleapis.com/datasets.update` permission on the project, which is highly privileged. A user or service account with this permission can create new processors that can interact with any gcs bucket in your 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 (DocumentServiceClient documentServiceClient = DocumentServiceClient.create()) {
   Dataset dataset = Dataset.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Dataset response = documentServiceClient.updateDatasetAsync(dataset, updateMask).get();
 }

Parameters:: dataset - Required. The `name` field of the `Dataset` is used to identify the resource to be updated.; updateMask - The update mask applies to the resource.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

updateDatasetAsync

public final com.google.api.gax.longrunning.OperationFuture<Dataset,UpdateDatasetOperationMetadata> updateDatasetAsync(UpdateDatasetRequest request)

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentServiceClient documentServiceClient = DocumentServiceClient.create()) {
   UpdateDatasetRequest request =
       UpdateDatasetRequest.newBuilder()
           .setDataset(Dataset.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Dataset response = documentServiceClient.updateDatasetAsync(request).get();
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

updateDatasetOperationCallable

public final com.google.api.gax.rpc.OperationCallable<UpdateDatasetRequest,Dataset,UpdateDatasetOperationMetadata> updateDatasetOperationCallable()

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentServiceClient documentServiceClient = DocumentServiceClient.create()) {
   UpdateDatasetRequest request =
       UpdateDatasetRequest.newBuilder()
           .setDataset(Dataset.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   OperationFuture<Dataset, UpdateDatasetOperationMetadata> future =
       documentServiceClient.updateDatasetOperationCallable().futureCall(request);
   // Do something.
   Dataset response = future.get();
 }

updateDatasetCallable

public final com.google.api.gax.rpc.UnaryCallable<UpdateDatasetRequest,com.google.longrunning.Operation> updateDatasetCallable()

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentServiceClient documentServiceClient = DocumentServiceClient.create()) {
   UpdateDatasetRequest request =
       UpdateDatasetRequest.newBuilder()
           .setDataset(Dataset.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       documentServiceClient.updateDatasetCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

importDocumentsAsync

public final com.google.api.gax.longrunning.OperationFuture<ImportDocumentsResponse,ImportDocumentsMetadata> importDocumentsAsync(DatasetName dataset)

Import documents into a dataset.

Sample code:


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

Parameters:: dataset - Required. The dataset resource name. Format: projects/{project}/locations/{location}/processors/{processor}/dataset
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

importDocumentsAsync

public final com.google.api.gax.longrunning.OperationFuture<ImportDocumentsResponse,ImportDocumentsMetadata> importDocumentsAsync(String dataset)

Import documents into a dataset.

Sample code:


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

Parameters:: dataset - Required. The dataset resource name. Format: projects/{project}/locations/{location}/processors/{processor}/dataset
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

importDocumentsAsync

public final com.google.api.gax.longrunning.OperationFuture<ImportDocumentsResponse,ImportDocumentsMetadata> importDocumentsAsync(ImportDocumentsRequest request)

Import documents into a dataset.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentServiceClient documentServiceClient = DocumentServiceClient.create()) {
   ImportDocumentsRequest request =
       ImportDocumentsRequest.newBuilder()
           .setDataset(DatasetName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString())
           .addAllBatchDocumentsImportConfigs(
               new ArrayList<ImportDocumentsRequest.BatchDocumentsImportConfig>())
           .build();
   ImportDocumentsResponse response = documentServiceClient.importDocumentsAsync(request).get();
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

importDocumentsOperationCallable

public final com.google.api.gax.rpc.OperationCallable<ImportDocumentsRequest,ImportDocumentsResponse,ImportDocumentsMetadata> importDocumentsOperationCallable()

Import documents into a dataset.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DocumentServiceClient documentServiceClient = DocumentServiceClient.create()) {
   ImportDocumentsRequest request =
       ImportDocumentsRequest.newBuilder()
           .setDataset(DatasetName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString())
           .addAllBatchDocumentsImportConfigs(
               new ArrayList<ImportDocumentsRequest.BatchDocumentsImportConfig>())
           .build();
   OperationFuture<ImportDocumentsResponse, ImportDocumentsMetadata> future =
       documentServiceClient.importDocumentsOperationCallable().futureCall(request);
   // Do something.
   ImportDocumentsResponse response = future.get();
 }

importDocumentsCallable

public final com.google.api.gax.rpc.UnaryCallable<ImportDocumentsRequest,com.google.longrunning.Operation> importDocumentsCallable()

Import documents into a dataset.

Sample code:


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

getDocument

public final GetDocumentResponse getDocument(DatasetName dataset)

Returns relevant fields present in the requested 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 (DocumentServiceClient documentServiceClient = DocumentServiceClient.create()) {
   DatasetName dataset = DatasetName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]");
   GetDocumentResponse response = documentServiceClient.getDocument(dataset);
 }

Parameters:: dataset - Required. The resource name of the dataset that the document belongs to . Format: projects/{project}/locations/{location}/processors/{processor}/dataset
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getDocument

public final GetDocumentResponse getDocument(String dataset)

Returns relevant fields present in the requested 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 (DocumentServiceClient documentServiceClient = DocumentServiceClient.create()) {
   String dataset = DatasetName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString();
   GetDocumentResponse response = documentServiceClient.getDocument(dataset);
 }

Parameters:: dataset - Required. The resource name of the dataset that the document belongs to . Format: projects/{project}/locations/{location}/processors/{processor}/dataset
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getDocument

public final GetDocumentResponse getDocument(GetDocumentRequest request)

Returns relevant fields present in the requested 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 (DocumentServiceClient documentServiceClient = DocumentServiceClient.create()) {
   GetDocumentRequest request =
       GetDocumentRequest.newBuilder()
           .setDataset(DatasetName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString())
           .setDocumentId(DocumentId.newBuilder().build())
           .setReadMask(FieldMask.newBuilder().build())
           .setPageRange(DocumentPageRange.newBuilder().build())
           .build();
   GetDocumentResponse response = documentServiceClient.getDocument(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getDocumentCallable

public final com.google.api.gax.rpc.UnaryCallable<GetDocumentRequest,GetDocumentResponse> getDocumentCallable()

Returns relevant fields present in the requested 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 (DocumentServiceClient documentServiceClient = DocumentServiceClient.create()) {
   GetDocumentRequest request =
       GetDocumentRequest.newBuilder()
           .setDataset(DatasetName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString())
           .setDocumentId(DocumentId.newBuilder().build())
           .setReadMask(FieldMask.newBuilder().build())
           .setPageRange(DocumentPageRange.newBuilder().build())
           .build();
   ApiFuture<GetDocumentResponse> future =
       documentServiceClient.getDocumentCallable().futureCall(request);
   // Do something.
   GetDocumentResponse response = future.get();
 }