com.google.api.services.vision.v1

Class Vision.Projects.Locations.Products.ReferenceImages

java.lang.Object

com.google.api.services.vision.v1.Vision.Projects.Locations.Products.ReferenceImages

Enclosing class:

Vision.Projects.Locations.Products

public class Vision.Projects.Locations.Products.ReferenceImages
extends Object

The "referenceImages" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Vision.Projects.Locations.Products.ReferenceImages.Create
class	Vision.Projects.Locations.Products.ReferenceImages.Delete
class	Vision.Projects.Locations.Products.ReferenceImages.Get
class	Vision.Projects.Locations.Products.ReferenceImages.List

Constructor Summary

Constructors

Constructor and Description
ReferenceImages()

Method Summary

Modifier and Type	Method and Description
Vision.Projects.Locations.Products.ReferenceImages.Create	create(String parent, ReferenceImage content) Creates and returns a new ReferenceImage resource.
Vision.Projects.Locations.Products.ReferenceImages.Delete	delete(String name) Permanently deletes a reference image.
Vision.Projects.Locations.Products.ReferenceImages.Get	get(String name) Gets information associated with a ReferenceImage.
Vision.Projects.Locations.Products.ReferenceImages.List	list(String parent) Lists reference images.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ReferenceImages

public ReferenceImages()

Method Detail

create

public Vision.Projects.Locations.Products.ReferenceImages.Create create(String parent,
                                                                        ReferenceImage content)
                                                                 throws IOException

Creates and returns a new ReferenceImage resource. The `bounding_poly` field is optional. If `bounding_poly` is not specified, the system will try to detect regions of interest in the image that are compatible with the product_category on the parent product. If it is specified, detection is ALWAYS skipped. The system converts polygons into non-rotated rectangles. Note that the pipeline will resize the image if the image resolution is too large to process (above 50MP). Possible errors: * Returns INVALID_ARGUMENT if the image_uri is missing or longer than 4096 characters. * Returns INVALID_ARGUMENT if the product does not exist. * Returns INVALID_ARGUMENT if bounding_poly is not provided, and nothing compatible with the parent product's product_category is detected. * Returns INVALID_ARGUMENT if bounding_poly contains more than 10 polygons. Create a request for the method "referenceImages.create". This request holds the parameters needed by the vision server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - Resource name of the product in which to create the reference image. Format is `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`.

content - the ReferenceImage

Returns:

the request

Throws:

IOException

delete

public Vision.Projects.Locations.Products.ReferenceImages.Delete delete(String name)
                                                                 throws IOException

Permanently deletes a reference image. The image metadata will be deleted right away, but search queries against ProductSets containing the image may still work until all related caches are refreshed. The actual image files are not deleted from Google Cloud Storage. Possible errors: * Returns NOT_FOUND if the reference image does not exist. Create a request for the method "referenceImages.delete". This request holds the parameters needed by the vision server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - The resource name of the reference image to delete. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`

Returns:

the request

Throws:

IOException

get

public Vision.Projects.Locations.Products.ReferenceImages.Get get(String name)
                                                           throws IOException

Gets information associated with a ReferenceImage. Possible errors: * Returns NOT_FOUND if the specified image does not exist. Create a request for the method "referenceImages.get". This request holds the parameters needed by the vision server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - The resource name of the ReferenceImage to get. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`.

Returns:

the request

Throws:

IOException

list

public Vision.Projects.Locations.Products.ReferenceImages.List list(String parent)
                                                             throws IOException

Lists reference images. Possible errors: * Returns NOT_FOUND if the parent product does not exist. * Returns INVALID_ARGUMENT if the page_size is greater than 100, or less than 1. Create a request for the method "referenceImages.list". This request holds the parameters needed by the vision server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - Resource name of the product containing the reference images. Format is `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`.

Returns:

the request

Throws:

IOException