public final class ReferenceImage extends GeneratedMessageV3 implements ReferenceImageOrBuilder
A ReferenceImage represents a product image and its associated metadata,
such as bounding boxes.
Protobuf type google.cloud.vision.v1.ReferenceImage
Static Fields
BOUNDING_POLYS_FIELD_NUMBER
public static final int BOUNDING_POLYS_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
URI_FIELD_NUMBER
public static final int URI_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static ReferenceImage getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static ReferenceImage.Builder newBuilder()
Returns
newBuilder(ReferenceImage prototype)
public static ReferenceImage.Builder newBuilder(ReferenceImage prototype)
Parameter
Returns
public static ReferenceImage parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static ReferenceImage parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static ReferenceImage parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ReferenceImage parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static ReferenceImage parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ReferenceImage parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ReferenceImage parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static ReferenceImage parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ReferenceImage parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static ReferenceImage parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static ReferenceImage parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ReferenceImage parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<ReferenceImage> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getBoundingPolys(int index)
public BoundingPoly getBoundingPolys(int index)
Optional. Bounding polygons around the areas of interest in the reference image.
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).
repeated .google.cloud.vision.v1.BoundingPoly bounding_polys = 3 [(.google.api.field_behavior) = OPTIONAL];
getBoundingPolysCount()
public int getBoundingPolysCount()
Optional. Bounding polygons around the areas of interest in the reference image.
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).
repeated .google.cloud.vision.v1.BoundingPoly bounding_polys = 3 [(.google.api.field_behavior) = OPTIONAL];
getBoundingPolysList()
public List<BoundingPoly> getBoundingPolysList()
Optional. Bounding polygons around the areas of interest in the reference image.
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).
repeated .google.cloud.vision.v1.BoundingPoly bounding_polys = 3 [(.google.api.field_behavior) = OPTIONAL];
getBoundingPolysOrBuilder(int index)
public BoundingPolyOrBuilder getBoundingPolysOrBuilder(int index)
Optional. Bounding polygons around the areas of interest in the reference image.
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).
repeated .google.cloud.vision.v1.BoundingPoly bounding_polys = 3 [(.google.api.field_behavior) = OPTIONAL];
getBoundingPolysOrBuilderList()
public List<? extends BoundingPolyOrBuilder> getBoundingPolysOrBuilderList()
Optional. Bounding polygons around the areas of interest in the reference image.
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).
repeated .google.cloud.vision.v1.BoundingPoly bounding_polys = 3 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| List<? extends com.google.cloud.vision.v1.BoundingPolyOrBuilder> | |
getDefaultInstanceForType()
public ReferenceImage getDefaultInstanceForType()
Returns
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.
string name = 1;
| Type | Description |
| String | The name.
|
getNameBytes()
public ByteString getNameBytes()
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.
string name = 1;
getParserForType()
public Parser<ReferenceImage> getParserForType()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
getUri()
Required. The Google Cloud Storage URI of the reference image.
The URI must start with gs://.
string uri = 2 [(.google.api.field_behavior) = REQUIRED];
getUriBytes()
public ByteString getUriBytes()
Required. The Google Cloud Storage URI of the reference image.
The URI must start with gs://.
string uri = 2 [(.google.api.field_behavior) = REQUIRED];
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public ReferenceImage.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ReferenceImage.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public ReferenceImage.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
