public final class CustomAttribute extends GeneratedMessageV3 implements CustomAttributeOrBuilder
A custom attribute that is not explicitly modeled in
Product.
Protobuf type google.cloud.retail.v2alpha.CustomAttribute
Static Fields
INDEXABLE_FIELD_NUMBER
public static final int INDEXABLE_FIELD_NUMBER
Field Value
NUMBERS_FIELD_NUMBER
public static final int NUMBERS_FIELD_NUMBER
Field Value
SEARCHABLE_FIELD_NUMBER
public static final int SEARCHABLE_FIELD_NUMBER
Field Value
TEXT_FIELD_NUMBER
public static final int TEXT_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static CustomAttribute getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static CustomAttribute.Builder newBuilder()
Returns
newBuilder(CustomAttribute prototype)
public static CustomAttribute.Builder newBuilder(CustomAttribute prototype)
Parameter
Returns
public static CustomAttribute parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static CustomAttribute parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static CustomAttribute parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static CustomAttribute parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static CustomAttribute parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static CustomAttribute parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static CustomAttribute parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static CustomAttribute parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static CustomAttribute parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static CustomAttribute parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static CustomAttribute parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static CustomAttribute parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<CustomAttribute> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstanceForType()
public CustomAttribute getDefaultInstanceForType()
Returns
getIndexable()
public boolean getIndexable()
This field will only be used when
AttributesConfig.attribute_config_level
of the Catalog is
'PRODUCT_LEVEL_ATTRIBUTE_CONFIG', if true, custom attribute values are
indexed, so that it 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;
| 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;
| 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;
| 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;
| Type | Description |
| List<Double> | A list containing the numbers.
|
getParserForType()
public Parser<CustomAttribute> getParserForType()
Returns
Overrides
getSearchable()
public boolean getSearchable()
This field will only be used when
AttributesConfig.attribute_config_level
of the Catalog is
'PRODUCT_LEVEL_ATTRIBUTE_CONFIG', 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;
| Type | Description |
| boolean | The searchable.
|
getSerializedSize()
public int getSerializedSize()
Returns
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;
| 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;
| 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;
| 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;
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hasIndexable()
public boolean hasIndexable()
This field will only be used when
AttributesConfig.attribute_config_level
of the Catalog is
'PRODUCT_LEVEL_ATTRIBUTE_CONFIG', if true, custom attribute values are
indexed, so that it 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;
| Type | Description |
| boolean | Whether the indexable field is set.
|
hasSearchable()
public boolean hasSearchable()
This field will only be used when
AttributesConfig.attribute_config_level
of the Catalog is
'PRODUCT_LEVEL_ATTRIBUTE_CONFIG', 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;
| Type | Description |
| boolean | Whether the searchable field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public CustomAttribute.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected CustomAttribute.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public CustomAttribute.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
