- 2.57.0 (latest)
- 2.56.0
- 2.55.0
- 2.54.0
- 2.53.0
- 2.51.0
- 2.50.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.39.0
- 2.38.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.26.0
- 2.25.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.1
- 2.4.0
- 2.3.0
- 2.2.3
- 2.1.0
- 2.0.19
public static final class Image.Builder extends GeneratedMessageV3.Builder<Image.Builder> implements ImageOrBuilderProduct 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.BuilderImplements
ImageOrBuilderStatic 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 |
|
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 |
|
clearField(Descriptors.FieldDescriptor field)
public Image.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
Image.Builder |
|
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 |
|
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 |
|
getDefaultInstanceForType()
public Image getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
Image |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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 |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
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 |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public Image.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
Image.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Image.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Image.Builder |
|
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 |
|
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 |
intThe 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 |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final Image.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Image.Builder |
|
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 |
StringThe 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 |
ByteStringThe 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 |
intThe width to set. |
| Returns | |
|---|---|
| Type | Description |
Image.Builder |
This builder for chaining. |