com.google.cloud.vision.v1

Class ImageAnnotatorClient

java.lang.Object

com.google.cloud.vision.v1.ImageAnnotatorClient

All Implemented Interfaces:

AutoCloseable

@Generated(value="by GAPIC")
 @BetaApi
public class ImageAnnotatorClient
extends Object
implements AutoCloseable

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:

1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of ImageAnnotatorSettings to create(). For example:

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ImageAnnotatorClient(ImageAnnotatorSettings settings) Constructs an instance of ImageAnnotatorClient, using the given settings.

Method Summary

Modifier and Type	Method and Description
com.google.cloud.vision.v1.BatchAnnotateImagesResponse	batchAnnotateImages(List<com.google.cloud.vision.v1.AnnotateImageRequest> requests) Run image detection and annotation for a batch of images.
com.google.api.gax.grpc.UnaryCallable<com.google.cloud.vision.v1.BatchAnnotateImagesRequest,com.google.cloud.vision.v1.BatchAnnotateImagesResponse>	batchAnnotateImagesCallable() Run image detection and annotation for a batch of images.
void	close() Initiates an orderly shutdown in which preexisting calls continue but new calls are immediately cancelled.
static ImageAnnotatorClient	create() Constructs an instance of ImageAnnotatorClient with default settings.
static ImageAnnotatorClient	create(ImageAnnotatorSettings settings) Constructs an instance of ImageAnnotatorClient, using the given settings.
ImageAnnotatorSettings	getSettings()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ImageAnnotatorClient

protected ImageAnnotatorClient(ImageAnnotatorSettings settings)
                        throws IOException

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

Throws:

IOException

Method Detail

create

public static final ImageAnnotatorClient create()
                                         throws IOException

Constructs an instance of ImageAnnotatorClient with default settings.

Throws:

IOException

create

public static final ImageAnnotatorClient create(ImageAnnotatorSettings settings)
                                         throws IOException

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.

Throws:

IOException

getSettings

public final ImageAnnotatorSettings getSettings()

batchAnnotateImages

public final com.google.cloud.vision.v1.BatchAnnotateImagesResponse batchAnnotateImages(List<com.google.cloud.vision.v1.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);
 }
 

Parameters:

requests - Individual image annotation requests for this batch.

Throws:

com.google.api.gax.grpc.ApiException - if the remote call fails

batchAnnotateImagesCallable

public final com.google.api.gax.grpc.UnaryCallable<com.google.cloud.vision.v1.BatchAnnotateImagesRequest,com.google.cloud.vision.v1.BatchAnnotateImagesResponse> batchAnnotateImagesCallable()

Run image detection and annotation for a batch of images.

Sample code:

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

close

public final void close()
                 throws Exception

Initiates an orderly shutdown in which preexisting calls continue but new calls are immediately cancelled.

Specified by:

close in interface AutoCloseable

Throws:

Exception