Class Image.Builder (2.54.0)

public static final class Image.Builder extends GeneratedMessageV3.Builder<Image.Builder> implements ImageOrBuilder

Product image. Recommendations AI and Retail Search do not use product images to improve prediction and search results. However, product images can be returned in results, and are shown in prediction or search previews in the console.

Protobuf type google.cloud.retail.v2alpha.Image

Implements

ImageOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Image.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Image.Builder
Overrides

build()

public Image build()
Returns
Type Description
Image

buildPartial()

public Image buildPartial()
Returns
Type Description
Image

clear()

public Image.Builder clear()
Returns
Type Description
Image.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public Image.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Image.Builder
Overrides

clearHeight()

public Image.Builder clearHeight()

Height of the image in number of pixels.

This field must be nonnegative. Otherwise, an INVALID_ARGUMENT error is returned.

int32 height = 2;

Returns
Type Description
Image.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Image.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Image.Builder
Overrides

clearUri()

public Image.Builder clearUri()

Required. URI of the image.

This field must be a valid UTF-8 encoded URI with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned.

Google Merchant Center property image_link. Schema.org property Product.image.

string uri = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Image.Builder

This builder for chaining.

clearWidth()

public Image.Builder clearWidth()

Width of the image in number of pixels.

This field must be nonnegative. Otherwise, an INVALID_ARGUMENT error is returned.

int32 width = 3;

Returns
Type Description
Image.Builder

This builder for chaining.

clone()

public Image.Builder clone()
Returns
Type Description
Image.Builder
Overrides

getDefaultInstanceForType()

public Image getDefaultInstanceForType()
Returns
Type Description
Image

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getHeight()

public int getHeight()

Height of the image in number of pixels.

This field must be nonnegative. Otherwise, an INVALID_ARGUMENT error is returned.

int32 height = 2;

Returns
Type Description
int

The height.

getUri()

public String getUri()

Required. URI of the image.

This field must be a valid UTF-8 encoded URI with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned.

Google Merchant Center property image_link. Schema.org property Product.image.

string uri = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The uri.

getUriBytes()

public ByteString getUriBytes()

Required. URI of the image.

This field must be a valid UTF-8 encoded URI with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned.

Google Merchant Center property image_link. Schema.org property Product.image.

string uri = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for uri.

getWidth()

public int getWidth()

Width of the image in number of pixels.

This field must be nonnegative. Otherwise, an INVALID_ARGUMENT error is returned.

int32 width = 3;

Returns
Type Description
int

The width.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(Image other)

public Image.Builder mergeFrom(Image other)
Parameter
Name Description
other Image
Returns
Type Description
Image.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Image.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Image.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Image.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Image.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Image.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Image.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public Image.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Image.Builder
Overrides

setHeight(int value)

public Image.Builder setHeight(int value)

Height of the image in number of pixels.

This field must be nonnegative. Otherwise, an INVALID_ARGUMENT error is returned.

int32 height = 2;

Parameter
Name Description
value int

The height to set.

Returns
Type Description
Image.Builder

This builder for chaining.

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

public Image.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Image.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final Image.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Image.Builder
Overrides

setUri(String value)

public Image.Builder setUri(String value)

Required. URI of the image.

This field must be a valid UTF-8 encoded URI with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned.

Google Merchant Center property image_link. Schema.org property Product.image.

string uri = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The uri to set.

Returns
Type Description
Image.Builder

This builder for chaining.

setUriBytes(ByteString value)

public Image.Builder setUriBytes(ByteString value)

Required. URI of the image.

This field must be a valid UTF-8 encoded URI with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned.

Google Merchant Center property image_link. Schema.org property Product.image.

string uri = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for uri to set.

Returns
Type Description
Image.Builder

This builder for chaining.

setWidth(int value)

public Image.Builder setWidth(int value)

Width of the image in number of pixels.

This field must be nonnegative. Otherwise, an INVALID_ARGUMENT error is returned.

int32 width = 3;

Parameter
Name Description
value int

The width to set.

Returns
Type Description
Image.Builder

This builder for chaining.