@Generated(value="by gapic-generator") @BetaApi public class ImageAnnotatorClient extends Object implements BackgroundResource
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:
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);
Modifier | Constructor and Description |
---|---|
protected |
ImageAnnotatorClient(ImageAnnotatorSettings settings)
Constructs an instance of ImageAnnotatorClient, using the given settings.
|
protected |
ImageAnnotatorClient(ImageAnnotatorStub stub) |
Modifier and Type | Method and Description |
---|---|
OperationFuture<com.google.cloud.vision.v1p2beta1.AsyncBatchAnnotateFilesResponse,com.google.cloud.vision.v1p2beta1.OperationMetadata> |
asyncBatchAnnotateFilesAsync(com.google.cloud.vision.v1p2beta1.AsyncBatchAnnotateFilesRequest request)
Run async image detection and annotation for a list of generic files (e.g.
|
OperationFuture<com.google.cloud.vision.v1p2beta1.AsyncBatchAnnotateFilesResponse,com.google.cloud.vision.v1p2beta1.OperationMetadata> |
asyncBatchAnnotateFilesAsync(List<com.google.cloud.vision.v1p2beta1.AsyncAnnotateFileRequest> requests)
Run async image detection and annotation for a list of generic files (e.g.
|
UnaryCallable<com.google.cloud.vision.v1p2beta1.AsyncBatchAnnotateFilesRequest,Operation> |
asyncBatchAnnotateFilesCallable()
Run async image detection and annotation for a list of generic files (e.g.
|
OperationCallable<com.google.cloud.vision.v1p2beta1.AsyncBatchAnnotateFilesRequest,com.google.cloud.vision.v1p2beta1.AsyncBatchAnnotateFilesResponse,com.google.cloud.vision.v1p2beta1.OperationMetadata> |
asyncBatchAnnotateFilesOperationCallable()
Run async image detection and annotation for a list of generic files (e.g.
|
boolean |
awaitTermination(long duration,
TimeUnit unit) |
com.google.cloud.vision.v1p2beta1.BatchAnnotateImagesResponse |
batchAnnotateImages(com.google.cloud.vision.v1p2beta1.BatchAnnotateImagesRequest request)
Run image detection and annotation for a batch of images.
|
com.google.cloud.vision.v1p2beta1.BatchAnnotateImagesResponse |
batchAnnotateImages(List<com.google.cloud.vision.v1p2beta1.AnnotateImageRequest> requests)
Run image detection and annotation for a batch of images.
|
UnaryCallable<com.google.cloud.vision.v1p2beta1.BatchAnnotateImagesRequest,com.google.cloud.vision.v1p2beta1.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() |
protected ImageAnnotatorClient(ImageAnnotatorSettings settings) throws IOException
IOException
@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future") protected ImageAnnotatorClient(ImageAnnotatorStub stub)
public static final ImageAnnotatorClient create() throws IOException
IOException
public static final ImageAnnotatorClient create(ImageAnnotatorSettings settings) throws IOException
IOException
@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future") public static final ImageAnnotatorClient create(ImageAnnotatorStub stub)
public final ImageAnnotatorSettings getSettings()
@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future") public ImageAnnotatorStub getStub()
@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.") public final OperationsClient getOperationsClient()
public final com.google.cloud.vision.v1p2beta1.BatchAnnotateImagesResponse batchAnnotateImages(List<com.google.cloud.vision.v1p2beta1.AnnotateImageRequest> requests)
Sample code:
try (ImageAnnotatorClient imageAnnotatorClient = ImageAnnotatorClient.create()) {
List<AnnotateImageRequest> requests = new ArrayList<>();
BatchAnnotateImagesResponse response = imageAnnotatorClient.batchAnnotateImages(requests);
}
requests
- Individual image annotation requests for this batch.ApiException
- if the remote call failspublic final com.google.cloud.vision.v1p2beta1.BatchAnnotateImagesResponse batchAnnotateImages(com.google.cloud.vision.v1p2beta1.BatchAnnotateImagesRequest request)
Sample code:
try (ImageAnnotatorClient imageAnnotatorClient = ImageAnnotatorClient.create()) {
List<AnnotateImageRequest> requests = new ArrayList<>();
BatchAnnotateImagesRequest request = BatchAnnotateImagesRequest.newBuilder()
.addAllRequests(requests)
.build();
BatchAnnotateImagesResponse response = imageAnnotatorClient.batchAnnotateImages(request);
}
request
- The request object containing all of the parameters for the API call.ApiException
- if the remote call failspublic final UnaryCallable<com.google.cloud.vision.v1p2beta1.BatchAnnotateImagesRequest,com.google.cloud.vision.v1p2beta1.BatchAnnotateImagesResponse> batchAnnotateImagesCallable()
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();
}
@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.v1p2beta1.AsyncBatchAnnotateFilesResponse,com.google.cloud.vision.v1p2beta1.OperationMetadata> asyncBatchAnnotateFilesAsync(List<com.google.cloud.vision.v1p2beta1.AsyncAnnotateFileRequest> requests)
Sample code:
try (ImageAnnotatorClient imageAnnotatorClient = ImageAnnotatorClient.create()) {
List<AsyncAnnotateFileRequest> requests = new ArrayList<>();
AsyncBatchAnnotateFilesResponse response = imageAnnotatorClient.asyncBatchAnnotateFilesAsync(requests).get();
}
requests
- Individual async file annotation requests for this batch.ApiException
- if the remote call fails@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.v1p2beta1.AsyncBatchAnnotateFilesResponse,com.google.cloud.vision.v1p2beta1.OperationMetadata> asyncBatchAnnotateFilesAsync(com.google.cloud.vision.v1p2beta1.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();
}
request
- The request object containing all of the parameters for the API call.ApiException
- if the remote call fails@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.v1p2beta1.AsyncBatchAnnotateFilesRequest,com.google.cloud.vision.v1p2beta1.AsyncBatchAnnotateFilesResponse,com.google.cloud.vision.v1p2beta1.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();
}
public final UnaryCallable<com.google.cloud.vision.v1p2beta1.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();
}
public final void close()
close
in interface AutoCloseable
public void shutdown()
shutdown
in interface BackgroundResource
public boolean isShutdown()
isShutdown
in interface BackgroundResource
public boolean isTerminated()
isTerminated
in interface BackgroundResource
public void shutdownNow()
shutdownNow
in interface BackgroundResource
public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException
awaitTermination
in interface BackgroundResource
InterruptedException
Copyright © 2019 Google LLC. All rights reserved.