com.google.cloud.vision.v1p1beta1

Class ImageAnnotatorClient

java.lang.Object

com.google.cloud.vision.v1p1beta1.ImageAnnotatorClient

All Implemented Interfaces:

BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator")
 @BetaApi
public class ImageAnnotatorClient
extends Object
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:

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:

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);
 
 

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
com.google.cloud.vision.v1p1beta1.BatchAnnotateImagesResponse	batchAnnotateImages(com.google.cloud.vision.v1p1beta1.BatchAnnotateImagesRequest request) Run image detection and annotation for a batch of images.
com.google.cloud.vision.v1p1beta1.BatchAnnotateImagesResponse	batchAnnotateImages(List<com.google.cloud.vision.v1p1beta1.AnnotateImageRequest> requests) Run image detection and annotation for a batch of images.
UnaryCallable<com.google.cloud.vision.v1p1beta1.BatchAnnotateImagesRequest,com.google.cloud.vision.v1p1beta1.BatchAnnotateImagesResponse>	batchAnnotateImagesCallable() Run image detection and annotation for a batch of images.
void	close()
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.
static ImageAnnotatorClient	create(ImageAnnotatorStub stub) Constructs an instance of ImageAnnotatorClient, using the given stub for making calls.
ImageAnnotatorSettings	getSettings()
ImageAnnotatorStub	getStub()
boolean	isShutdown()
boolean	isTerminated()
void	shutdown()
void	shutdownNow()

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 is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Throws:

IOException

ImageAnnotatorClient

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
protected ImageAnnotatorClient(ImageAnnotatorStub stub)

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

create

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
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 to use ImageAnnotatorSettings}.

getSettings

public final ImageAnnotatorSettings getSettings()

getStub

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public ImageAnnotatorStub getStub()

batchAnnotateImages

public final com.google.cloud.vision.v1p1beta1.BatchAnnotateImagesResponse batchAnnotateImages(List<com.google.cloud.vision.v1p1beta1.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:

ApiException - if the remote call fails

batchAnnotateImages

public final com.google.cloud.vision.v1p1beta1.BatchAnnotateImagesResponse batchAnnotateImages(com.google.cloud.vision.v1p1beta1.BatchAnnotateImagesRequest request)

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();
   BatchAnnotateImagesResponse response = imageAnnotatorClient.batchAnnotateImages(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

ApiException - if the remote call fails

batchAnnotateImagesCallable

public final UnaryCallable<com.google.cloud.vision.v1p1beta1.BatchAnnotateImagesRequest,com.google.cloud.vision.v1p1beta1.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()

Specified by:

close in interface AutoCloseable

shutdown

public void shutdown()

Specified by:

shutdown in interface BackgroundResource

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface BackgroundResource

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface BackgroundResource

shutdownNow

public void shutdownNow()

Specified by:

shutdownNow in interface BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:

awaitTermination in interface BackgroundResource

Throws:

InterruptedException