Class CustomAttribute (2.13.0) 

public final class CustomAttribute extends GeneratedMessageV3 implements CustomAttributeOrBuilder

A custom attribute that is not explicitly modeled in Product.

Protobuf type google.cloud.retail.v2beta.CustomAttribute

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > CustomAttribute

Static Fields

INDEXABLE_FIELD_NUMBER

public static final int INDEXABLE_FIELD_NUMBER
Field Value
Type Description
int

NUMBERS_FIELD_NUMBER

public static final int NUMBERS_FIELD_NUMBER
Field Value
Type Description
int

SEARCHABLE_FIELD_NUMBER

public static final int SEARCHABLE_FIELD_NUMBER
Field Value
Type Description
int

TEXT_FIELD_NUMBER

public static final int TEXT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CustomAttribute getDefaultInstance()
Returns
Type Description
CustomAttribute

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static CustomAttribute.Builder newBuilder()
Returns
Type Description
CustomAttribute.Builder

newBuilder(CustomAttribute prototype)

public static CustomAttribute.Builder newBuilder(CustomAttribute prototype)
Parameter
Name Description
prototype CustomAttribute
Returns
Type Description
CustomAttribute.Builder

parseDelimitedFrom(InputStream input)

public static CustomAttribute parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CustomAttribute
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CustomAttribute parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CustomAttribute
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static CustomAttribute parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
CustomAttribute
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CustomAttribute parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CustomAttribute
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CustomAttribute parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
CustomAttribute
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CustomAttribute parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CustomAttribute
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CustomAttribute parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
CustomAttribute
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CustomAttribute parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CustomAttribute
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static CustomAttribute parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CustomAttribute
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CustomAttribute parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CustomAttribute
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static CustomAttribute parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
CustomAttribute
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CustomAttribute parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CustomAttribute
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<CustomAttribute> parser()
Returns
Type Description
Parser<CustomAttribute>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public CustomAttribute getDefaultInstanceForType()
Returns
Type Description
CustomAttribute

getIndexable() (deprecated)

public boolean getIndexable()

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

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 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 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 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.

getParserForType()

public Parser<CustomAttribute> getParserForType()
Returns
Type Description
Parser<CustomAttribute>
Overrides

getSearchable() (deprecated)

public boolean getSearchable()

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

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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getText(int index)

public 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 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 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 ProtocolStringList 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
ProtocolStringList

A list containing the text.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
Type Description
UnknownFieldSet
Overrides

hasIndexable() (deprecated)

public boolean hasIndexable()

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

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 boolean hasSearchable()

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

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public CustomAttribute.Builder newBuilderForType()
Returns
Type Description
CustomAttribute.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CustomAttribute.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
CustomAttribute.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public CustomAttribute.Builder toBuilder()
Returns
Type Description
CustomAttribute.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides Exceptions
Type Description
IOException