Package com.google.cloud.vision.v1p4beta1 (3.11.0)

Request message for the AddProductToProductSet method.

Protobuf type google.cloud.vision.v1p4beta1.AddProductToProductSetRequest

Request message for the AddProductToProductSet method.

Protobuf type google.cloud.vision.v1p4beta1.AddProductToProductSetRequest

A request to annotate one single file, e.g. a PDF, TIFF or GIF file.

Protobuf type google.cloud.vision.v1p4beta1.AnnotateFileRequest

A request to annotate one single file, e.g. a PDF, TIFF or GIF file.

Protobuf type google.cloud.vision.v1p4beta1.AnnotateFileRequest

Response to a single file annotation request. A file may contain one or more images, which individually have their own responses.

Protobuf type google.cloud.vision.v1p4beta1.AnnotateFileResponse

Response to a single file annotation request. A file may contain one or more images, which individually have their own responses.

Protobuf type google.cloud.vision.v1p4beta1.AnnotateFileResponse

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

Protobuf type google.cloud.vision.v1p4beta1.AnnotateImageRequest

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

Protobuf type google.cloud.vision.v1p4beta1.AnnotateImageRequest

Response to an image annotation request.

Protobuf type google.cloud.vision.v1p4beta1.AnnotateImageResponse

Response to an image annotation request.

Protobuf type google.cloud.vision.v1p4beta1.AnnotateImageResponse

An offline file annotation request.

Protobuf type google.cloud.vision.v1p4beta1.AsyncAnnotateFileRequest

An offline file annotation request.

Protobuf type google.cloud.vision.v1p4beta1.AsyncAnnotateFileRequest

The response for a single offline file annotation request.

Protobuf type google.cloud.vision.v1p4beta1.AsyncAnnotateFileResponse

The response for a single offline file annotation request.

Protobuf type google.cloud.vision.v1p4beta1.AsyncAnnotateFileResponse

Multiple async file annotation requests are batched into a single service call.

Protobuf type google.cloud.vision.v1p4beta1.AsyncBatchAnnotateFilesRequest

Multiple async file annotation requests are batched into a single service call.

Protobuf type google.cloud.vision.v1p4beta1.AsyncBatchAnnotateFilesRequest

Response to an async batch file annotation request.

Protobuf type google.cloud.vision.v1p4beta1.AsyncBatchAnnotateFilesResponse

Response to an async batch file annotation request.

Protobuf type google.cloud.vision.v1p4beta1.AsyncBatchAnnotateFilesResponse

Request for async image annotation for a list of images.

Protobuf type google.cloud.vision.v1p4beta1.AsyncBatchAnnotateImagesRequest

Request for async image annotation for a list of images.

Protobuf type google.cloud.vision.v1p4beta1.AsyncBatchAnnotateImagesRequest

Response to an async batch image annotation request.

Protobuf type google.cloud.vision.v1p4beta1.AsyncBatchAnnotateImagesResponse

Response to an async batch image annotation request.

Protobuf type google.cloud.vision.v1p4beta1.AsyncBatchAnnotateImagesResponse

A list of requests to annotate files using the BatchAnnotateFiles API.

Protobuf type google.cloud.vision.v1p4beta1.BatchAnnotateFilesRequest

A list of requests to annotate files using the BatchAnnotateFiles API.

Protobuf type google.cloud.vision.v1p4beta1.BatchAnnotateFilesRequest

A list of file annotation responses.

Protobuf type google.cloud.vision.v1p4beta1.BatchAnnotateFilesResponse

A list of file annotation responses.

Protobuf type google.cloud.vision.v1p4beta1.BatchAnnotateFilesResponse

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

Protobuf type google.cloud.vision.v1p4beta1.BatchAnnotateImagesRequest

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

Protobuf type google.cloud.vision.v1p4beta1.BatchAnnotateImagesRequest

Response to a batch image annotation request.

Protobuf type google.cloud.vision.v1p4beta1.BatchAnnotateImagesResponse

Response to a batch image annotation request.

Protobuf type google.cloud.vision.v1p4beta1.BatchAnnotateImagesResponse

Metadata for the batch operations such as the current state. This is included in the metadata field of the Operation returned by the GetOperation call of the google::longrunning::Operations service.

Protobuf type google.cloud.vision.v1p4beta1.BatchOperationMetadata

Metadata for the batch operations such as the current state. This is included in the metadata field of the Operation returned by the GetOperation call of the google::longrunning::Operations service.

Protobuf type google.cloud.vision.v1p4beta1.BatchOperationMetadata

Logical element on the page.

Protobuf type google.cloud.vision.v1p4beta1.Block

Logical element on the page.

Protobuf type google.cloud.vision.v1p4beta1.Block

A bounding polygon for the detected image annotation.

Protobuf type google.cloud.vision.v1p4beta1.BoundingPoly

A bounding polygon for the detected image annotation.

Protobuf type google.cloud.vision.v1p4beta1.BoundingPoly

A Celebrity is a group of Faces with an identity.

Protobuf type google.cloud.vision.v1p4beta1.Celebrity

A Celebrity is a group of Faces with an identity.

Protobuf type google.cloud.vision.v1p4beta1.Celebrity

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.v1p4beta1.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.v1p4beta1.ColorInfo

Request message for the CreateProduct method.

Protobuf type google.cloud.vision.v1p4beta1.CreateProductRequest

Request message for the CreateProduct method.

Protobuf type google.cloud.vision.v1p4beta1.CreateProductRequest

Request message for the CreateProductSet method.

Protobuf type google.cloud.vision.v1p4beta1.CreateProductSetRequest

Request message for the CreateProductSet method.

Protobuf type google.cloud.vision.v1p4beta1.CreateProductSetRequest

Request message for the CreateReferenceImage method.

Protobuf type google.cloud.vision.v1p4beta1.CreateReferenceImageRequest

Request message for the CreateReferenceImage method.

Protobuf type google.cloud.vision.v1p4beta1.CreateReferenceImageRequest

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

Protobuf type google.cloud.vision.v1p4beta1.CropHint

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

Protobuf type google.cloud.vision.v1p4beta1.CropHint

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

Protobuf type google.cloud.vision.v1p4beta1.CropHintsAnnotation

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

Protobuf type google.cloud.vision.v1p4beta1.CropHintsAnnotation

Parameters for crop hints annotation request.

Protobuf type google.cloud.vision.v1p4beta1.CropHintsParams

Parameters for crop hints annotation request.

Protobuf type google.cloud.vision.v1p4beta1.CropHintsParams

Request message for the DeleteProduct method.

Protobuf type google.cloud.vision.v1p4beta1.DeleteProductRequest

Request message for the DeleteProduct method.

Protobuf type google.cloud.vision.v1p4beta1.DeleteProductRequest

Request message for the DeleteProductSet method.

Protobuf type google.cloud.vision.v1p4beta1.DeleteProductSetRequest

Request message for the DeleteProductSet method.

Protobuf type google.cloud.vision.v1p4beta1.DeleteProductSetRequest

Request message for the DeleteReferenceImage method.

Protobuf type google.cloud.vision.v1p4beta1.DeleteReferenceImageRequest

Request message for the DeleteReferenceImage method.

Protobuf type google.cloud.vision.v1p4beta1.DeleteReferenceImageRequest

Set of dominant colors and their corresponding scores.

Protobuf type google.cloud.vision.v1p4beta1.DominantColorsAnnotation

Set of dominant colors and their corresponding scores.

Protobuf type google.cloud.vision.v1p4beta1.DominantColorsAnnotation

Set of detected entity features.

Protobuf type google.cloud.vision.v1p4beta1.EntityAnnotation

Set of detected entity features.

Protobuf type google.cloud.vision.v1p4beta1.EntityAnnotation

A face annotation object contains the results of face detection.

Protobuf type google.cloud.vision.v1p4beta1.FaceAnnotation

A face annotation object contains the results of face detection.

Protobuf type google.cloud.vision.v1p4beta1.FaceAnnotation

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

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

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

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

Parameters for a celebrity recognition request.

Protobuf type google.cloud.vision.v1p4beta1.FaceRecognitionParams

Parameters for a celebrity recognition request.

Protobuf type google.cloud.vision.v1p4beta1.FaceRecognitionParams

Information about a face's identity.

Protobuf type google.cloud.vision.v1p4beta1.FaceRecognitionResult

Information about a face's identity.

Protobuf type google.cloud.vision.v1p4beta1.FaceRecognitionResult

The type of Google Cloud Vision API detection to perform, and the maximum number of results to return for that type. Multiple Feature objects can be specified in the features list.

Protobuf type google.cloud.vision.v1p4beta1.Feature

The type of Google Cloud Vision API detection to perform, and the maximum number of results to return for that type. Multiple Feature objects can be specified in the features list.

Protobuf type google.cloud.vision.v1p4beta1.Feature

The Google Cloud Storage location where the output will be written to.

Protobuf type google.cloud.vision.v1p4beta1.GcsDestination

The Google Cloud Storage location where the output will be written to.

Protobuf type google.cloud.vision.v1p4beta1.GcsDestination

The Google Cloud Storage location where the input will be read from.

Protobuf type google.cloud.vision.v1p4beta1.GcsSource

The Google Cloud Storage location where the input will be read from.

Protobuf type google.cloud.vision.v1p4beta1.GcsSource

Request message for the GetProduct method.

Protobuf type google.cloud.vision.v1p4beta1.GetProductRequest

Request message for the GetProduct method.

Protobuf type google.cloud.vision.v1p4beta1.GetProductRequest

Request message for the GetProductSet method.

Protobuf type google.cloud.vision.v1p4beta1.GetProductSetRequest

Request message for the GetProductSet method.

Protobuf type google.cloud.vision.v1p4beta1.GetProductSetRequest

Request message for the GetReferenceImage method.

Protobuf type google.cloud.vision.v1p4beta1.GetReferenceImageRequest

Request message for the GetReferenceImage method.

Protobuf type google.cloud.vision.v1p4beta1.GetReferenceImageRequest

Client image to perform Google Cloud Vision API tasks over.

Protobuf type google.cloud.vision.v1p4beta1.Image

Client image to perform Google Cloud Vision API tasks over.

Protobuf type google.cloud.vision.v1p4beta1.Image

If an image was produced from a file (e.g. a PDF), this message gives information about the source of that image.

Protobuf type google.cloud.vision.v1p4beta1.ImageAnnotationContext

If an image was produced from a file (e.g. a PDF), this message gives information about the source of that image.

Protobuf type google.cloud.vision.v1p4beta1.ImageAnnotationContext

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:

 // 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<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:

 // 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:

 // 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:

 // 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.

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.

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.

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.

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.

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.

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:

 // 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.Builder imageAnnotatorSettingsBuilder =
     ImageAnnotatorSettings.newBuilder();
 imageAnnotatorSettingsBuilder
     .batchAnnotateImagesSettings()
     .setRetrySettings(
         imageAnnotatorSettingsBuilder
             .batchAnnotateImagesSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 ImageAnnotatorSettings imageAnnotatorSettings = imageAnnotatorSettingsBuilder.build();
 

Builder for ImageAnnotatorSettings.

Image context and/or feature-specific parameters.

Protobuf type google.cloud.vision.v1p4beta1.ImageContext

Image context and/or feature-specific parameters.

Protobuf type google.cloud.vision.v1p4beta1.ImageContext

Stores image properties, such as dominant colors.

Protobuf type google.cloud.vision.v1p4beta1.ImageProperties

Stores image properties, such as dominant colors.

Protobuf type google.cloud.vision.v1p4beta1.ImageProperties

External image source (Google Cloud Storage or web URL image location).

Protobuf type google.cloud.vision.v1p4beta1.ImageSource

External image source (Google Cloud Storage or web URL image location).

Protobuf type google.cloud.vision.v1p4beta1.ImageSource

The Google Cloud Storage location for a csv file which preserves a list of ImportProductSetRequests in each line.

Protobuf type google.cloud.vision.v1p4beta1.ImportProductSetsGcsSource

The Google Cloud Storage location for a csv file which preserves a list of ImportProductSetRequests in each line.

Protobuf type google.cloud.vision.v1p4beta1.ImportProductSetsGcsSource

The input content for the ImportProductSets method.

Protobuf type google.cloud.vision.v1p4beta1.ImportProductSetsInputConfig

The input content for the ImportProductSets method.

Protobuf type google.cloud.vision.v1p4beta1.ImportProductSetsInputConfig

Request message for the ImportProductSets method.

Protobuf type google.cloud.vision.v1p4beta1.ImportProductSetsRequest

Request message for the ImportProductSets method.

Protobuf type google.cloud.vision.v1p4beta1.ImportProductSetsRequest

Response message for the ImportProductSets method. This message is returned by the google.longrunning.Operations.GetOperation method in the returned google.longrunning.Operation.response field.

Protobuf type google.cloud.vision.v1p4beta1.ImportProductSetsResponse

Response message for the ImportProductSets method. This message is returned by the google.longrunning.Operations.GetOperation method in the returned google.longrunning.Operation.response field.

Protobuf type google.cloud.vision.v1p4beta1.ImportProductSetsResponse

The desired input location and metadata.

Protobuf type google.cloud.vision.v1p4beta1.InputConfig

The desired input location and metadata.

Protobuf type google.cloud.vision.v1p4beta1.InputConfig

Rectangle determined by min and max LatLng pairs.

Protobuf type google.cloud.vision.v1p4beta1.LatLongRect

Rectangle determined by min and max LatLng pairs.

Protobuf type google.cloud.vision.v1p4beta1.LatLongRect

Request message for the ListProductSets method.

Protobuf type google.cloud.vision.v1p4beta1.ListProductSetsRequest

Request message for the ListProductSets method.

Protobuf type google.cloud.vision.v1p4beta1.ListProductSetsRequest

Response message for the ListProductSets method.

Protobuf type google.cloud.vision.v1p4beta1.ListProductSetsResponse

Response message for the ListProductSets method.

Protobuf type google.cloud.vision.v1p4beta1.ListProductSetsResponse

Request message for the ListProductsInProductSet method.

Protobuf type google.cloud.vision.v1p4beta1.ListProductsInProductSetRequest

Request message for the ListProductsInProductSet method.

Protobuf type google.cloud.vision.v1p4beta1.ListProductsInProductSetRequest

Response message for the ListProductsInProductSet method.

Protobuf type google.cloud.vision.v1p4beta1.ListProductsInProductSetResponse

Response message for the ListProductsInProductSet method.

Protobuf type google.cloud.vision.v1p4beta1.ListProductsInProductSetResponse

Request message for the ListProducts method.

Protobuf type google.cloud.vision.v1p4beta1.ListProductsRequest

Request message for the ListProducts method.

Protobuf type google.cloud.vision.v1p4beta1.ListProductsRequest

Response message for the ListProducts method.

Protobuf type google.cloud.vision.v1p4beta1.ListProductsResponse

Response message for the ListProducts method.

Protobuf type google.cloud.vision.v1p4beta1.ListProductsResponse

Request message for the ListReferenceImages method.

Protobuf type google.cloud.vision.v1p4beta1.ListReferenceImagesRequest

Request message for the ListReferenceImages method.

Protobuf type google.cloud.vision.v1p4beta1.ListReferenceImagesRequest

Response message for the ListReferenceImages method.

Protobuf type google.cloud.vision.v1p4beta1.ListReferenceImagesResponse

Response message for the ListReferenceImages method.

Protobuf type google.cloud.vision.v1p4beta1.ListReferenceImagesResponse

Set of detected objects with bounding boxes.

Protobuf type google.cloud.vision.v1p4beta1.LocalizedObjectAnnotation

Set of detected objects with bounding boxes.

Protobuf type google.cloud.vision.v1p4beta1.LocalizedObjectAnnotation

Detected entity location information.

Protobuf type google.cloud.vision.v1p4beta1.LocationInfo

Detected entity location information.

Protobuf type google.cloud.vision.v1p4beta1.LocationInfo

Builder for projects/{project}/locations/{location}.

A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.

Protobuf type google.cloud.vision.v1p4beta1.NormalizedVertex

A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.

Protobuf type google.cloud.vision.v1p4beta1.NormalizedVertex

Contains metadata for the BatchAnnotateImages operation.

Protobuf type google.cloud.vision.v1p4beta1.OperationMetadata

Contains metadata for the BatchAnnotateImages operation.

Protobuf type google.cloud.vision.v1p4beta1.OperationMetadata

The desired output location and metadata.

Protobuf type google.cloud.vision.v1p4beta1.OutputConfig

The desired output location and metadata.

Protobuf type google.cloud.vision.v1p4beta1.OutputConfig

Detected page from OCR.

Protobuf type google.cloud.vision.v1p4beta1.Page

Detected page from OCR.

Protobuf type google.cloud.vision.v1p4beta1.Page

Structural unit of text representing a number of words in certain order.

Protobuf type google.cloud.vision.v1p4beta1.Paragraph

Structural unit of text representing a number of words in certain order.

Protobuf type google.cloud.vision.v1p4beta1.Paragraph

A 3D position in the image, used primarily for Face detection landmarks. A valid Position must have both x and y coordinates. The position coordinates are in the same scale as the original image.

Protobuf type google.cloud.vision.v1p4beta1.Position

A 3D position in the image, used primarily for Face detection landmarks. A valid Position must have both x and y coordinates. The position coordinates are in the same scale as the original image.

Protobuf type google.cloud.vision.v1p4beta1.Position

A Product contains ReferenceImages.

Protobuf type google.cloud.vision.v1p4beta1.Product

A Product contains ReferenceImages.

Protobuf type google.cloud.vision.v1p4beta1.Product

A product label represented as a key-value pair.

Protobuf type google.cloud.vision.v1p4beta1.Product.KeyValue

A product label represented as a key-value pair.

Protobuf type google.cloud.vision.v1p4beta1.Product.KeyValue

Builder for projects/{project}/locations/{location}/products/{product}.

Service Description: Manages Products and ProductSets of reference images for use in product search. It uses the following resource model:

- The API has a collection of ProductSet resources, named projects/*/locations/*/productSets/*, which acts as a way to put different products into groups to limit identification.

In parallel,

- The API has a collection of Product resources, named projects/*/locations/*/products/*

- Each Product has a collection of ReferenceImage resources, named projects/*/locations/*/products/*/referenceImages/*

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:

 // 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 (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   ProductSet productSet = ProductSet.newBuilder().build();
   String productSetId = "productSetId1003042158";
   ProductSet response = productSearchClient.createProductSet(parent, productSet, productSetId);
 }
 

Note: close() needs to be called on the ProductSearchClient 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 ProductSearchSettings to create(). For example:

To customize credentials:

 // 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
 ProductSearchSettings productSearchSettings =
     ProductSearchSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ProductSearchClient productSearchClient = ProductSearchClient.create(productSearchSettings);
 

To customize the endpoint:

 // 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
 ProductSearchSettings productSearchSettings =
     ProductSearchSettings.newBuilder().setEndpoint(myEndpoint).build();
 ProductSearchClient productSearchClient = ProductSearchClient.create(productSearchSettings);
 

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:

 // 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
 ProductSearchSettings productSearchSettings =
     ProductSearchSettings.newHttpJsonBuilder().build();
 ProductSearchClient productSearchClient = ProductSearchClient.create(productSearchSettings);
 

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

Manages Products and ProductSets of reference images for use in product search. It uses the following resource model:

• The API has a collection of ProductSet resources, named projects/*/locations/*/productSets/*, which acts as a way to put different products into groups to limit identification. In parallel,
• The API has a collection of Product resources, named projects/*/locations/*/products/*
• Each Product has a collection of ReferenceImage resources, named projects/*/locations/*/products/*/referenceImages/*

Manages Products and ProductSets of reference images for use in product search. It uses the following resource model:

• The API has a collection of ProductSet resources, named projects/*/locations/*/productSets/*, which acts as a way to put different products into groups to limit identification. In parallel,
• The API has a collection of Product resources, named projects/*/locations/*/products/*
• Each Product has a collection of ReferenceImage resources, named projects/*/locations/*/products/*/referenceImages/*

Manages Products and ProductSets of reference images for use in product search. It uses the following resource model:

• The API has a collection of ProductSet resources, named projects/*/locations/*/productSets/*, which acts as a way to put different products into groups to limit identification. In parallel,
• The API has a collection of Product resources, named projects/*/locations/*/products/*
• Each Product has a collection of ReferenceImage resources, named projects/*/locations/*/products/*/referenceImages/*

Manages Products and ProductSets of reference images for use in product search. It uses the following resource model:

• The API has a collection of ProductSet resources, named projects/*/locations/*/productSets/*, which acts as a way to put different products into groups to limit identification. In parallel,
• The API has a collection of Product resources, named projects/*/locations/*/products/*
• Each Product has a collection of ReferenceImage resources, named projects/*/locations/*/products/*/referenceImages/*

Manages Products and ProductSets of reference images for use in product search. It uses the following resource model:

• The API has a collection of ProductSet resources, named projects/*/locations/*/productSets/*, which acts as a way to put different products into groups to limit identification. In parallel,
• The API has a collection of Product resources, named projects/*/locations/*/products/*
• Each Product has a collection of ReferenceImage resources, named projects/*/locations/*/products/*/referenceImages/*

Parameters for a product search request.

Protobuf type google.cloud.vision.v1p4beta1.ProductSearchParams

Parameters for a product search request.

Protobuf type google.cloud.vision.v1p4beta1.ProductSearchParams

Results for a product search request.

Protobuf type google.cloud.vision.v1p4beta1.ProductSearchResults

Results for a product search request.

Protobuf type google.cloud.vision.v1p4beta1.ProductSearchResults

Information about the products similar to a single product in a query image.

Protobuf type google.cloud.vision.v1p4beta1.ProductSearchResults.GroupedResult

Information about the products similar to a single product in a query image.

Protobuf type google.cloud.vision.v1p4beta1.ProductSearchResults.GroupedResult

Prediction for what the object in the bounding box is.

Protobuf type google.cloud.vision.v1p4beta1.ProductSearchResults.ObjectAnnotation

Prediction for what the object in the bounding box is.

Protobuf type google.cloud.vision.v1p4beta1.ProductSearchResults.ObjectAnnotation

Information about a product.

Protobuf type google.cloud.vision.v1p4beta1.ProductSearchResults.Result

Information about a product.

Protobuf type google.cloud.vision.v1p4beta1.ProductSearchResults.Result

Settings class to configure an instance of ProductSearchClient.

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 createProductSet to 30 seconds:

 // 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
 ProductSearchSettings.Builder productSearchSettingsBuilder = ProductSearchSettings.newBuilder();
 productSearchSettingsBuilder
     .createProductSetSettings()
     .setRetrySettings(
         productSearchSettingsBuilder
             .createProductSetSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 ProductSearchSettings productSearchSettings = productSearchSettingsBuilder.build();
 

Builder for ProductSearchSettings.

A ProductSet contains Products. A ProductSet can contain a maximum of 1 million reference images. If the limit is exceeded, periodic indexing will fail.

Protobuf type google.cloud.vision.v1p4beta1.ProductSet

A ProductSet contains Products. A ProductSet can contain a maximum of 1 million reference images. If the limit is exceeded, periodic indexing will fail.

Protobuf type google.cloud.vision.v1p4beta1.ProductSet

Builder for projects/{project}/locations/{location}/productSets/{product_set}.

Config to control which ProductSet contains the Products to be deleted.

Protobuf type google.cloud.vision.v1p4beta1.ProductSetPurgeConfig

Config to control which ProductSet contains the Products to be deleted.

Protobuf type google.cloud.vision.v1p4beta1.ProductSetPurgeConfig

A Property consists of a user-supplied name/value pair.

Protobuf type google.cloud.vision.v1p4beta1.Property

A Property consists of a user-supplied name/value pair.

Protobuf type google.cloud.vision.v1p4beta1.Property

Request message for the PurgeProducts method.

Protobuf type google.cloud.vision.v1p4beta1.PurgeProductsRequest

Request message for the PurgeProducts method.

Protobuf type google.cloud.vision.v1p4beta1.PurgeProductsRequest

A ReferenceImage represents a product image and its associated metadata, such as bounding boxes.

Protobuf type google.cloud.vision.v1p4beta1.ReferenceImage

A ReferenceImage represents a product image and its associated metadata, such as bounding boxes.

Protobuf type google.cloud.vision.v1p4beta1.ReferenceImage

Builder for projects/{project}/locations/{location}/products/{product}/referenceImages/{reference_image}.

Request message for the RemoveProductFromProductSet method.

Protobuf type google.cloud.vision.v1p4beta1.RemoveProductFromProductSetRequest

Request message for the RemoveProductFromProductSet method.

Protobuf type google.cloud.vision.v1p4beta1.RemoveProductFromProductSetRequest

Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence).

Protobuf type google.cloud.vision.v1p4beta1.SafeSearchAnnotation

Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence).

Protobuf type google.cloud.vision.v1p4beta1.SafeSearchAnnotation

A single symbol representation.

Protobuf type google.cloud.vision.v1p4beta1.Symbol

A single symbol representation.

Protobuf type google.cloud.vision.v1p4beta1.Symbol

TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail.

Protobuf type google.cloud.vision.v1p4beta1.TextAnnotation

TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail.

Protobuf type google.cloud.vision.v1p4beta1.TextAnnotation

Detected start or end of a structural component.

Protobuf type google.cloud.vision.v1p4beta1.TextAnnotation.DetectedBreak

Detected start or end of a structural component.

Protobuf type google.cloud.vision.v1p4beta1.TextAnnotation.DetectedBreak

Detected language for a structural component.

Protobuf type google.cloud.vision.v1p4beta1.TextAnnotation.DetectedLanguage

Detected language for a structural component.

Protobuf type google.cloud.vision.v1p4beta1.TextAnnotation.DetectedLanguage

Additional information detected on the structural component.

Protobuf type google.cloud.vision.v1p4beta1.TextAnnotation.TextProperty

Additional information detected on the structural component.

Protobuf type google.cloud.vision.v1p4beta1.TextAnnotation.TextProperty

Parameters for text detections. This is used to control TEXT_DETECTION and DOCUMENT_TEXT_DETECTION features.

Protobuf type google.cloud.vision.v1p4beta1.TextDetectionParams

Parameters for text detections. This is used to control TEXT_DETECTION and DOCUMENT_TEXT_DETECTION features.

Protobuf type google.cloud.vision.v1p4beta1.TextDetectionParams

Request message for the UpdateProduct method.

Protobuf type google.cloud.vision.v1p4beta1.UpdateProductRequest

Request message for the UpdateProduct method.

Protobuf type google.cloud.vision.v1p4beta1.UpdateProductRequest

Request message for the UpdateProductSet method.

Protobuf type google.cloud.vision.v1p4beta1.UpdateProductSetRequest

Request message for the UpdateProductSet method.

Protobuf type google.cloud.vision.v1p4beta1.UpdateProductSetRequest

A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.

Protobuf type google.cloud.vision.v1p4beta1.Vertex

A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.

Protobuf type google.cloud.vision.v1p4beta1.Vertex

Relevant information for the image from the Internet.

Protobuf type google.cloud.vision.v1p4beta1.WebDetection

Relevant information for the image from the Internet.

Protobuf type google.cloud.vision.v1p4beta1.WebDetection

Entity deduced from similar images on the Internet.

Protobuf type google.cloud.vision.v1p4beta1.WebDetection.WebEntity

Entity deduced from similar images on the Internet.

Protobuf type google.cloud.vision.v1p4beta1.WebDetection.WebEntity

Metadata for online images.

Protobuf type google.cloud.vision.v1p4beta1.WebDetection.WebImage

Metadata for online images.

Protobuf type google.cloud.vision.v1p4beta1.WebDetection.WebImage

Label to provide extra metadata for the web detection.

Protobuf type google.cloud.vision.v1p4beta1.WebDetection.WebLabel

Label to provide extra metadata for the web detection.

Protobuf type google.cloud.vision.v1p4beta1.WebDetection.WebLabel

Metadata for web pages.

Protobuf type google.cloud.vision.v1p4beta1.WebDetection.WebPage

Metadata for web pages.

Protobuf type google.cloud.vision.v1p4beta1.WebDetection.WebPage

Parameters for web detection request.

Protobuf type google.cloud.vision.v1p4beta1.WebDetectionParams

Parameters for web detection request.

Protobuf type google.cloud.vision.v1p4beta1.WebDetectionParams

A word representation.

Protobuf type google.cloud.vision.v1p4beta1.Word

A word representation.

Protobuf type google.cloud.vision.v1p4beta1.Word

Enumerates the possible states that the batch request can be in.

Protobuf enum google.cloud.vision.v1p4beta1.BatchOperationMetadata.State

Type of a block (text, image etc) as identified by OCR.

Protobuf enum google.cloud.vision.v1p4beta1.Block.BlockType

Face landmark (feature) type. Left and right are defined from the vantage of the viewer of the image without considering mirror projections typical of photos. So, LEFT_EYE, typically, is the person's right eye.

Protobuf enum google.cloud.vision.v1p4beta1.FaceAnnotation.Landmark.Type

Type of Google Cloud Vision API feature to be extracted.

Protobuf enum google.cloud.vision.v1p4beta1.Feature.Type

A bucketized representation of likelihood, which is intended to give clients highly stable results across model upgrades.

Protobuf enum google.cloud.vision.v1p4beta1.Likelihood

Batch operation states.

Protobuf enum google.cloud.vision.v1p4beta1.OperationMetadata.State

Enum to denote the type of break found. New line, space etc.

Protobuf enum google.cloud.vision.v1p4beta1.TextAnnotation.DetectedBreak.BreakType