ImageAnnotatorClient (Google Cloud 0.89.0-alpha API)

java.lang.Object
- com.google.cloud.vision.v1p3beta1.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

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`OperationFuture<com.google.cloud.vision.v1p3beta1.AsyncBatchAnnotateFilesResponse,com.google.cloud.vision.v1p3beta1.OperationMetadata>`	`asyncBatchAnnotateFilesAsync(com.google.cloud.vision.v1p3beta1.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.
`OperationFuture<com.google.cloud.vision.v1p3beta1.AsyncBatchAnnotateFilesResponse,com.google.cloud.vision.v1p3beta1.OperationMetadata>`	`asyncBatchAnnotateFilesAsync(List<com.google.cloud.vision.v1p3beta1.AsyncAnnotateFileRequest> requests)` 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.
`UnaryCallable<com.google.cloud.vision.v1p3beta1.AsyncBatchAnnotateFilesRequest,Operation>`	`asyncBatchAnnotateFilesCallable()` 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.
`OperationCallable<com.google.cloud.vision.v1p3beta1.AsyncBatchAnnotateFilesRequest,com.google.cloud.vision.v1p3beta1.AsyncBatchAnnotateFilesResponse,com.google.cloud.vision.v1p3beta1.OperationMetadata>`	`asyncBatchAnnotateFilesOperationCallable()` 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.
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`com.google.cloud.vision.v1p3beta1.BatchAnnotateImagesResponse`	`batchAnnotateImages(com.google.cloud.vision.v1p3beta1.BatchAnnotateImagesRequest request)` Run image detection and annotation for a batch of images.
`com.google.cloud.vision.v1p3beta1.BatchAnnotateImagesResponse`	`batchAnnotateImages(List<com.google.cloud.vision.v1p3beta1.AnnotateImageRequest> requests)` Run image detection and annotation for a batch of images.
`UnaryCallable<com.google.cloud.vision.v1p3beta1.BatchAnnotateImagesRequest,com.google.cloud.vision.v1p3beta1.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.
`OperationsClient`	`getOperationsClient()` Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
`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()

getOperationsClient

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
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.

batchAnnotateImages

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

asyncBatchAnnotateFilesAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final OperationFuture<com.google.cloud.vision.v1p3beta1.AsyncBatchAnnotateFilesResponse,com.google.cloud.vision.v1p3beta1.OperationMetadata> asyncBatchAnnotateFilesAsync(List<com.google.cloud.vision.v1p3beta1.AsyncAnnotateFileRequest> requests)

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()) {
   List<AsyncAnnotateFileRequest> requests = new ArrayList<>();
   AsyncBatchAnnotateFilesResponse response = imageAnnotatorClient.asyncBatchAnnotateFilesAsync(requests).get();
 }

Parameters:: requests - Individual async file annotation requests for this batch.
Throws:: ApiException - if the remote call fails

asyncBatchAnnotateFilesAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final OperationFuture<com.google.cloud.vision.v1p3beta1.AsyncBatchAnnotateFilesResponse,com.google.cloud.vision.v1p3beta1.OperationMetadata> asyncBatchAnnotateFilesAsync(com.google.cloud.vision.v1p3beta1.AsyncBatchAnnotateFilesRequest request)

Sample code:


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

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

asyncBatchAnnotateFilesOperationCallable

@BetaApi(value="The surface for use by generated code is not stable yet and may change in the future.")
public final OperationCallable<com.google.cloud.vision.v1p3beta1.AsyncBatchAnnotateFilesRequest,com.google.cloud.vision.v1p3beta1.AsyncBatchAnnotateFilesResponse,com.google.cloud.vision.v1p3beta1.OperationMetadata> asyncBatchAnnotateFilesOperationCallable()

Sample code:


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

asyncBatchAnnotateFilesCallable

public final UnaryCallable<com.google.cloud.vision.v1p3beta1.AsyncBatchAnnotateFilesRequest,Operation> asyncBatchAnnotateFilesCallable()

Sample code:


 try (ImageAnnotatorClient imageAnnotatorClient = ImageAnnotatorClient.create()) {
   List<AsyncAnnotateFileRequest> requests = new ArrayList<>();
   AsyncBatchAnnotateFilesRequest request = AsyncBatchAnnotateFilesRequest.newBuilder()
     .addAllRequests(requests)
     .build();
   ApiFuture<Operation> future = imageAnnotatorClient.asyncBatchAnnotateFilesCallable().futureCall(request);
   // Do something
   Operation 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

Class ImageAnnotatorClient

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ImageAnnotatorClient

ImageAnnotatorClient

Method Detail

create

create

create

getSettings

getStub

getOperationsClient

batchAnnotateImages

batchAnnotateImages

batchAnnotateImagesCallable

asyncBatchAnnotateFilesAsync

asyncBatchAnnotateFilesAsync

asyncBatchAnnotateFilesOperationCallable

asyncBatchAnnotateFilesCallable

close

shutdown

isShutdown

isTerminated

shutdownNow

awaitTermination