Class ReferenceImage.Builder (3.13.0)

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
TypeDescription
Descriptor

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];

Parameter
NameDescription
valuesIterable<? extends com.google.cloud.vision.v1.BoundingPoly>
Returns
TypeDescription
ReferenceImage.Builder

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];

Parameter
NameDescription
valueBoundingPoly
Returns
TypeDescription
ReferenceImage.Builder

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];

Parameter
NameDescription
builderForValueBoundingPoly.Builder
Returns
TypeDescription
ReferenceImage.Builder

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];

Parameters
NameDescription
indexint
valueBoundingPoly
Returns
TypeDescription
ReferenceImage.Builder

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];

Parameters
NameDescription
indexint
builderForValueBoundingPoly.Builder
Returns
TypeDescription
ReferenceImage.Builder

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];

Returns
TypeDescription
BoundingPoly.Builder

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];

Parameter
NameDescription
indexint
Returns
TypeDescription
BoundingPoly.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ReferenceImage.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ReferenceImage.Builder
Overrides

build()

public ReferenceImage build()
Returns
TypeDescription
ReferenceImage

buildPartial()

public ReferenceImage buildPartial()
Returns
TypeDescription
ReferenceImage

clear()

public ReferenceImage.Builder clear()
Returns
TypeDescription
ReferenceImage.Builder
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];

Returns
TypeDescription
ReferenceImage.Builder

clearField(Descriptors.FieldDescriptor field)

public ReferenceImage.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
ReferenceImage.Builder
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;

Returns
TypeDescription
ReferenceImage.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ReferenceImage.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
ReferenceImage.Builder
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];

Returns
TypeDescription
ReferenceImage.Builder

This builder for chaining.

clone()

public ReferenceImage.Builder clone()
Returns
TypeDescription
ReferenceImage.Builder
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
NameDescription
indexint
Returns
TypeDescription
BoundingPoly

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];

Parameter
NameDescription
indexint
Returns
TypeDescription
BoundingPoly.Builder

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];

Returns
TypeDescription
List<Builder>

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
TypeDescription
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];

Returns
TypeDescription
List<BoundingPoly>

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
NameDescription
indexint
Returns
TypeDescription
BoundingPolyOrBuilder

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
TypeDescription
List<? extends com.google.cloud.vision.v1.BoundingPolyOrBuilder>

getDefaultInstanceForType()

public ReferenceImage getDefaultInstanceForType()
Returns
TypeDescription
ReferenceImage

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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.

string name = 1;

Returns
TypeDescription
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
TypeDescription
ByteString

The bytes for name.

getUri()

public String 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
TypeDescription
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
TypeDescription
ByteString

The bytes for uri.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(ReferenceImage other)

public ReferenceImage.Builder mergeFrom(ReferenceImage other)
Parameter
NameDescription
otherReferenceImage
Returns
TypeDescription
ReferenceImage.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ReferenceImage.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ReferenceImage.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public ReferenceImage.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
ReferenceImage.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ReferenceImage.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ReferenceImage.Builder
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];

Parameter
NameDescription
indexint
Returns
TypeDescription
ReferenceImage.Builder

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];

Parameters
NameDescription
indexint
valueBoundingPoly
Returns
TypeDescription
ReferenceImage.Builder

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];

Parameters
NameDescription
indexint
builderForValueBoundingPoly.Builder
Returns
TypeDescription
ReferenceImage.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public ReferenceImage.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ReferenceImage.Builder
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;

Parameter
NameDescription
valueString

The name to set.

Returns
TypeDescription
ReferenceImage.Builder

This builder for chaining.

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;

Parameter
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
ReferenceImage.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ReferenceImage.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
ReferenceImage.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ReferenceImage.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ReferenceImage.Builder
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];

Parameter
NameDescription
valueString

The uri to set.

Returns
TypeDescription
ReferenceImage.Builder

This builder for chaining.

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];

Parameter
NameDescription
valueByteString

The bytes for uri to set.

Returns
TypeDescription
ReferenceImage.Builder

This builder for chaining.