- 2.56.0 (latest)
- 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 static final class CustomAttribute.Builder extends GeneratedMessageV3.Builder<CustomAttribute.Builder> implements CustomAttributeOrBuilder
A custom attribute that is not explicitly modeled in Product.
Protobuf type google.cloud.retail.v2alpha.CustomAttribute
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > CustomAttribute.BuilderImplements
CustomAttributeOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addAllNumbers(Iterable<? extends Double> values)
public CustomAttribute.Builder addAllNumbers(Iterable<? extends Double> values)
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 |
values |
Iterable<? extends java.lang.Double> The numbers to add. |
Returns | |
---|---|
Type | Description |
CustomAttribute.Builder |
This builder for chaining. |
addAllText(Iterable<String> values)
public CustomAttribute.Builder addAllText(Iterable<String> values)
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 |
values |
Iterable<String> The text to add. |
Returns | |
---|---|
Type | Description |
CustomAttribute.Builder |
This builder for chaining. |
addNumbers(double value)
public CustomAttribute.Builder addNumbers(double value)
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 |
value |
double The numbers to add. |
Returns | |
---|---|
Type | Description |
CustomAttribute.Builder |
This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public CustomAttribute.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
CustomAttribute.Builder |
addText(String value)
public CustomAttribute.Builder addText(String value)
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 |
value |
String The text to add. |
Returns | |
---|---|
Type | Description |
CustomAttribute.Builder |
This builder for chaining. |
addTextBytes(ByteString value)
public CustomAttribute.Builder addTextBytes(ByteString value)
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 |
value |
ByteString The bytes of the text to add. |
Returns | |
---|---|
Type | Description |
CustomAttribute.Builder |
This builder for chaining. |
build()
public CustomAttribute build()
Returns | |
---|---|
Type | Description |
CustomAttribute |
buildPartial()
public CustomAttribute buildPartial()
Returns | |
---|---|
Type | Description |
CustomAttribute |
clear()
public CustomAttribute.Builder clear()
Returns | |
---|---|
Type | Description |
CustomAttribute.Builder |
clearField(Descriptors.FieldDescriptor field)
public CustomAttribute.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field |
FieldDescriptor |
Returns | |
---|---|
Type | Description |
CustomAttribute.Builder |
clearIndexable() (deprecated)
public CustomAttribute.Builder clearIndexable()
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 |
CustomAttribute.Builder |
This builder for chaining. |
clearNumbers()
public CustomAttribute.Builder clearNumbers()
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 |
CustomAttribute.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public CustomAttribute.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof |
OneofDescriptor |
Returns | |
---|---|
Type | Description |
CustomAttribute.Builder |
clearSearchable() (deprecated)
public CustomAttribute.Builder clearSearchable()
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 |
CustomAttribute.Builder |
This builder for chaining. |
clearText()
public CustomAttribute.Builder clearText()
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 |
CustomAttribute.Builder |
This builder for chaining. |
clone()
public CustomAttribute.Builder clone()
Returns | |
---|---|
Type | Description |
CustomAttribute.Builder |
getDefaultInstanceForType()
public CustomAttribute getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
CustomAttribute |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
getIndexable() (deprecated)
public 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 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. |
getSearchable() (deprecated)
public 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 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. |
hasIndexable() (deprecated)
public 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 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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeFrom(CustomAttribute other)
public CustomAttribute.Builder mergeFrom(CustomAttribute other)
Parameter | |
---|---|
Name | Description |
other |
CustomAttribute |
Returns | |
---|---|
Type | Description |
CustomAttribute.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public CustomAttribute.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
CustomAttribute.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public CustomAttribute.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other |
Message |
Returns | |
---|---|
Type | Description |
CustomAttribute.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final CustomAttribute.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
CustomAttribute.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public CustomAttribute.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
CustomAttribute.Builder |
setIndexable(boolean value) (deprecated)
public CustomAttribute.Builder setIndexable(boolean value)
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];
Parameter | |
---|---|
Name | Description |
value |
boolean The indexable to set. |
Returns | |
---|---|
Type | Description |
CustomAttribute.Builder |
This builder for chaining. |
setNumbers(int index, double value)
public CustomAttribute.Builder setNumbers(int index, double value)
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;
Parameters | |
---|---|
Name | Description |
index |
int The index to set the value at. |
value |
double The numbers to set. |
Returns | |
---|---|
Type | Description |
CustomAttribute.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public CustomAttribute.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
Returns | |
---|---|
Type | Description |
CustomAttribute.Builder |
setSearchable(boolean value) (deprecated)
public CustomAttribute.Builder setSearchable(boolean value)
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];
Parameter | |
---|---|
Name | Description |
value |
boolean The searchable to set. |
Returns | |
---|---|
Type | Description |
CustomAttribute.Builder |
This builder for chaining. |
setText(int index, String value)
public CustomAttribute.Builder setText(int index, String value)
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;
Parameters | |
---|---|
Name | Description |
index |
int The index to set the value at. |
value |
String The text to set. |
Returns | |
---|---|
Type | Description |
CustomAttribute.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final CustomAttribute.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
CustomAttribute.Builder |