public static final class ReferenceImage.Builder extends GeneratedMessageV3.Builder<ReferenceImage.Builder> implements ReferenceImageOrBuilder
A ReferenceImage represents a product image and its associated metadata,
such as bounding boxes.
Protobuf type google.cloud.vision.v1.ReferenceImage
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
Methods
addAllBoundingPolys(Iterable<? extends BoundingPoly> values)
public ReferenceImage.Builder addAllBoundingPolys(Iterable<? extends BoundingPoly> values)
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];
| Name | Description |
| values | Iterable<? extends com.google.cloud.vision.v1.BoundingPoly>
|
Returns
addBoundingPolys(BoundingPoly value)
public ReferenceImage.Builder addBoundingPolys(BoundingPoly value)
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];
addBoundingPolys(BoundingPoly.Builder builderForValue)
public ReferenceImage.Builder addBoundingPolys(BoundingPoly.Builder builderForValue)
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];
addBoundingPolys(int index, BoundingPoly value)
public ReferenceImage.Builder addBoundingPolys(int index, BoundingPoly value)
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];
addBoundingPolys(int index, BoundingPoly.Builder builderForValue)
public ReferenceImage.Builder addBoundingPolys(int index, BoundingPoly.Builder builderForValue)
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];
addBoundingPolysBuilder()
public BoundingPoly.Builder addBoundingPolysBuilder()
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];
addBoundingPolysBuilder(int index)
public BoundingPoly.Builder addBoundingPolysBuilder(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];
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ReferenceImage.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
build()
public ReferenceImage build()
Returns
buildPartial()
public ReferenceImage buildPartial()
Returns
clear()
public ReferenceImage.Builder clear()
Returns
Overrides
clearBoundingPolys()
public ReferenceImage.Builder clearBoundingPolys()
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];
clearField(Descriptors.FieldDescriptor field)
public ReferenceImage.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Returns
Overrides
clearName()
public ReferenceImage.Builder clearName()
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;
clearOneof(Descriptors.OneofDescriptor oneof)
public ReferenceImage.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Returns
Overrides
clearUri()
public ReferenceImage.Builder clearUri()
Required. The Google Cloud Storage URI of the reference image.
The URI must start with gs://.
string uri = 2 [(.google.api.field_behavior) = REQUIRED];
clone()
public ReferenceImage.Builder clone()
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];
getBoundingPolysBuilder(int index)
public BoundingPoly.Builder getBoundingPolysBuilder(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];
getBoundingPolysBuilderList()
public List<BoundingPoly.Builder> getBoundingPolysBuilderList()
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
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns
Overrides
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;
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];
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
mergeFrom(ReferenceImage other)
public ReferenceImage.Builder mergeFrom(ReferenceImage other)
Parameter
Returns
public ReferenceImage.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Overrides
Exceptions
mergeFrom(Message other)
public ReferenceImage.Builder mergeFrom(Message other)
Parameter
Returns
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ReferenceImage.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
removeBoundingPolys(int index)
public ReferenceImage.Builder removeBoundingPolys(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];
setBoundingPolys(int index, BoundingPoly value)
public ReferenceImage.Builder setBoundingPolys(int index, BoundingPoly value)
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];
setBoundingPolys(int index, BoundingPoly.Builder builderForValue)
public ReferenceImage.Builder setBoundingPolys(int index, BoundingPoly.Builder builderForValue)
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];
setField(Descriptors.FieldDescriptor field, Object value)
public ReferenceImage.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
setName(String value)
public ReferenceImage.Builder setName(String value)
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;
| Name | Description |
| value | String
The name to set.
|
Returns
setNameBytes(ByteString value)
public ReferenceImage.Builder setNameBytes(ByteString value)
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;
| Name | Description |
| value | ByteString
The bytes for name to set.
|
Returns
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ReferenceImage.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Returns
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final ReferenceImage.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
setUri(String value)
public ReferenceImage.Builder setUri(String value)
Required. The Google Cloud Storage URI of the reference image.
The URI must start with gs://.
string uri = 2 [(.google.api.field_behavior) = REQUIRED];
| Name | Description |
| value | String
The uri to set.
|
Returns
setUriBytes(ByteString value)
public ReferenceImage.Builder setUriBytes(ByteString value)
Required. The Google Cloud Storage URI of the reference image.
The URI must start with gs://.
string uri = 2 [(.google.api.field_behavior) = REQUIRED];
| Name | Description |
| value | ByteString
The bytes for uri to set.
|
Returns
