public interface CustomAttributeOrBuilder extends MessageOrBuilder
Implements
MessageOrBuilderMethods
getIndexable() (deprecated)
public abstract boolean getIndexable()
Deprecated. google.cloud.retail.v2alpha.CustomAttribute.indexable is deprecated. See google/cloud/retail/v2alpha/common.proto;l=444
This field is normally ignored unless AttributesConfig.attribute_config_level of the Catalog is set to the deprecated 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG' mode. For information about product-level attribute configuration, see Configuration modes. If true, custom attribute values are indexed, so that they can be filtered, faceted or boosted in SearchService.Search. This field is ignored in a UserEvent. See SearchRequest.filter, SearchRequest.facet_specs and SearchRequest.boost_spec for more details.
optional bool indexable = 4 [deprecated = true];
Type | Description |
boolean | The indexable. |
getNumbers(int index)
public abstract double getNumbers(int index)
The numerical values of this custom attribute. For example, [2.3, 15.4]
when the key is "lengths_cm".
Exactly one of text or
numbers should be
set. Otherwise, an INVALID_ARGUMENT error is returned.
repeated double numbers = 2;
Name | Description |
index | int The index of the element to return. |
Type | Description |
double | The numbers at the given index. |
getNumbersCount()
public abstract int getNumbersCount()
The numerical values of this custom attribute. For example, [2.3, 15.4]
when the key is "lengths_cm".
Exactly one of text or
numbers should be
set. Otherwise, an INVALID_ARGUMENT error is returned.
repeated double numbers = 2;
Type | Description |
int | The count of numbers. |
getNumbersList()
public abstract List<Double> getNumbersList()
The numerical values of this custom attribute. For example, [2.3, 15.4]
when the key is "lengths_cm".
Exactly one of text or
numbers should be
set. Otherwise, an INVALID_ARGUMENT error is returned.
repeated double numbers = 2;
Type | Description |
List<Double> | A list containing the numbers. |
getSearchable() (deprecated)
public abstract boolean getSearchable()
Deprecated. google.cloud.retail.v2alpha.CustomAttribute.searchable is deprecated. See google/cloud/retail/v2alpha/common.proto;l=423
This field is normally ignored unless AttributesConfig.attribute_config_level of the Catalog is set to the deprecated 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG' mode. For information about product-level attribute configuration, see Configuration modes. If true, custom attribute values are searchable by text queries in SearchService.Search. This field is ignored in a UserEvent. Only set if type text is set. Otherwise, a INVALID_ARGUMENT error is returned.
optional bool searchable = 3 [deprecated = true];
Type | Description |
boolean | The searchable. |
getText(int index)
public abstract String getText(int index)
The textual values of this custom attribute. For example, ["yellow",
"green"]
when the key is "color".
Empty string is not allowed. Otherwise, an INVALID_ARGUMENT error is
returned.
Exactly one of text or
numbers should be
set. Otherwise, an INVALID_ARGUMENT error is returned.
repeated string text = 1;
Name | Description |
index | int The index of the element to return. |
Type | Description |
String | The text at the given index. |
getTextBytes(int index)
public abstract ByteString getTextBytes(int index)
The textual values of this custom attribute. For example, ["yellow",
"green"]
when the key is "color".
Empty string is not allowed. Otherwise, an INVALID_ARGUMENT error is
returned.
Exactly one of text or
numbers should be
set. Otherwise, an INVALID_ARGUMENT error is returned.
repeated string text = 1;
Name | Description |
index | int The index of the value to return. |
Type | Description |
ByteString | The bytes of the text at the given index. |
getTextCount()
public abstract int getTextCount()
The textual values of this custom attribute. For example, ["yellow",
"green"]
when the key is "color".
Empty string is not allowed. Otherwise, an INVALID_ARGUMENT error is
returned.
Exactly one of text or
numbers should be
set. Otherwise, an INVALID_ARGUMENT error is returned.
repeated string text = 1;
Type | Description |
int | The count of text. |
getTextList()
public abstract List<String> getTextList()
The textual values of this custom attribute. For example, ["yellow",
"green"]
when the key is "color".
Empty string is not allowed. Otherwise, an INVALID_ARGUMENT error is
returned.
Exactly one of text or
numbers should be
set. Otherwise, an INVALID_ARGUMENT error is returned.
repeated string text = 1;
Type | Description |
List<String> | A list containing the text. |
hasIndexable() (deprecated)
public abstract boolean hasIndexable()
Deprecated. google.cloud.retail.v2alpha.CustomAttribute.indexable is deprecated. See google/cloud/retail/v2alpha/common.proto;l=444
This field is normally ignored unless AttributesConfig.attribute_config_level of the Catalog is set to the deprecated 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG' mode. For information about product-level attribute configuration, see Configuration modes. If true, custom attribute values are indexed, so that they can be filtered, faceted or boosted in SearchService.Search. This field is ignored in a UserEvent. See SearchRequest.filter, SearchRequest.facet_specs and SearchRequest.boost_spec for more details.
optional bool indexable = 4 [deprecated = true];
Type | Description |
boolean | Whether the indexable field is set. |
hasSearchable() (deprecated)
public abstract boolean hasSearchable()
Deprecated. google.cloud.retail.v2alpha.CustomAttribute.searchable is deprecated. See google/cloud/retail/v2alpha/common.proto;l=423
This field is normally ignored unless AttributesConfig.attribute_config_level of the Catalog is set to the deprecated 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG' mode. For information about product-level attribute configuration, see Configuration modes. If true, custom attribute values are searchable by text queries in SearchService.Search. This field is ignored in a UserEvent. Only set if type text is set. Otherwise, a INVALID_ARGUMENT error is returned.
optional bool searchable = 3 [deprecated = true];
Type | Description |
boolean | Whether the searchable field is set. |