com.google.api.services.vision.v1.model

Class ReferenceImage

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.vision.v1.model.ReferenceImage

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class ReferenceImage
extends com.google.api.client.json.GenericJson

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

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Vision API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
ReferenceImage()

Method Summary

Modifier and Type	Method and Description
ReferenceImage	clone()
List<BoundingPoly>	getBoundingPolys() Bounding polygons around the areas of interest in the reference image.
String	getName() The resource name of the reference image.
String	getUri() The Google Cloud Storage URI of the reference image.
ReferenceImage	set(String fieldName, Object value)
ReferenceImage	setBoundingPolys(List<BoundingPoly> boundingPolys) Bounding polygons around the areas of interest in the reference image.
ReferenceImage	setName(String name) The resource name of the reference image.
ReferenceImage	setUri(String uri) The Google Cloud Storage URI of the reference image.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

ReferenceImage

public ReferenceImage()

Method Detail

getBoundingPolys

public List<BoundingPoly> getBoundingPolys()

Bounding polygons around the areas of interest in the reference image. Optional. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not).

Returns:

value or null for none

setBoundingPolys

public ReferenceImage setBoundingPolys(List<BoundingPoly> boundingPolys)

Bounding polygons around the areas of interest in the reference image. Optional. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not).

Parameters:

boundingPolys - boundingPolys or null for none

getName

public String getName()

The resource name of the reference image. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. This field is ignored when creating a reference image.

Returns:

value or null for none

setName

public ReferenceImage setName(String name)

The resource name of the reference image. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. This field is ignored when creating a reference image.

Parameters:

name - name or null for none

getUri

public String getUri()

The Google Cloud Storage URI of the reference image. The URI must start with `gs://`. Required.

Returns:

value or null for none

setUri

public ReferenceImage setUri(String uri)

The Google Cloud Storage URI of the reference image. The URI must start with `gs://`. Required.

Parameters:

uri - uri or null for none

set

public ReferenceImage set(String fieldName,
                          Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public ReferenceImage clone()

Overrides:

clone in class com.google.api.client.json.GenericJson