Class CustomAttribute (2.36.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

Static Fields

INDEXABLE_FIELD_NUMBER

public static final int INDEXABLE_FIELD_NUMBER
Field Value
TypeDescription
int

NUMBERS_FIELD_NUMBER

public static final int NUMBERS_FIELD_NUMBER
Field Value
TypeDescription
int

SEARCHABLE_FIELD_NUMBER

public static final int SEARCHABLE_FIELD_NUMBER
Field Value
TypeDescription
int

TEXT_FIELD_NUMBER

public static final int TEXT_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static CustomAttribute getDefaultInstance()
Returns
TypeDescription
CustomAttribute

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static CustomAttribute.Builder newBuilder()
Returns
TypeDescription
CustomAttribute.Builder

newBuilder(CustomAttribute prototype)

public static CustomAttribute.Builder newBuilder(CustomAttribute prototype)
Parameter
NameDescription
prototypeCustomAttribute
Returns
TypeDescription
CustomAttribute.Builder

parseDelimitedFrom(InputStream input)

public static CustomAttribute parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
CustomAttribute
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CustomAttribute parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CustomAttribute
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static CustomAttribute parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
CustomAttribute
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CustomAttribute parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CustomAttribute
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CustomAttribute parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
CustomAttribute
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CustomAttribute parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CustomAttribute
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CustomAttribute parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
CustomAttribute
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CustomAttribute parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CustomAttribute
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static CustomAttribute parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
CustomAttribute
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CustomAttribute parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CustomAttribute
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static CustomAttribute parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
CustomAttribute
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CustomAttribute parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CustomAttribute
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<CustomAttribute> parser()
Returns
TypeDescription
Parser<CustomAttribute>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public CustomAttribute getDefaultInstanceForType()
Returns
TypeDescription
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
TypeDescription
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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
List<Double>

A list containing the numbers.

getParserForType()

public Parser<CustomAttribute> getParserForType()
Returns
TypeDescription
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
TypeDescription
boolean

The searchable.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
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
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ProtocolStringList

A list containing the text.

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
TypeDescription
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
TypeDescription
boolean

Whether the searchable field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public CustomAttribute.Builder newBuilderForType()
Returns
TypeDescription
CustomAttribute.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CustomAttribute.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
CustomAttribute.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public CustomAttribute.Builder toBuilder()
Returns
TypeDescription
CustomAttribute.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException