Class ImageAnnotatorClient (2.0.29)

public class ImageAnnotatorClient implements BackgroundResource

Service Description: Service that performs Google Cloud Vision API detection tasks over client images, such as face, landmark, logo, label, and text detection. The ImageAnnotator service returns detected entities from the images.

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:


 try (ImageAnnotatorClient imageAnnotatorClient = ImageAnnotatorClient.create()) {
   List<AnnotateImageRequest> requests = new ArrayList<>();
   BatchAnnotateImagesResponse response = imageAnnotatorClient.batchAnnotateImages(requests);
 }

Note: close() needs to be called on the ImageAnnotatorClient 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 ImageAnnotatorSettings to create(). For example:

To customize credentials:


 ImageAnnotatorSettings imageAnnotatorSettings =
     ImageAnnotatorSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ImageAnnotatorClient imageAnnotatorClient = ImageAnnotatorClient.create(imageAnnotatorSettings);

To customize the endpoint:


 ImageAnnotatorSettings imageAnnotatorSettings =
     ImageAnnotatorSettings.newBuilder().setEndpoint(myEndpoint).build();
 ImageAnnotatorClient imageAnnotatorClient = ImageAnnotatorClient.create(imageAnnotatorSettings);

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

Inheritance

java.lang.Object > ImageAnnotatorClient

Implements

BackgroundResource

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create()

public static final ImageAnnotatorClient create()

Constructs an instance of ImageAnnotatorClient with default settings.

Returns

Type	Description
ImageAnnotatorClient

Exceptions

Type	Description
IOException

create(ImageAnnotatorSettings settings)

public static final ImageAnnotatorClient create(ImageAnnotatorSettings settings)

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

Parameter

Name	Description
settings	`ImageAnnotatorSettings`

Returns

Type	Description
ImageAnnotatorClient

Exceptions

Type	Description
IOException

create(ImageAnnotatorStub stub)

public static final ImageAnnotatorClient create(ImageAnnotatorStub stub)

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

Parameter

Name	Description
stub	`ImageAnnotatorStub`

Returns

Type	Description
ImageAnnotatorClient

Constructors

ImageAnnotatorClient(ImageAnnotatorSettings settings)

protected ImageAnnotatorClient(ImageAnnotatorSettings settings)

Constructs an instance of ImageAnnotatorClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Parameter

Name	Description
settings	`ImageAnnotatorSettings`

ImageAnnotatorClient(ImageAnnotatorStub stub)

protected ImageAnnotatorClient(ImageAnnotatorStub stub)

Parameter

Name	Description
stub	`ImageAnnotatorStub`

Methods

asyncBatchAnnotateFilesAsync(AsyncBatchAnnotateFilesRequest request)

public final OperationFuture<AsyncBatchAnnotateFilesResponse,OperationMetadata> asyncBatchAnnotateFilesAsync(AsyncBatchAnnotateFilesRequest request)

Run asynchronous image detection and annotation for a list of generic files, such as PDF files, which may contain multiple pages and multiple images per page. Progress and results can be retrieved through the google.longrunning.Operations interface. Operation.metadata contains OperationMetadata (metadata). Operation.response contains AsyncBatchAnnotateFilesResponse (results).

Sample code:


 try (ImageAnnotatorClient imageAnnotatorClient = ImageAnnotatorClient.create()) {
   AsyncBatchAnnotateFilesRequest request =
       AsyncBatchAnnotateFilesRequest.newBuilder()
           .addAllRequests(new ArrayList<AsyncAnnotateFileRequest>())
           .setParent("parent-995424086")
           .build();
   AsyncBatchAnnotateFilesResponse response =
       imageAnnotatorClient.asyncBatchAnnotateFilesAsync(request).get();
 }

Parameter

Name	Description
request	`AsyncBatchAnnotateFilesRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
OperationFuture<AsyncBatchAnnotateFilesResponse,OperationMetadata>

asyncBatchAnnotateFilesAsync(List<AsyncAnnotateFileRequest> requests)

public final OperationFuture<AsyncBatchAnnotateFilesResponse,OperationMetadata> asyncBatchAnnotateFilesAsync(List<AsyncAnnotateFileRequest> requests)

Sample code:


 try (ImageAnnotatorClient imageAnnotatorClient = ImageAnnotatorClient.create()) {
   List<AsyncAnnotateFileRequest> requests = new ArrayList<>();
   AsyncBatchAnnotateFilesResponse response =
       imageAnnotatorClient.asyncBatchAnnotateFilesAsync(requests).get();
 }

Parameter

Name	Description
requests	`List<AsyncAnnotateFileRequest>` Required. Individual async file annotation requests for this batch.

Returns

Type	Description
OperationFuture<AsyncBatchAnnotateFilesResponse,OperationMetadata>

asyncBatchAnnotateFilesCallable()

public final UnaryCallable<AsyncBatchAnnotateFilesRequest,Operation> asyncBatchAnnotateFilesCallable()

Sample code:


 try (ImageAnnotatorClient imageAnnotatorClient = ImageAnnotatorClient.create()) {
   AsyncBatchAnnotateFilesRequest request =
       AsyncBatchAnnotateFilesRequest.newBuilder()
           .addAllRequests(new ArrayList<AsyncAnnotateFileRequest>())
           .setParent("parent-995424086")
           .build();
   ApiFuture<Operation> future =
       imageAnnotatorClient.asyncBatchAnnotateFilesCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns

Type	Description
UnaryCallable<AsyncBatchAnnotateFilesRequest,Operation>

asyncBatchAnnotateFilesOperationCallable()

public final OperationCallable<AsyncBatchAnnotateFilesRequest,AsyncBatchAnnotateFilesResponse,OperationMetadata> asyncBatchAnnotateFilesOperationCallable()

Sample code:


 try (ImageAnnotatorClient imageAnnotatorClient = ImageAnnotatorClient.create()) {
   AsyncBatchAnnotateFilesRequest request =
       AsyncBatchAnnotateFilesRequest.newBuilder()
           .addAllRequests(new ArrayList<AsyncAnnotateFileRequest>())
           .setParent("parent-995424086")
           .build();
   OperationFuture<AsyncBatchAnnotateFilesResponse, OperationMetadata> future =
       imageAnnotatorClient.asyncBatchAnnotateFilesOperationCallable().futureCall(request);
   // Do something.
   AsyncBatchAnnotateFilesResponse response = future.get();
 }

Returns

Type	Description
OperationCallable<AsyncBatchAnnotateFilesRequest,AsyncBatchAnnotateFilesResponse,OperationMetadata>

asyncBatchAnnotateImagesAsync(AsyncBatchAnnotateImagesRequest request)

public final OperationFuture<AsyncBatchAnnotateImagesResponse,OperationMetadata> asyncBatchAnnotateImagesAsync(AsyncBatchAnnotateImagesRequest request)

Run asynchronous image detection and annotation for a list of images.

Progress and results can be retrieved through the google.longrunning.Operations interface. Operation.metadata contains OperationMetadata (metadata). Operation.response contains AsyncBatchAnnotateImagesResponse (results).

This service will write image annotation outputs to json files in customer GCS bucket, each json file containing BatchAnnotateImagesResponse proto.

Sample code:


 try (ImageAnnotatorClient imageAnnotatorClient = ImageAnnotatorClient.create()) {
   AsyncBatchAnnotateImagesRequest request =
       AsyncBatchAnnotateImagesRequest.newBuilder()
           .addAllRequests(new ArrayList<AnnotateImageRequest>())
           .setOutputConfig(OutputConfig.newBuilder().build())
           .setParent("parent-995424086")
           .build();
   AsyncBatchAnnotateImagesResponse response =
       imageAnnotatorClient.asyncBatchAnnotateImagesAsync(request).get();
 }

Parameter

Name	Description
request	`AsyncBatchAnnotateImagesRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
OperationFuture<AsyncBatchAnnotateImagesResponse,OperationMetadata>

asyncBatchAnnotateImagesAsync(List<AnnotateImageRequest> requests, OutputConfig outputConfig)

public final OperationFuture<AsyncBatchAnnotateImagesResponse,OperationMetadata> asyncBatchAnnotateImagesAsync(List<AnnotateImageRequest> requests, OutputConfig outputConfig)

Run asynchronous image detection and annotation for a list of images.

This service will write image annotation outputs to json files in customer GCS bucket, each json file containing BatchAnnotateImagesResponse proto.

Sample code:


 try (ImageAnnotatorClient imageAnnotatorClient = ImageAnnotatorClient.create()) {
   List<AnnotateImageRequest> requests = new ArrayList<>();
   OutputConfig outputConfig = OutputConfig.newBuilder().build();
   AsyncBatchAnnotateImagesResponse response =
       imageAnnotatorClient.asyncBatchAnnotateImagesAsync(requests, outputConfig).get();
 }

Parameters

Name	Description
requests	`List<AnnotateImageRequest>` Required. Individual image annotation requests for this batch.
outputConfig	`OutputConfig` Required. The desired output location and metadata (e.g. format).

Returns

Type	Description
OperationFuture<AsyncBatchAnnotateImagesResponse,OperationMetadata>

asyncBatchAnnotateImagesCallable()

public final UnaryCallable<AsyncBatchAnnotateImagesRequest,Operation> asyncBatchAnnotateImagesCallable()

Run asynchronous image detection and annotation for a list of images.

This service will write image annotation outputs to json files in customer GCS bucket, each json file containing BatchAnnotateImagesResponse proto.

Sample code:


 try (ImageAnnotatorClient imageAnnotatorClient = ImageAnnotatorClient.create()) {
   AsyncBatchAnnotateImagesRequest request =
       AsyncBatchAnnotateImagesRequest.newBuilder()
           .addAllRequests(new ArrayList<AnnotateImageRequest>())
           .setOutputConfig(OutputConfig.newBuilder().build())
           .setParent("parent-995424086")
           .build();
   ApiFuture<Operation> future =
       imageAnnotatorClient.asyncBatchAnnotateImagesCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns

Type	Description
UnaryCallable<AsyncBatchAnnotateImagesRequest,Operation>

asyncBatchAnnotateImagesOperationCallable()

public final OperationCallable<AsyncBatchAnnotateImagesRequest,AsyncBatchAnnotateImagesResponse,OperationMetadata> asyncBatchAnnotateImagesOperationCallable()

Run asynchronous image detection and annotation for a list of images.

This service will write image annotation outputs to json files in customer GCS bucket, each json file containing BatchAnnotateImagesResponse proto.

Sample code:


 try (ImageAnnotatorClient imageAnnotatorClient = ImageAnnotatorClient.create()) {
   AsyncBatchAnnotateImagesRequest request =
       AsyncBatchAnnotateImagesRequest.newBuilder()
           .addAllRequests(new ArrayList<AnnotateImageRequest>())
           .setOutputConfig(OutputConfig.newBuilder().build())
           .setParent("parent-995424086")
           .build();
   OperationFuture<AsyncBatchAnnotateImagesResponse, OperationMetadata> future =
       imageAnnotatorClient.asyncBatchAnnotateImagesOperationCallable().futureCall(request);
   // Do something.
   AsyncBatchAnnotateImagesResponse response = future.get();
 }

Returns

Type	Description
OperationCallable<AsyncBatchAnnotateImagesRequest,AsyncBatchAnnotateImagesResponse,OperationMetadata>

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)

Parameters

Name	Description
duration	`long`
unit	`TimeUnit`

Returns

Type	Description
boolean

Exceptions

Type	Description
InterruptedException

batchAnnotateFiles(BatchAnnotateFilesRequest request)

public final BatchAnnotateFilesResponse batchAnnotateFiles(BatchAnnotateFilesRequest request)

Service that performs image detection and annotation for a batch of files. Now only "application/pdf", "image/tiff" and "image/gif" are supported.

This service will extract at most 5 (customers can specify which 5 in AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each file provided and perform detection and annotation for each image extracted.

Sample code:


 try (ImageAnnotatorClient imageAnnotatorClient = ImageAnnotatorClient.create()) {
   BatchAnnotateFilesRequest request =
       BatchAnnotateFilesRequest.newBuilder()
           .addAllRequests(new ArrayList<AnnotateFileRequest>())
           .setParent("parent-995424086")
           .build();
   BatchAnnotateFilesResponse response = imageAnnotatorClient.batchAnnotateFiles(request);
 }

Parameter

Name	Description
request	`BatchAnnotateFilesRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
BatchAnnotateFilesResponse

batchAnnotateFiles(List<AnnotateFileRequest> requests)

public final BatchAnnotateFilesResponse batchAnnotateFiles(List<AnnotateFileRequest> requests)

Service that performs image detection and annotation for a batch of files. Now only "application/pdf", "image/tiff" and "image/gif" are supported.

Sample code:


 try (ImageAnnotatorClient imageAnnotatorClient = ImageAnnotatorClient.create()) {
   List<AnnotateFileRequest> requests = new ArrayList<>();
   BatchAnnotateFilesResponse response = imageAnnotatorClient.batchAnnotateFiles(requests);
 }

Parameter

Name	Description
requests	`List<AnnotateFileRequest>` Required. The list of file annotation requests. Right now we support only one AnnotateFileRequest in BatchAnnotateFilesRequest.

Returns

Type	Description
BatchAnnotateFilesResponse

batchAnnotateFilesCallable()

public final UnaryCallable<BatchAnnotateFilesRequest,BatchAnnotateFilesResponse> batchAnnotateFilesCallable()

Service that performs image detection and annotation for a batch of files. Now only "application/pdf", "image/tiff" and "image/gif" are supported.

Sample code:


 try (ImageAnnotatorClient imageAnnotatorClient = ImageAnnotatorClient.create()) {
   BatchAnnotateFilesRequest request =
       BatchAnnotateFilesRequest.newBuilder()
           .addAllRequests(new ArrayList<AnnotateFileRequest>())
           .setParent("parent-995424086")
           .build();
   ApiFuture<BatchAnnotateFilesResponse> future =
       imageAnnotatorClient.batchAnnotateFilesCallable().futureCall(request);
   // Do something.
   BatchAnnotateFilesResponse response = future.get();
 }

Returns

Type	Description
UnaryCallable<BatchAnnotateFilesRequest,BatchAnnotateFilesResponse>

batchAnnotateImages(BatchAnnotateImagesRequest request)

public final BatchAnnotateImagesResponse batchAnnotateImages(BatchAnnotateImagesRequest request)

Run image detection and annotation for a batch of images.

Sample code:


 try (ImageAnnotatorClient imageAnnotatorClient = ImageAnnotatorClient.create()) {
   BatchAnnotateImagesRequest request =
       BatchAnnotateImagesRequest.newBuilder()
           .addAllRequests(new ArrayList<AnnotateImageRequest>())
           .setParent("parent-995424086")
           .build();
   BatchAnnotateImagesResponse response = imageAnnotatorClient.batchAnnotateImages(request);
 }

Parameter

Name	Description
request	`BatchAnnotateImagesRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
BatchAnnotateImagesResponse

batchAnnotateImages(List<AnnotateImageRequest> requests)

public final BatchAnnotateImagesResponse batchAnnotateImages(List<AnnotateImageRequest> requests)

Run image detection and annotation for a batch of images.

Sample code:


 try (ImageAnnotatorClient imageAnnotatorClient = ImageAnnotatorClient.create()) {
   List<AnnotateImageRequest> requests = new ArrayList<>();
   BatchAnnotateImagesResponse response = imageAnnotatorClient.batchAnnotateImages(requests);
 }

Parameter

Name	Description
requests	`List<AnnotateImageRequest>` Required. Individual image annotation requests for this batch.

Returns

Type	Description
BatchAnnotateImagesResponse

batchAnnotateImagesCallable()

public final UnaryCallable<BatchAnnotateImagesRequest,BatchAnnotateImagesResponse> batchAnnotateImagesCallable()

Run image detection and annotation for a batch of images.

Sample code:


 try (ImageAnnotatorClient imageAnnotatorClient = ImageAnnotatorClient.create()) {
   BatchAnnotateImagesRequest request =
       BatchAnnotateImagesRequest.newBuilder()
           .addAllRequests(new ArrayList<AnnotateImageRequest>())
           .setParent("parent-995424086")
           .build();
   ApiFuture<BatchAnnotateImagesResponse> future =
       imageAnnotatorClient.batchAnnotateImagesCallable().futureCall(request);
   // Do something.
   BatchAnnotateImagesResponse response = future.get();
 }

Returns

Type	Description
UnaryCallable<BatchAnnotateImagesRequest,BatchAnnotateImagesResponse>

close()

public final void close()

getOperationsClient()

public final OperationsClient getOperationsClient()

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

Returns

Type	Description
OperationsClient

getSettings()

public final ImageAnnotatorSettings getSettings()

Returns

Type	Description
ImageAnnotatorSettings

getStub()

public ImageAnnotatorStub getStub()

Returns

Type	Description
ImageAnnotatorStub

isShutdown()

public boolean isShutdown()

Returns

Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns

Type	Description
boolean

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()