Class ColorInfo.Builder (2.26.0)

public static final class ColorInfo.Builder extends GeneratedMessageV3.Builder<ColorInfo.Builder> implements ColorInfoOrBuilder

The color information of a Product.

Protobuf type google.cloud.retail.v2.ColorInfo

Implements

ColorInfoOrBuilder

Static Methods

getDescriptor()

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

Methods

addAllColorFamilies(Iterable<String> values)

public ColorInfo.Builder addAllColorFamilies(Iterable<String> values)

The standard color families. Strongly recommended to use the following standard color groups: "Red", "Pink", "Orange", "Yellow", "Purple", "Green", "Cyan", "Blue", "Brown", "White", "Gray", "Black" and "Mixed". Normally it is expected to have only 1 color family. May consider using single "Mixed" instead of multiple values.

A maximum of 5 values are allowed. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

Google Merchant Center property color. Schema.org property Product.color.

repeated string color_families = 1;

Parameter
NameDescription
valuesIterable<String>

The colorFamilies to add.

Returns
TypeDescription
ColorInfo.Builder

This builder for chaining.

addAllColors(Iterable<String> values)

public ColorInfo.Builder addAllColors(Iterable<String> values)

The color display names, which may be different from standard color family names, such as the color aliases used in the website frontend. Normally it is expected to have only 1 color. May consider using single "Mixed" instead of multiple values.

A maximum of 75 colors are allowed. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

Google Merchant Center property color. Schema.org property Product.color.

repeated string colors = 2;

Parameter
NameDescription
valuesIterable<String>

The colors to add.

Returns
TypeDescription
ColorInfo.Builder

This builder for chaining.

addColorFamilies(String value)

public ColorInfo.Builder addColorFamilies(String value)

The standard color families. Strongly recommended to use the following standard color groups: "Red", "Pink", "Orange", "Yellow", "Purple", "Green", "Cyan", "Blue", "Brown", "White", "Gray", "Black" and "Mixed". Normally it is expected to have only 1 color family. May consider using single "Mixed" instead of multiple values.

A maximum of 5 values are allowed. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

Google Merchant Center property color. Schema.org property Product.color.

repeated string color_families = 1;

Parameter
NameDescription
valueString

The colorFamilies to add.

Returns
TypeDescription
ColorInfo.Builder

This builder for chaining.

addColorFamiliesBytes(ByteString value)

public ColorInfo.Builder addColorFamiliesBytes(ByteString value)

The standard color families. Strongly recommended to use the following standard color groups: "Red", "Pink", "Orange", "Yellow", "Purple", "Green", "Cyan", "Blue", "Brown", "White", "Gray", "Black" and "Mixed". Normally it is expected to have only 1 color family. May consider using single "Mixed" instead of multiple values.

A maximum of 5 values are allowed. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

Google Merchant Center property color. Schema.org property Product.color.

repeated string color_families = 1;

Parameter
NameDescription
valueByteString

The bytes of the colorFamilies to add.

Returns
TypeDescription
ColorInfo.Builder

This builder for chaining.

addColors(String value)

public ColorInfo.Builder addColors(String value)

The color display names, which may be different from standard color family names, such as the color aliases used in the website frontend. Normally it is expected to have only 1 color. May consider using single "Mixed" instead of multiple values.

A maximum of 75 colors are allowed. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

Google Merchant Center property color. Schema.org property Product.color.

repeated string colors = 2;

Parameter
NameDescription
valueString

The colors to add.

Returns
TypeDescription
ColorInfo.Builder

This builder for chaining.

addColorsBytes(ByteString value)

public ColorInfo.Builder addColorsBytes(ByteString value)

The color display names, which may be different from standard color family names, such as the color aliases used in the website frontend. Normally it is expected to have only 1 color. May consider using single "Mixed" instead of multiple values.

A maximum of 75 colors are allowed. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

Google Merchant Center property color. Schema.org property Product.color.

repeated string colors = 2;

Parameter
NameDescription
valueByteString

The bytes of the colors to add.

Returns
TypeDescription
ColorInfo.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public ColorInfo build()
Returns
TypeDescription
ColorInfo

buildPartial()

public ColorInfo buildPartial()
Returns
TypeDescription
ColorInfo

clear()

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

clearColorFamilies()

public ColorInfo.Builder clearColorFamilies()

The standard color families. Strongly recommended to use the following standard color groups: "Red", "Pink", "Orange", "Yellow", "Purple", "Green", "Cyan", "Blue", "Brown", "White", "Gray", "Black" and "Mixed". Normally it is expected to have only 1 color family. May consider using single "Mixed" instead of multiple values.

A maximum of 5 values are allowed. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

Google Merchant Center property color. Schema.org property Product.color.

repeated string color_families = 1;

Returns
TypeDescription
ColorInfo.Builder

This builder for chaining.

clearColors()

public ColorInfo.Builder clearColors()

The color display names, which may be different from standard color family names, such as the color aliases used in the website frontend. Normally it is expected to have only 1 color. May consider using single "Mixed" instead of multiple values.

A maximum of 75 colors are allowed. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

Google Merchant Center property color. Schema.org property Product.color.

repeated string colors = 2;

Returns
TypeDescription
ColorInfo.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public ColorInfo.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
ColorInfo.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public ColorInfo.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
ColorInfo.Builder
Overrides

clone()

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

getColorFamilies(int index)

public String getColorFamilies(int index)

The standard color families. Strongly recommended to use the following standard color groups: "Red", "Pink", "Orange", "Yellow", "Purple", "Green", "Cyan", "Blue", "Brown", "White", "Gray", "Black" and "Mixed". Normally it is expected to have only 1 color family. May consider using single "Mixed" instead of multiple values.

A maximum of 5 values are allowed. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

Google Merchant Center property color. Schema.org property Product.color.

repeated string color_families = 1;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The colorFamilies at the given index.

getColorFamiliesBytes(int index)

public ByteString getColorFamiliesBytes(int index)

The standard color families. Strongly recommended to use the following standard color groups: "Red", "Pink", "Orange", "Yellow", "Purple", "Green", "Cyan", "Blue", "Brown", "White", "Gray", "Black" and "Mixed". Normally it is expected to have only 1 color family. May consider using single "Mixed" instead of multiple values.

A maximum of 5 values are allowed. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

Google Merchant Center property color. Schema.org property Product.color.

repeated string color_families = 1;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the colorFamilies at the given index.

getColorFamiliesCount()

public int getColorFamiliesCount()

The standard color families. Strongly recommended to use the following standard color groups: "Red", "Pink", "Orange", "Yellow", "Purple", "Green", "Cyan", "Blue", "Brown", "White", "Gray", "Black" and "Mixed". Normally it is expected to have only 1 color family. May consider using single "Mixed" instead of multiple values.

A maximum of 5 values are allowed. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

Google Merchant Center property color. Schema.org property Product.color.

repeated string color_families = 1;

Returns
TypeDescription
int

The count of colorFamilies.

getColorFamiliesList()

public ProtocolStringList getColorFamiliesList()

The standard color families. Strongly recommended to use the following standard color groups: "Red", "Pink", "Orange", "Yellow", "Purple", "Green", "Cyan", "Blue", "Brown", "White", "Gray", "Black" and "Mixed". Normally it is expected to have only 1 color family. May consider using single "Mixed" instead of multiple values.

A maximum of 5 values are allowed. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

Google Merchant Center property color. Schema.org property Product.color.

repeated string color_families = 1;

Returns
TypeDescription
ProtocolStringList

A list containing the colorFamilies.

getColors(int index)

public String getColors(int index)

The color display names, which may be different from standard color family names, such as the color aliases used in the website frontend. Normally it is expected to have only 1 color. May consider using single "Mixed" instead of multiple values.

A maximum of 75 colors are allowed. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

Google Merchant Center property color. Schema.org property Product.color.

repeated string colors = 2;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The colors at the given index.

getColorsBytes(int index)

public ByteString getColorsBytes(int index)

The color display names, which may be different from standard color family names, such as the color aliases used in the website frontend. Normally it is expected to have only 1 color. May consider using single "Mixed" instead of multiple values.

A maximum of 75 colors are allowed. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

Google Merchant Center property color. Schema.org property Product.color.

repeated string colors = 2;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the colors at the given index.

getColorsCount()

public int getColorsCount()

The color display names, which may be different from standard color family names, such as the color aliases used in the website frontend. Normally it is expected to have only 1 color. May consider using single "Mixed" instead of multiple values.

A maximum of 75 colors are allowed. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

Google Merchant Center property color. Schema.org property Product.color.

repeated string colors = 2;

Returns
TypeDescription
int

The count of colors.

getColorsList()

public ProtocolStringList getColorsList()

The color display names, which may be different from standard color family names, such as the color aliases used in the website frontend. Normally it is expected to have only 1 color. May consider using single "Mixed" instead of multiple values.

A maximum of 75 colors are allowed. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

Google Merchant Center property color. Schema.org property Product.color.

repeated string colors = 2;

Returns
TypeDescription
ProtocolStringList

A list containing the colors.

getDefaultInstanceForType()

public ColorInfo getDefaultInstanceForType()
Returns
TypeDescription
ColorInfo

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(ColorInfo other)

public ColorInfo.Builder mergeFrom(ColorInfo other)
Parameter
NameDescription
otherColorInfo
Returns
TypeDescription
ColorInfo.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setColorFamilies(int index, String value)

public ColorInfo.Builder setColorFamilies(int index, String value)

The standard color families. Strongly recommended to use the following standard color groups: "Red", "Pink", "Orange", "Yellow", "Purple", "Green", "Cyan", "Blue", "Brown", "White", "Gray", "Black" and "Mixed". Normally it is expected to have only 1 color family. May consider using single "Mixed" instead of multiple values.

A maximum of 5 values are allowed. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

Google Merchant Center property color. Schema.org property Product.color.

repeated string color_families = 1;

Parameters
NameDescription
indexint

The index to set the value at.

valueString

The colorFamilies to set.

Returns
TypeDescription
ColorInfo.Builder

This builder for chaining.

setColors(int index, String value)

public ColorInfo.Builder setColors(int index, String value)

The color display names, which may be different from standard color family names, such as the color aliases used in the website frontend. Normally it is expected to have only 1 color. May consider using single "Mixed" instead of multiple values.

A maximum of 75 colors are allowed. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

Google Merchant Center property color. Schema.org property Product.color.

repeated string colors = 2;

Parameters
NameDescription
indexint

The index to set the value at.

valueString

The colors to set.

Returns
TypeDescription
ColorInfo.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

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

public ColorInfo.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
ColorInfo.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ColorInfo.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ColorInfo.Builder
Overrides