com.google.cloud.vision.v1p2beta1.ImageAnnotatorClient Maven / Gradle / Ivy
Show all versions of google-cloud-vision Show documentation
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.cloud.vision.v1p2beta1;
import com.google.api.core.BetaApi;
import com.google.api.gax.core.BackgroundResource;
import com.google.api.gax.httpjson.longrunning.OperationsClient;
import com.google.api.gax.longrunning.OperationFuture;
import com.google.api.gax.rpc.OperationCallable;
import com.google.api.gax.rpc.UnaryCallable;
import com.google.cloud.vision.v1p2beta1.stub.ImageAnnotatorStub;
import com.google.cloud.vision.v1p2beta1.stub.ImageAnnotatorStubSettings;
import com.google.longrunning.Operation;
import java.io.IOException;
import java.util.List;
import java.util.concurrent.TimeUnit;
import javax.annotation.Generated;
// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
* 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:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (ImageAnnotatorClient imageAnnotatorClient = ImageAnnotatorClient.create()) {
* List 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().
*
*
* Methods
*
* Method
* Description
* Method Variants
*
*
* BatchAnnotateImages
Run image detection and annotation for a batch of images.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* batchAnnotateImages(List<AnnotateImageRequest> requests)
*
batchAnnotateImages(BatchAnnotateImagesRequest request)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* batchAnnotateImagesCallable()
*
*
*
*
* AsyncBatchAnnotateFiles
Run async image detection and annotation for a list of generic files (e.g. PDF) 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).
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* asyncBatchAnnotateFilesAsync(List<AsyncAnnotateFileRequest> requests)
*
asyncBatchAnnotateFilesAsync(AsyncBatchAnnotateFilesRequest request)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* asyncBatchAnnotateFilesOperationCallable()
*
asyncBatchAnnotateFilesCallable()
*
*
*
*
*
* 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:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* ImageAnnotatorSettings imageAnnotatorSettings =
* ImageAnnotatorSettings.newBuilder()
* .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
* .build();
* ImageAnnotatorClient imageAnnotatorClient = ImageAnnotatorClient.create(imageAnnotatorSettings);
* }
*
* To customize the endpoint:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* ImageAnnotatorSettings imageAnnotatorSettings =
* ImageAnnotatorSettings.newBuilder().setEndpoint(myEndpoint).build();
* ImageAnnotatorClient imageAnnotatorClient = ImageAnnotatorClient.create(imageAnnotatorSettings);
* }
*
* To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over
* the wire:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* ImageAnnotatorSettings imageAnnotatorSettings =
* ImageAnnotatorSettings.newHttpJsonBuilder().build();
* ImageAnnotatorClient imageAnnotatorClient = ImageAnnotatorClient.create(imageAnnotatorSettings);
* }
*
* Please refer to the GitHub repository's samples for more quickstart code snippets.
*/
@BetaApi
@Generated("by gapic-generator-java")
public class ImageAnnotatorClient implements BackgroundResource {
private final ImageAnnotatorSettings settings;
private final ImageAnnotatorStub stub;
private final OperationsClient httpJsonOperationsClient;
private final com.google.longrunning.OperationsClient operationsClient;
/** Constructs an instance of ImageAnnotatorClient with default settings. */
public static final ImageAnnotatorClient create() throws IOException {
return create(ImageAnnotatorSettings.newBuilder().build());
}
/**
* 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.
*/
public static final ImageAnnotatorClient create(ImageAnnotatorSettings settings)
throws IOException {
return new ImageAnnotatorClient(settings);
}
/**
* Constructs an instance of ImageAnnotatorClient, using the given stub for making calls. This is
* for advanced usage - prefer using create(ImageAnnotatorSettings).
*/
public static final ImageAnnotatorClient create(ImageAnnotatorStub stub) {
return new ImageAnnotatorClient(stub);
}
/**
* 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.
*/
protected ImageAnnotatorClient(ImageAnnotatorSettings settings) throws IOException {
this.settings = settings;
this.stub = ((ImageAnnotatorStubSettings) settings.getStubSettings()).createStub();
this.operationsClient =
com.google.longrunning.OperationsClient.create(this.stub.getOperationsStub());
this.httpJsonOperationsClient = OperationsClient.create(this.stub.getHttpJsonOperationsStub());
}
protected ImageAnnotatorClient(ImageAnnotatorStub stub) {
this.settings = null;
this.stub = stub;
this.operationsClient =
com.google.longrunning.OperationsClient.create(this.stub.getOperationsStub());
this.httpJsonOperationsClient = OperationsClient.create(this.stub.getHttpJsonOperationsStub());
}
public final ImageAnnotatorSettings getSettings() {
return settings;
}
public ImageAnnotatorStub getStub() {
return stub;
}
/**
* Returns the OperationsClient that can be used to query the status of a long-running operation
* returned by another API method call.
*/
public final com.google.longrunning.OperationsClient getOperationsClient() {
return operationsClient;
}
/**
* Returns the OperationsClient that can be used to query the status of a long-running operation
* returned by another API method call.
*/
@BetaApi
public final OperationsClient getHttpJsonOperationsClient() {
return httpJsonOperationsClient;
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Run image detection and annotation for a batch of images.
*
*
Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (ImageAnnotatorClient imageAnnotatorClient = ImageAnnotatorClient.create()) {
* List requests = new ArrayList<>();
* BatchAnnotateImagesResponse response = imageAnnotatorClient.batchAnnotateImages(requests);
* }
* }
*
* @param requests Required. Individual image annotation requests for this batch.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final BatchAnnotateImagesResponse batchAnnotateImages(
List requests) {
BatchAnnotateImagesRequest request =
BatchAnnotateImagesRequest.newBuilder().addAllRequests(requests).build();
return batchAnnotateImages(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Run image detection and annotation for a batch of images.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (ImageAnnotatorClient imageAnnotatorClient = ImageAnnotatorClient.create()) {
* BatchAnnotateImagesRequest request =
* BatchAnnotateImagesRequest.newBuilder()
* .addAllRequests(new ArrayList())
* .build();
* BatchAnnotateImagesResponse response = imageAnnotatorClient.batchAnnotateImages(request);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final BatchAnnotateImagesResponse batchAnnotateImages(BatchAnnotateImagesRequest request) {
return batchAnnotateImagesCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Run image detection and annotation for a batch of images.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (ImageAnnotatorClient imageAnnotatorClient = ImageAnnotatorClient.create()) {
* BatchAnnotateImagesRequest request =
* BatchAnnotateImagesRequest.newBuilder()
* .addAllRequests(new ArrayList())
* .build();
* ApiFuture future =
* imageAnnotatorClient.batchAnnotateImagesCallable().futureCall(request);
* // Do something.
* BatchAnnotateImagesResponse response = future.get();
* }
* }
*/
public final UnaryCallable
batchAnnotateImagesCallable() {
return stub.batchAnnotateImagesCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Run async image detection and annotation for a list of generic files (e.g. PDF) 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:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (ImageAnnotatorClient imageAnnotatorClient = ImageAnnotatorClient.create()) {
* List requests = new ArrayList<>();
* AsyncBatchAnnotateFilesResponse response =
* imageAnnotatorClient.asyncBatchAnnotateFilesAsync(requests).get();
* }
* }
*
* @param requests Required. Individual async file annotation requests for this batch.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture
asyncBatchAnnotateFilesAsync(List requests) {
AsyncBatchAnnotateFilesRequest request =
AsyncBatchAnnotateFilesRequest.newBuilder().addAllRequests(requests).build();
return asyncBatchAnnotateFilesAsync(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Run async image detection and annotation for a list of generic files (e.g. PDF) 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:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (ImageAnnotatorClient imageAnnotatorClient = ImageAnnotatorClient.create()) {
* AsyncBatchAnnotateFilesRequest request =
* AsyncBatchAnnotateFilesRequest.newBuilder()
* .addAllRequests(new ArrayList())
* .build();
* AsyncBatchAnnotateFilesResponse response =
* imageAnnotatorClient.asyncBatchAnnotateFilesAsync(request).get();
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture
asyncBatchAnnotateFilesAsync(AsyncBatchAnnotateFilesRequest request) {
return asyncBatchAnnotateFilesOperationCallable().futureCall(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Run async image detection and annotation for a list of generic files (e.g. PDF) 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:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (ImageAnnotatorClient imageAnnotatorClient = ImageAnnotatorClient.create()) {
* AsyncBatchAnnotateFilesRequest request =
* AsyncBatchAnnotateFilesRequest.newBuilder()
* .addAllRequests(new ArrayList())
* .build();
* OperationFuture future =
* imageAnnotatorClient.asyncBatchAnnotateFilesOperationCallable().futureCall(request);
* // Do something.
* AsyncBatchAnnotateFilesResponse response = future.get();
* }
* }
*/
public final OperationCallable<
AsyncBatchAnnotateFilesRequest, AsyncBatchAnnotateFilesResponse, OperationMetadata>
asyncBatchAnnotateFilesOperationCallable() {
return stub.asyncBatchAnnotateFilesOperationCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Run async image detection and annotation for a list of generic files (e.g. PDF) 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:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (ImageAnnotatorClient imageAnnotatorClient = ImageAnnotatorClient.create()) {
* AsyncBatchAnnotateFilesRequest request =
* AsyncBatchAnnotateFilesRequest.newBuilder()
* .addAllRequests(new ArrayList())
* .build();
* ApiFuture future =
* imageAnnotatorClient.asyncBatchAnnotateFilesCallable().futureCall(request);
* // Do something.
* Operation response = future.get();
* }
* }
*/
public final UnaryCallable
asyncBatchAnnotateFilesCallable() {
return stub.asyncBatchAnnotateFilesCallable();
}
@Override
public final void close() {
stub.close();
}
@Override
public void shutdown() {
stub.shutdown();
}
@Override
public boolean isShutdown() {
return stub.isShutdown();
}
@Override
public boolean isTerminated() {
return stub.isTerminated();
}
@Override
public void shutdownNow() {
stub.shutdownNow();
}
@Override
public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException {
return stub.awaitTermination(duration, unit);
}
}