Package com.google.cloud.vision.v1p1beta1

The interfaces provided are listed below, along with usage samples.

ImageAnnotatorClient

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.

Sample for ImageAnnotatorClient:


 try (ImageAnnotatorClient imageAnnotatorClient = ImageAnnotatorClient.create()) {
   List<AnnotateImageRequest> requests = new ArrayList<>();
   BatchAnnotateImagesResponse response = imageAnnotatorClient.batchAnnotateImages(requests);
 }
 

Classes

AnnotateImageRequest

Request for performing Google Cloud Vision API tasks over a user-provided image, with user-requested features.

Protobuf type google.cloud.vision.v1p1beta1.AnnotateImageRequest

AnnotateImageRequest.Builder

Request for performing Google Cloud Vision API tasks over a user-provided image, with user-requested features.

Protobuf type google.cloud.vision.v1p1beta1.AnnotateImageRequest

AnnotateImageResponse

Response to an image annotation request.

Protobuf type google.cloud.vision.v1p1beta1.AnnotateImageResponse

AnnotateImageResponse.Builder

Response to an image annotation request.

Protobuf type google.cloud.vision.v1p1beta1.AnnotateImageResponse

BatchAnnotateImagesRequest

Multiple image annotation requests are batched into a single service call.

Protobuf type google.cloud.vision.v1p1beta1.BatchAnnotateImagesRequest

BatchAnnotateImagesRequest.Builder

Multiple image annotation requests are batched into a single service call.

Protobuf type google.cloud.vision.v1p1beta1.BatchAnnotateImagesRequest

BatchAnnotateImagesResponse

Response to a batch image annotation request.

Protobuf type google.cloud.vision.v1p1beta1.BatchAnnotateImagesResponse

BatchAnnotateImagesResponse.Builder

Response to a batch image annotation request.

Protobuf type google.cloud.vision.v1p1beta1.BatchAnnotateImagesResponse

Block

Logical element on the page.

Protobuf type google.cloud.vision.v1p1beta1.Block

Block.Builder

Logical element on the page.

Protobuf type google.cloud.vision.v1p1beta1.Block

BoundingPoly

A bounding polygon for the detected image annotation.

Protobuf type google.cloud.vision.v1p1beta1.BoundingPoly

BoundingPoly.Builder

A bounding polygon for the detected image annotation.

Protobuf type google.cloud.vision.v1p1beta1.BoundingPoly

ColorInfo

Color information consists of RGB channels, score, and the fraction of the image that the color occupies in the image.

Protobuf type google.cloud.vision.v1p1beta1.ColorInfo

ColorInfo.Builder

Color information consists of RGB channels, score, and the fraction of the image that the color occupies in the image.

Protobuf type google.cloud.vision.v1p1beta1.ColorInfo

CropHint

Single crop hint that is used to generate a new crop when serving an image.

Protobuf type google.cloud.vision.v1p1beta1.CropHint

CropHint.Builder

Single crop hint that is used to generate a new crop when serving an image.

Protobuf type google.cloud.vision.v1p1beta1.CropHint

CropHintsAnnotation

Set of crop hints that are used to generate new crops when serving images.

Protobuf type google.cloud.vision.v1p1beta1.CropHintsAnnotation

CropHintsAnnotation.Builder

Set of crop hints that are used to generate new crops when serving images.

Protobuf type google.cloud.vision.v1p1beta1.CropHintsAnnotation

CropHintsParams

Parameters for crop hints annotation request.

Protobuf type google.cloud.vision.v1p1beta1.CropHintsParams

CropHintsParams.Builder

Parameters for crop hints annotation request.

Protobuf type google.cloud.vision.v1p1beta1.CropHintsParams

DominantColorsAnnotation

Set of dominant colors and their corresponding scores.

Protobuf type google.cloud.vision.v1p1beta1.DominantColorsAnnotation

DominantColorsAnnotation.Builder

Set of dominant colors and their corresponding scores.

Protobuf type google.cloud.vision.v1p1beta1.DominantColorsAnnotation

EntityAnnotation

Set of detected entity features.

Protobuf type google.cloud.vision.v1p1beta1.EntityAnnotation

EntityAnnotation.Builder

Set of detected entity features.

Protobuf type google.cloud.vision.v1p1beta1.EntityAnnotation

FaceAnnotation

A face annotation object contains the results of face detection.

Protobuf type google.cloud.vision.v1p1beta1.FaceAnnotation

FaceAnnotation.Builder

A face annotation object contains the results of face detection.

Protobuf type google.cloud.vision.v1p1beta1.FaceAnnotation

FaceAnnotation.Landmark

A face-specific landmark (for example, a face feature).

Protobuf type google.cloud.vision.v1p1beta1.FaceAnnotation.Landmark

FaceAnnotation.Landmark.Builder

A face-specific landmark (for example, a face feature).

Protobuf type google.cloud.vision.v1p1beta1.FaceAnnotation.Landmark

Feature

Users describe the type of Google Cloud Vision API tasks to perform over images by using Features. Each Feature indicates a type of image detection task to perform. Features encode the Cloud Vision API vertical to operate on and the number of top-scoring results to return.

Protobuf type google.cloud.vision.v1p1beta1.Feature

Feature.Builder

Users describe the type of Google Cloud Vision API tasks to perform over images by using Features. Each Feature indicates a type of image detection task to perform. Features encode the Cloud Vision API vertical to operate on and the number of top-scoring results to return.

Protobuf type google.cloud.vision.v1p1beta1.Feature

GeometryProto

Image

Client image to perform Google Cloud Vision API tasks over.

Protobuf type google.cloud.vision.v1p1beta1.Image

Image.Builder

Client image to perform Google Cloud Vision API tasks over.

Protobuf type google.cloud.vision.v1p1beta1.Image

ImageAnnotatorClient

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

Please refer to the GitHub repository's samples for more quickstart code snippets.

ImageAnnotatorGrpc

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.

ImageAnnotatorGrpc.ImageAnnotatorBlockingStub

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.

ImageAnnotatorGrpc.ImageAnnotatorFutureStub

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.

ImageAnnotatorGrpc.ImageAnnotatorImplBase

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.

ImageAnnotatorGrpc.ImageAnnotatorStub

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.

ImageAnnotatorProto

ImageAnnotatorSettings

Settings class to configure an instance of ImageAnnotatorClient.

The default instance has everything set to sensible defaults:

  • The default service address (vision.googleapis.com) and default port (443) are used.
  • Credentials are acquired automatically through Application Default Credentials.
  • Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of batchAnnotateImages to 30 seconds:


 ImageAnnotatorS