Class Image.Builder (2.2.2) 

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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Image.Builder

Implements

ImageOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public Image build()
Returns
TypeDescription
Image

buildPartial()

public Image buildPartial()
Returns
TypeDescription
Image

clear()

public Image.Builder clear()
Returns
TypeDescription
Image.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

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

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

This builder for chaining.

clone()

public Image.Builder clone()
Returns
TypeDescription
Image.Builder
Overrides

getDefaultInstanceForType()

public Image getDefaultInstanceForType()
Returns
TypeDescription
Image

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
int

The width.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(Image other)

public Image.Builder mergeFrom(Image other)
Parameter
NameDescription
otherImage
Returns
TypeDescription
Image.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Image.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Image.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

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

The height to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
Image.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

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

The uri to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for uri to set.

Returns
TypeDescription
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
NameDescription
valueint

The width to set.

Returns
TypeDescription
Image.Builder

This builder for chaining.