Class Image (2.77.0) 

public final class Image extends GeneratedMessageV3 implements ImageOrBuilder

Product image. Recommendations AI and Retail Search use product images to improve prediction and search results. Product images can be returned in results, and are shown in prediction or search previews in the console. Please try to provide correct product images and avoid using images with size too small.

Protobuf type google.cloud.retail.v2beta.Image

Inheritance

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

Implements

ImageOrBuilder

Static Fields

HEIGHT_FIELD_NUMBER

public static final int HEIGHT_FIELD_NUMBER
Field Value
Type Description
int

URI_FIELD_NUMBER

public static final int URI_FIELD_NUMBER
Field Value
Type Description
int

WIDTH_FIELD_NUMBER

public static final int WIDTH_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Image getDefaultInstance()
Returns
Type Description
Image

getDescriptor()

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

newBuilder()

public static Image.Builder newBuilder()
Returns
Type Description
Image.Builder

newBuilder(Image prototype)

public static Image.Builder newBuilder(Image prototype)
Parameter
Name Description
prototype Image
Returns
Type Description
Image.Builder

parseDelimitedFrom(InputStream input)

public static Image parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Image
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Image parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Image
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Image parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Image
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Image parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Image
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Image parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Image
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Image parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Image
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Image parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Image
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Image parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Image
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Image parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Image
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Image parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Image
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Image parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Image
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Image parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Image
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Image> parser()
Returns
Type Description
Parser<Image>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public Image getDefaultInstanceForType()
Returns
Type Description
Image

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.

getParserForType()

public Parser<Image> getParserForType()
Returns
Type Description
Parser<Image>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Image.Builder newBuilderForType()
Returns
Type Description
Image.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Image.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Image.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Image.Builder toBuilder()
Returns
Type Description
Image.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException