com.google.cloud.retail.v2

Interface ColorInfoOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

ColorInfo, ColorInfo.Builder

public interface ColorInfoOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getColorFamilies(int index) The standard color families.
com.google.protobuf.ByteString	getColorFamiliesBytes(int index) The standard color families.
int	getColorFamiliesCount() The standard color families.
List<String>	getColorFamiliesList() The standard color families.
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.
com.google.protobuf.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.
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.
List<String>	getColorsList() The color display names, which may be different from standard color family names, such as the color aliases used in the website frontend.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getColorFamiliesList

List<String> 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](https://support.google.com/merchants/answer/6324487). Schema.org
 property [Product.color](https://schema.org/color).
 

repeated string color_families = 1;

Returns:

A list containing the colorFamilies.

getColorFamiliesCount

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](https://support.google.com/merchants/answer/6324487). Schema.org
 property [Product.color](https://schema.org/color).
 

repeated string color_families = 1;

Returns:

The count of colorFamilies.

getColorFamilies

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](https://support.google.com/merchants/answer/6324487). Schema.org
 property [Product.color](https://schema.org/color).
 

repeated string color_families = 1;

Parameters:

index - The index of the element to return.

Returns:

The colorFamilies at the given index.

getColorFamiliesBytes

com.google.protobuf.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](https://support.google.com/merchants/answer/6324487). Schema.org
 property [Product.color](https://schema.org/color).
 

repeated string color_families = 1;

Parameters:

index - The index of the value to return.

Returns:

The bytes of the colorFamilies at the given index.

getColorsList

List<String> 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](https://support.google.com/merchants/answer/6324487). Schema.org
 property [Product.color](https://schema.org/color).
 

repeated string colors = 2;

Returns:

A list containing the colors.

getColorsCount

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](https://support.google.com/merchants/answer/6324487). Schema.org
 property [Product.color](https://schema.org/color).
 

repeated string colors = 2;

Returns:

The count of colors.

getColors

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](https://support.google.com/merchants/answer/6324487). Schema.org
 property [Product.color](https://schema.org/color).
 

repeated string colors = 2;

Parameters:

index - The index of the element to return.

Returns:

The colors at the given index.

getColorsBytes

com.google.protobuf.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](https://support.google.com/merchants/answer/6324487). Schema.org
 property [Product.color](https://schema.org/color).
 

repeated string colors = 2;

Parameters:

index - The index of the value to return.

Returns:

The bytes of the colors at the given index.