Interface CustomAttributeOrBuilder (2.57.0)

Version latest

• 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 interface CustomAttributeOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getIndexable() (deprecated)

public abstract boolean getIndexable()

Deprecated. google.cloud.retail.v2alpha.CustomAttribute.indexable is deprecated. See google/cloud/retail/v2alpha/common.proto;l=532

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];

Returns
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;

Parameter
Name	Description
index	int The index of the element to return.

Returns
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;

Returns
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;

Returns
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=511

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];

Returns
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;

Parameter
Name	Description
index	int The index of the element to return.

Returns
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;

Parameter
Name	Description
index	int The index of the value to return.

Returns
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;

Returns
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;

Returns
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=532

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];

Returns
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=511

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];

Returns
Type	Description
boolean	Whether the searchable field is set.