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 |
|---|
| Type | Description |
int | |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
URI_FIELD_NUMBER
public static final int URI_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static ReferenceImage getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static ReferenceImage.Builder newBuilder()
newBuilder(ReferenceImage prototype)
public static ReferenceImage.Builder newBuilder(ReferenceImage prototype)
public static ReferenceImage parseDelimitedFrom(InputStream input)
public static ReferenceImage parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static ReferenceImage parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ReferenceImage parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static ReferenceImage parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ReferenceImage parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ReferenceImage parseFrom(CodedInputStream input)
public static ReferenceImage parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ReferenceImage parseFrom(InputStream input)
public static ReferenceImage parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static ReferenceImage parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ReferenceImage parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<ReferenceImage> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
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];
| Parameter |
|---|
| Name | Description |
index | int
|
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];
| Returns |
|---|
| Type | Description |
int | |
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];
| Parameter |
|---|
| Name | Description |
index | int
|
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];
| Returns |
|---|
| Type | Description |
List<? extends com.google.cloud.vision.v1.BoundingPolyOrBuilder> | |
getDefaultInstanceForType()
public ReferenceImage getDefaultInstanceForType()
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;
| Returns |
|---|
| 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;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for name.
|
getParserForType()
public Parser<ReferenceImage> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
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];
| Returns |
|---|
| Type | Description |
String | The uri.
|
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];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for uri.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public ReferenceImage.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ReferenceImage.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public ReferenceImage.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
