com.google.cloud.retail.v2alpha

Interface CustomAttributeOrBuilder

All Superinterfaces:

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

All Known Implementing Classes:

CustomAttribute, CustomAttribute.Builder

public interface CustomAttributeOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	getIndexable() Deprecated. google.cloud.retail.v2alpha.CustomAttribute.indexable is deprecated. See google/cloud/retail/v2alpha/common.proto;l=447
double	getNumbers(int index) The numerical values of this custom attribute.
int	getNumbersCount() The numerical values of this custom attribute.
List<Double>	getNumbersList() The numerical values of this custom attribute.
boolean	getSearchable() Deprecated. google.cloud.retail.v2alpha.CustomAttribute.searchable is deprecated. See google/cloud/retail/v2alpha/common.proto;l=426
String	getText(int index) The textual values of this custom attribute.
com.google.protobuf.ByteString	getTextBytes(int index) The textual values of this custom attribute.
int	getTextCount() The textual values of this custom attribute.
List<String>	getTextList() The textual values of this custom attribute.
boolean	hasIndexable() Deprecated. google.cloud.retail.v2alpha.CustomAttribute.indexable is deprecated. See google/cloud/retail/v2alpha/common.proto;l=447
boolean	hasSearchable() Deprecated. google.cloud.retail.v2alpha.CustomAttribute.searchable is deprecated. See google/cloud/retail/v2alpha/common.proto;l=426

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

getTextList

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][google.cloud.retail.v2alpha.CustomAttribute.text] or
 [numbers][google.cloud.retail.v2alpha.CustomAttribute.numbers] should be
 set. Otherwise, an INVALID_ARGUMENT error is returned.
 

repeated string text = 1;

Returns:

A list containing the text.

getTextCount

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][google.cloud.retail.v2alpha.CustomAttribute.text] or
 [numbers][google.cloud.retail.v2alpha.CustomAttribute.numbers] should be
 set. Otherwise, an INVALID_ARGUMENT error is returned.
 

repeated string text = 1;

Returns:

The count of text.

getText

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][google.cloud.retail.v2alpha.CustomAttribute.text] or
 [numbers][google.cloud.retail.v2alpha.CustomAttribute.numbers] should be
 set. Otherwise, an INVALID_ARGUMENT error is returned.
 

repeated string text = 1;

Parameters:

index - The index of the element to return.

Returns:

The text at the given index.

getTextBytes

com.google.protobuf.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][google.cloud.retail.v2alpha.CustomAttribute.text] or
 [numbers][google.cloud.retail.v2alpha.CustomAttribute.numbers] should be
 set. Otherwise, an INVALID_ARGUMENT error is returned.
 

repeated string text = 1;

Parameters:

index - The index of the value to return.

Returns:

The bytes of the text at the given index.

getNumbersList

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][google.cloud.retail.v2alpha.CustomAttribute.text] or
 [numbers][google.cloud.retail.v2alpha.CustomAttribute.numbers] should be
 set. Otherwise, an INVALID_ARGUMENT error is returned.
 

repeated double numbers = 2;

Returns:

A list containing the numbers.

getNumbersCount

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][google.cloud.retail.v2alpha.CustomAttribute.text] or
 [numbers][google.cloud.retail.v2alpha.CustomAttribute.numbers] should be
 set. Otherwise, an INVALID_ARGUMENT error is returned.
 

repeated double numbers = 2;

Returns:

The count of numbers.

getNumbers

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][google.cloud.retail.v2alpha.CustomAttribute.text] or
 [numbers][google.cloud.retail.v2alpha.CustomAttribute.numbers] should be
 set. Otherwise, an INVALID_ARGUMENT error is returned.
 

repeated double numbers = 2;

Parameters:

index - The index of the element to return.

Returns:

The numbers at the given index.

hasSearchable

@Deprecated
boolean hasSearchable()

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

 This field is normally ignored unless
 [AttributesConfig.attribute_config_level][google.cloud.retail.v2alpha.AttributesConfig.attribute_config_level]
 of the [Catalog][google.cloud.retail.v2alpha.Catalog] is set to the
 deprecated 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG' mode. For information about
 product-level attribute configuration, see [Configuration
 modes](https://cloud.google.com/retail/docs/attribute-config#config-modes).
 If true, custom attribute values are searchable by text queries in
 [SearchService.Search][google.cloud.retail.v2alpha.SearchService.Search].

 This field is ignored in a
 [UserEvent][google.cloud.retail.v2alpha.UserEvent].

 Only set if type [text][google.cloud.retail.v2alpha.CustomAttribute.text]
 is set. Otherwise, a INVALID_ARGUMENT error is returned.
 

optional bool searchable = 3 [deprecated = true];

Returns:

Whether the searchable field is set.

getSearchable

@Deprecated
boolean getSearchable()

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

 This field is normally ignored unless
 [AttributesConfig.attribute_config_level][google.cloud.retail.v2alpha.AttributesConfig.attribute_config_level]
 of the [Catalog][google.cloud.retail.v2alpha.Catalog] is set to the
 deprecated 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG' mode. For information about
 product-level attribute configuration, see [Configuration
 modes](https://cloud.google.com/retail/docs/attribute-config#config-modes).
 If true, custom attribute values are searchable by text queries in
 [SearchService.Search][google.cloud.retail.v2alpha.SearchService.Search].

 This field is ignored in a
 [UserEvent][google.cloud.retail.v2alpha.UserEvent].

 Only set if type [text][google.cloud.retail.v2alpha.CustomAttribute.text]
 is set. Otherwise, a INVALID_ARGUMENT error is returned.
 

optional bool searchable = 3 [deprecated = true];

Returns:

The searchable.

hasIndexable

@Deprecated
boolean hasIndexable()

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

 This field is normally ignored unless
 [AttributesConfig.attribute_config_level][google.cloud.retail.v2alpha.AttributesConfig.attribute_config_level]
 of the [Catalog][google.cloud.retail.v2alpha.Catalog] is set to the
 deprecated 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG' mode. For information about
 product-level attribute configuration, see [Configuration
 modes](https://cloud.google.com/retail/docs/attribute-config#config-modes).
 If true, custom attribute values are indexed, so that they can be filtered,
 faceted or boosted in
 [SearchService.Search][google.cloud.retail.v2alpha.SearchService.Search].

 This field is ignored in a
 [UserEvent][google.cloud.retail.v2alpha.UserEvent].

 See
 [SearchRequest.filter][google.cloud.retail.v2alpha.SearchRequest.filter],
 [SearchRequest.facet_specs][google.cloud.retail.v2alpha.SearchRequest.facet_specs]
 and
 [SearchRequest.boost_spec][google.cloud.retail.v2alpha.SearchRequest.boost_spec]
 for more details.
 

optional bool indexable = 4 [deprecated = true];

Returns:

Whether the indexable field is set.

getIndexable

@Deprecated
boolean getIndexable()

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

 This field is normally ignored unless
 [AttributesConfig.attribute_config_level][google.cloud.retail.v2alpha.AttributesConfig.attribute_config_level]
 of the [Catalog][google.cloud.retail.v2alpha.Catalog] is set to the
 deprecated 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG' mode. For information about
 product-level attribute configuration, see [Configuration
 modes](https://cloud.google.com/retail/docs/attribute-config#config-modes).
 If true, custom attribute values are indexed, so that they can be filtered,
 faceted or boosted in
 [SearchService.Search][google.cloud.retail.v2alpha.SearchService.Search].

 This field is ignored in a
 [UserEvent][google.cloud.retail.v2alpha.UserEvent].

 See
 [SearchRequest.filter][google.cloud.retail.v2alpha.SearchRequest.filter],
 [SearchRequest.facet_specs][google.cloud.retail.v2alpha.SearchRequest.facet_specs]
 and
 [SearchRequest.boost_spec][google.cloud.retail.v2alpha.SearchRequest.boost_spec]
 for more details.
 

optional bool indexable = 4 [deprecated = true];

Returns:

The indexable.