Class Image (2.6.0)

public final class Image extends GeneratedMessageV3 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 Fields

HEIGHT_FIELD_NUMBER

public static final int HEIGHT_FIELD_NUMBER
Field Value
TypeDescription
int

URI_FIELD_NUMBER

public static final int URI_FIELD_NUMBER
Field Value
TypeDescription
int

WIDTH_FIELD_NUMBER

public static final int WIDTH_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Image getDefaultInstance()
Returns
TypeDescription
Image

getDescriptor()

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

newBuilder()

public static Image.Builder newBuilder()
Returns
TypeDescription
Image.Builder

newBuilder(Image prototype)

public static Image.Builder newBuilder(Image prototype)
Parameter
NameDescription
prototypeImage
Returns
TypeDescription
Image.Builder

parseDelimitedFrom(InputStream input)

public static Image parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Image
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Image parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Image
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Image parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Image
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Image parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Image
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Image parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Image
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Image parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Image
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Image parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Image
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Image parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Image
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Image parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Image
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Image parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Image
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Image parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Image
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Image parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Image
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Image> parser()
Returns
TypeDescription
Parser<Image>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public Image getDefaultInstanceForType()
Returns
TypeDescription
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
TypeDescription
int

The height.

getParserForType()

public Parser<Image> getParserForType()
Returns
TypeDescription
Parser<Image>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
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
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.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Image.Builder newBuilderForType()
Returns
TypeDescription
Image.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Image.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Image.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Image.Builder toBuilder()
Returns
TypeDescription
Image.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException