- 2.55.0 (latest)
- 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 CatalogAttribute.Builder extends GeneratedMessageV3.Builder<CatalogAttribute.Builder> implements CatalogAttributeOrBuilderCatalog level attribute config for an attribute. For example, if customers want to enable/disable facet for a specific attribute.
Protobuf type google.cloud.retail.v2alpha.CatalogAttribute
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > CatalogAttribute.BuilderImplements
CatalogAttributeOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public CatalogAttribute.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.Builder |
|
build()
public CatalogAttribute build()| Returns | |
|---|---|
| Type | Description |
CatalogAttribute |
|
buildPartial()
public CatalogAttribute buildPartial()| Returns | |
|---|---|
| Type | Description |
CatalogAttribute |
|
clear()
public CatalogAttribute.Builder clear()| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.Builder |
|
clearDynamicFacetableOption()
public CatalogAttribute.Builder clearDynamicFacetableOption()If DYNAMIC_FACETABLE_ENABLED, attribute values are available for dynamic facet. Could only be DYNAMIC_FACETABLE_DISABLED if CatalogAttribute.indexable_option is INDEXABLE_DISABLED. Otherwise, an INVALID_ARGUMENT error is returned.
Must be specified, otherwise throws INVALID_FORMAT error.
.google.cloud.retail.v2alpha.CatalogAttribute.DynamicFacetableOption dynamic_facetable_option = 6;
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.Builder |
This builder for chaining. |
clearExactSearchableOption()
public CatalogAttribute.Builder clearExactSearchableOption()If EXACT_SEARCHABLE_ENABLED, attribute values will be exact searchable. This property only applies to textual custom attributes and requires indexable set to enabled to enable exact-searchable. If unset, the server behavior defaults to EXACT_SEARCHABLE_DISABLED.
.google.cloud.retail.v2alpha.CatalogAttribute.ExactSearchableOption exact_searchable_option = 11;
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.Builder |
This builder for chaining. |
clearFacetConfig()
public CatalogAttribute.Builder clearFacetConfig()Contains facet options.
.google.cloud.retail.v2alpha.CatalogAttribute.FacetConfig facet_config = 13;
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.Builder |
|
clearField(Descriptors.FieldDescriptor field)
public CatalogAttribute.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.Builder |
|
clearInUse()
public CatalogAttribute.Builder clearInUse() Output only. Indicates whether this attribute has been used by any
products. True if at least one
Product is using this attribute in
Product.attributes.
Otherwise, this field is False.
CatalogAttribute can be
pre-loaded by using
CatalogService.AddCatalogAttribute,
CatalogService.ImportCatalogAttributes,
or
CatalogService.UpdateAttributesConfig
APIs. This field is False for pre-loaded
CatalogAttributes.
Only pre-loaded catalog attributes that are neither in use by products nor predefined can be deleted. Catalog attributes that are either in use by products or are predefined attributes cannot be deleted; however, their configuration properties will reset to default values upon removal request.
After catalog changes, it takes about 10 minutes for this field to update.
bool in_use = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.Builder |
This builder for chaining. |
clearIndexableOption()
public CatalogAttribute.Builder clearIndexableOption()When AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if INDEXABLE_ENABLED attribute values are indexed so that it can be filtered, faceted, or boosted in SearchService.Search.
Must be specified when AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, otherwise throws INVALID_FORMAT error.
.google.cloud.retail.v2alpha.CatalogAttribute.IndexableOption indexable_option = 5;
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.Builder |
This builder for chaining. |
clearKey()
public CatalogAttribute.Builder clearKey() Required. Attribute name.
For example: color, brands, attributes.custom_attribute, such as
attributes.xyz.
To be indexable, the attribute name can contain only alpha-numeric
characters and underscores. For example, an attribute named
attributes.abc_xyz can be indexed, but an attribute named
attributes.abc-xyz cannot be indexed.
If the attribute key starts with attributes., then the attribute is a
custom attribute. Attributes such as brands, patterns, and title are
built-in and called system attributes.
string key = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public CatalogAttribute.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.Builder |
|
clearRecommendationsFilteringOption()
public CatalogAttribute.Builder clearRecommendationsFilteringOption()When AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if RECOMMENDATIONS_FILTERING_ENABLED, attribute values are filterable for recommendations. This option works for categorical features only, does not work for numerical features, inventory filtering.
.google.cloud.retail.v2alpha.RecommendationsFilteringOption recommendations_filtering_option = 8;
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.Builder |
This builder for chaining. |
clearRetrievableOption()
public CatalogAttribute.Builder clearRetrievableOption()If RETRIEVABLE_ENABLED, attribute values are retrievable in the search results. If unset, the server behavior defaults to RETRIEVABLE_DISABLED.
.google.cloud.retail.v2alpha.CatalogAttribute.RetrievableOption retrievable_option = 12;
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.Builder |
This builder for chaining. |
clearSearchableOption()
public CatalogAttribute.Builder clearSearchableOption()When AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if SEARCHABLE_ENABLED, attribute values are searchable by text queries in SearchService.Search.
If SEARCHABLE_ENABLED but attribute type is numerical, attribute values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical attributes.
Must be specified, when AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, otherwise throws INVALID_FORMAT error.
.google.cloud.retail.v2alpha.CatalogAttribute.SearchableOption searchable_option = 7;
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.Builder |
This builder for chaining. |
clearType()
public CatalogAttribute.Builder clearType()Output only. The type of this attribute. This is derived from the attribute in Product.attributes.
.google.cloud.retail.v2alpha.CatalogAttribute.AttributeType type = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.Builder |
This builder for chaining. |
clone()
public CatalogAttribute.Builder clone()| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.Builder |
|
getDefaultInstanceForType()
public CatalogAttribute getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
CatalogAttribute |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getDynamicFacetableOption()
public CatalogAttribute.DynamicFacetableOption getDynamicFacetableOption()If DYNAMIC_FACETABLE_ENABLED, attribute values are available for dynamic facet. Could only be DYNAMIC_FACETABLE_DISABLED if CatalogAttribute.indexable_option is INDEXABLE_DISABLED. Otherwise, an INVALID_ARGUMENT error is returned.
Must be specified, otherwise throws INVALID_FORMAT error.
.google.cloud.retail.v2alpha.CatalogAttribute.DynamicFacetableOption dynamic_facetable_option = 6;
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.DynamicFacetableOption |
The dynamicFacetableOption. |
getDynamicFacetableOptionValue()
public int getDynamicFacetableOptionValue()If DYNAMIC_FACETABLE_ENABLED, attribute values are available for dynamic facet. Could only be DYNAMIC_FACETABLE_DISABLED if CatalogAttribute.indexable_option is INDEXABLE_DISABLED. Otherwise, an INVALID_ARGUMENT error is returned.
Must be specified, otherwise throws INVALID_FORMAT error.
.google.cloud.retail.v2alpha.CatalogAttribute.DynamicFacetableOption dynamic_facetable_option = 6;
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for dynamicFacetableOption. |
getExactSearchableOption()
public CatalogAttribute.ExactSearchableOption getExactSearchableOption()If EXACT_SEARCHABLE_ENABLED, attribute values will be exact searchable. This property only applies to textual custom attributes and requires indexable set to enabled to enable exact-searchable. If unset, the server behavior defaults to EXACT_SEARCHABLE_DISABLED.
.google.cloud.retail.v2alpha.CatalogAttribute.ExactSearchableOption exact_searchable_option = 11;
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.ExactSearchableOption |
The exactSearchableOption. |
getExactSearchableOptionValue()
public int getExactSearchableOptionValue()If EXACT_SEARCHABLE_ENABLED, attribute values will be exact searchable. This property only applies to textual custom attributes and requires indexable set to enabled to enable exact-searchable. If unset, the server behavior defaults to EXACT_SEARCHABLE_DISABLED.
.google.cloud.retail.v2alpha.CatalogAttribute.ExactSearchableOption exact_searchable_option = 11;
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for exactSearchableOption. |
getFacetConfig()
public CatalogAttribute.FacetConfig getFacetConfig()Contains facet options.
.google.cloud.retail.v2alpha.CatalogAttribute.FacetConfig facet_config = 13;
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.FacetConfig |
The facetConfig. |
getFacetConfigBuilder()
public CatalogAttribute.FacetConfig.Builder getFacetConfigBuilder()Contains facet options.
.google.cloud.retail.v2alpha.CatalogAttribute.FacetConfig facet_config = 13;
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.FacetConfig.Builder |
|
getFacetConfigOrBuilder()
public CatalogAttribute.FacetConfigOrBuilder getFacetConfigOrBuilder()Contains facet options.
.google.cloud.retail.v2alpha.CatalogAttribute.FacetConfig facet_config = 13;
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.FacetConfigOrBuilder |
|
getInUse()
public boolean getInUse() Output only. Indicates whether this attribute has been used by any
products. True if at least one
Product is using this attribute in
Product.attributes.
Otherwise, this field is False.
CatalogAttribute can be
pre-loaded by using
CatalogService.AddCatalogAttribute,
CatalogService.ImportCatalogAttributes,
or
CatalogService.UpdateAttributesConfig
APIs. This field is False for pre-loaded
CatalogAttributes.
Only pre-loaded catalog attributes that are neither in use by products nor predefined can be deleted. Catalog attributes that are either in use by products or are predefined attributes cannot be deleted; however, their configuration properties will reset to default values upon removal request.
After catalog changes, it takes about 10 minutes for this field to update.
bool in_use = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
The inUse. |
getIndexableOption()
public CatalogAttribute.IndexableOption getIndexableOption()When AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if INDEXABLE_ENABLED attribute values are indexed so that it can be filtered, faceted, or boosted in SearchService.Search.
Must be specified when AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, otherwise throws INVALID_FORMAT error.
.google.cloud.retail.v2alpha.CatalogAttribute.IndexableOption indexable_option = 5;
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.IndexableOption |
The indexableOption. |
getIndexableOptionValue()
public int getIndexableOptionValue()When AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if INDEXABLE_ENABLED attribute values are indexed so that it can be filtered, faceted, or boosted in SearchService.Search.
Must be specified when AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, otherwise throws INVALID_FORMAT error.
.google.cloud.retail.v2alpha.CatalogAttribute.IndexableOption indexable_option = 5;
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for indexableOption. |
getKey()
public String getKey() Required. Attribute name.
For example: color, brands, attributes.custom_attribute, such as
attributes.xyz.
To be indexable, the attribute name can contain only alpha-numeric
characters and underscores. For example, an attribute named
attributes.abc_xyz can be indexed, but an attribute named
attributes.abc-xyz cannot be indexed.
If the attribute key starts with attributes., then the attribute is a
custom attribute. Attributes such as brands, patterns, and title are
built-in and called system attributes.
string key = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
String |
The key. |
getKeyBytes()
public ByteString getKeyBytes() Required. Attribute name.
For example: color, brands, attributes.custom_attribute, such as
attributes.xyz.
To be indexable, the attribute name can contain only alpha-numeric
characters and underscores. For example, an attribute named
attributes.abc_xyz can be indexed, but an attribute named
attributes.abc-xyz cannot be indexed.
If the attribute key starts with attributes., then the attribute is a
custom attribute. Attributes such as brands, patterns, and title are
built-in and called system attributes.
string key = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for key. |
getRecommendationsFilteringOption()
public RecommendationsFilteringOption getRecommendationsFilteringOption()When AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if RECOMMENDATIONS_FILTERING_ENABLED, attribute values are filterable for recommendations. This option works for categorical features only, does not work for numerical features, inventory filtering.
.google.cloud.retail.v2alpha.RecommendationsFilteringOption recommendations_filtering_option = 8;
| Returns | |
|---|---|
| Type | Description |
RecommendationsFilteringOption |
The recommendationsFilteringOption. |
getRecommendationsFilteringOptionValue()
public int getRecommendationsFilteringOptionValue()When AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if RECOMMENDATIONS_FILTERING_ENABLED, attribute values are filterable for recommendations. This option works for categorical features only, does not work for numerical features, inventory filtering.
.google.cloud.retail.v2alpha.RecommendationsFilteringOption recommendations_filtering_option = 8;
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for recommendationsFilteringOption. |
getRetrievableOption()
public CatalogAttribute.RetrievableOption getRetrievableOption()If RETRIEVABLE_ENABLED, attribute values are retrievable in the search results. If unset, the server behavior defaults to RETRIEVABLE_DISABLED.
.google.cloud.retail.v2alpha.CatalogAttribute.RetrievableOption retrievable_option = 12;
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.RetrievableOption |
The retrievableOption. |
getRetrievableOptionValue()
public int getRetrievableOptionValue()If RETRIEVABLE_ENABLED, attribute values are retrievable in the search results. If unset, the server behavior defaults to RETRIEVABLE_DISABLED.
.google.cloud.retail.v2alpha.CatalogAttribute.RetrievableOption retrievable_option = 12;
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for retrievableOption. |
getSearchableOption()
public CatalogAttribute.SearchableOption getSearchableOption()When AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if SEARCHABLE_ENABLED, attribute values are searchable by text queries in SearchService.Search.
If SEARCHABLE_ENABLED but attribute type is numerical, attribute values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical attributes.
Must be specified, when AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, otherwise throws INVALID_FORMAT error.
.google.cloud.retail.v2alpha.CatalogAttribute.SearchableOption searchable_option = 7;
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.SearchableOption |
The searchableOption. |
getSearchableOptionValue()
public int getSearchableOptionValue()When AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if SEARCHABLE_ENABLED, attribute values are searchable by text queries in SearchService.Search.
If SEARCHABLE_ENABLED but attribute type is numerical, attribute values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical attributes.
Must be specified, when AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, otherwise throws INVALID_FORMAT error.
.google.cloud.retail.v2alpha.CatalogAttribute.SearchableOption searchable_option = 7;
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for searchableOption. |
getType()
public CatalogAttribute.AttributeType getType()Output only. The type of this attribute. This is derived from the attribute in Product.attributes.
.google.cloud.retail.v2alpha.CatalogAttribute.AttributeType type = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.AttributeType |
The type. |
getTypeValue()
public int getTypeValue()Output only. The type of this attribute. This is derived from the attribute in Product.attributes.
.google.cloud.retail.v2alpha.CatalogAttribute.AttributeType type = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for type. |
hasFacetConfig()
public boolean hasFacetConfig()Contains facet options.
.google.cloud.retail.v2alpha.CatalogAttribute.FacetConfig facet_config = 13;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the facetConfig field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFacetConfig(CatalogAttribute.FacetConfig value)
public CatalogAttribute.Builder mergeFacetConfig(CatalogAttribute.FacetConfig value)Contains facet options.
.google.cloud.retail.v2alpha.CatalogAttribute.FacetConfig facet_config = 13;
| Parameter | |
|---|---|
| Name | Description |
value |
CatalogAttribute.FacetConfig |
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.Builder |
|
mergeFrom(CatalogAttribute other)
public CatalogAttribute.Builder mergeFrom(CatalogAttribute other)| Parameter | |
|---|---|
| Name | Description |
other |
CatalogAttribute |
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public CatalogAttribute.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public CatalogAttribute.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final CatalogAttribute.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.Builder |
|
setDynamicFacetableOption(CatalogAttribute.DynamicFacetableOption value)
public CatalogAttribute.Builder setDynamicFacetableOption(CatalogAttribute.DynamicFacetableOption value)If DYNAMIC_FACETABLE_ENABLED, attribute values are available for dynamic facet. Could only be DYNAMIC_FACETABLE_DISABLED if CatalogAttribute.indexable_option is INDEXABLE_DISABLED. Otherwise, an INVALID_ARGUMENT error is returned.
Must be specified, otherwise throws INVALID_FORMAT error.
.google.cloud.retail.v2alpha.CatalogAttribute.DynamicFacetableOption dynamic_facetable_option = 6;
| Parameter | |
|---|---|
| Name | Description |
value |
CatalogAttribute.DynamicFacetableOptionThe dynamicFacetableOption to set. |
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.Builder |
This builder for chaining. |
setDynamicFacetableOptionValue(int value)
public CatalogAttribute.Builder setDynamicFacetableOptionValue(int value)If DYNAMIC_FACETABLE_ENABLED, attribute values are available for dynamic facet. Could only be DYNAMIC_FACETABLE_DISABLED if CatalogAttribute.indexable_option is INDEXABLE_DISABLED. Otherwise, an INVALID_ARGUMENT error is returned.
Must be specified, otherwise throws INVALID_FORMAT error.
.google.cloud.retail.v2alpha.CatalogAttribute.DynamicFacetableOption dynamic_facetable_option = 6;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for dynamicFacetableOption to set. |
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.Builder |
This builder for chaining. |
setExactSearchableOption(CatalogAttribute.ExactSearchableOption value)
public CatalogAttribute.Builder setExactSearchableOption(CatalogAttribute.ExactSearchableOption value)If EXACT_SEARCHABLE_ENABLED, attribute values will be exact searchable. This property only applies to textual custom attributes and requires indexable set to enabled to enable exact-searchable. If unset, the server behavior defaults to EXACT_SEARCHABLE_DISABLED.
.google.cloud.retail.v2alpha.CatalogAttribute.ExactSearchableOption exact_searchable_option = 11;
| Parameter | |
|---|---|
| Name | Description |
value |
CatalogAttribute.ExactSearchableOptionThe exactSearchableOption to set. |
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.Builder |
This builder for chaining. |
setExactSearchableOptionValue(int value)
public CatalogAttribute.Builder setExactSearchableOptionValue(int value)If EXACT_SEARCHABLE_ENABLED, attribute values will be exact searchable. This property only applies to textual custom attributes and requires indexable set to enabled to enable exact-searchable. If unset, the server behavior defaults to EXACT_SEARCHABLE_DISABLED.
.google.cloud.retail.v2alpha.CatalogAttribute.ExactSearchableOption exact_searchable_option = 11;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for exactSearchableOption to set. |
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.Builder |
This builder for chaining. |
setFacetConfig(CatalogAttribute.FacetConfig value)
public CatalogAttribute.Builder setFacetConfig(CatalogAttribute.FacetConfig value)Contains facet options.
.google.cloud.retail.v2alpha.CatalogAttribute.FacetConfig facet_config = 13;
| Parameter | |
|---|---|
| Name | Description |
value |
CatalogAttribute.FacetConfig |
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.Builder |
|
setFacetConfig(CatalogAttribute.FacetConfig.Builder builderForValue)
public CatalogAttribute.Builder setFacetConfig(CatalogAttribute.FacetConfig.Builder builderForValue)Contains facet options.
.google.cloud.retail.v2alpha.CatalogAttribute.FacetConfig facet_config = 13;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
CatalogAttribute.FacetConfig.Builder |
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
public CatalogAttribute.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.Builder |
|
setInUse(boolean value)
public CatalogAttribute.Builder setInUse(boolean value) Output only. Indicates whether this attribute has been used by any
products. True if at least one
Product is using this attribute in
Product.attributes.
Otherwise, this field is False.
CatalogAttribute can be
pre-loaded by using
CatalogService.AddCatalogAttribute,
CatalogService.ImportCatalogAttributes,
or
CatalogService.UpdateAttributesConfig
APIs. This field is False for pre-loaded
CatalogAttributes.
Only pre-loaded catalog attributes that are neither in use by products nor predefined can be deleted. Catalog attributes that are either in use by products or are predefined attributes cannot be deleted; however, their configuration properties will reset to default values upon removal request.
After catalog changes, it takes about 10 minutes for this field to update.
bool in_use = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe inUse to set. |
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.Builder |
This builder for chaining. |
setIndexableOption(CatalogAttribute.IndexableOption value)
public CatalogAttribute.Builder setIndexableOption(CatalogAttribute.IndexableOption value)When AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if INDEXABLE_ENABLED attribute values are indexed so that it can be filtered, faceted, or boosted in SearchService.Search.
Must be specified when AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, otherwise throws INVALID_FORMAT error.
.google.cloud.retail.v2alpha.CatalogAttribute.IndexableOption indexable_option = 5;
| Parameter | |
|---|---|
| Name | Description |
value |
CatalogAttribute.IndexableOptionThe indexableOption to set. |
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.Builder |
This builder for chaining. |
setIndexableOptionValue(int value)
public CatalogAttribute.Builder setIndexableOptionValue(int value)When AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if INDEXABLE_ENABLED attribute values are indexed so that it can be filtered, faceted, or boosted in SearchService.Search.
Must be specified when AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, otherwise throws INVALID_FORMAT error.
.google.cloud.retail.v2alpha.CatalogAttribute.IndexableOption indexable_option = 5;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for indexableOption to set. |
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.Builder |
This builder for chaining. |
setKey(String value)
public CatalogAttribute.Builder setKey(String value) Required. Attribute name.
For example: color, brands, attributes.custom_attribute, such as
attributes.xyz.
To be indexable, the attribute name can contain only alpha-numeric
characters and underscores. For example, an attribute named
attributes.abc_xyz can be indexed, but an attribute named
attributes.abc-xyz cannot be indexed.
If the attribute key starts with attributes., then the attribute is a
custom attribute. Attributes such as brands, patterns, and title are
built-in and called system attributes.
string key = 1 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe key to set. |
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.Builder |
This builder for chaining. |
setKeyBytes(ByteString value)
public CatalogAttribute.Builder setKeyBytes(ByteString value) Required. Attribute name.
For example: color, brands, attributes.custom_attribute, such as
attributes.xyz.
To be indexable, the attribute name can contain only alpha-numeric
characters and underscores. For example, an attribute named
attributes.abc_xyz can be indexed, but an attribute named
attributes.abc-xyz cannot be indexed.
If the attribute key starts with attributes., then the attribute is a
custom attribute. Attributes such as brands, patterns, and title are
built-in and called system attributes.
string key = 1 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for key to set. |
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.Builder |
This builder for chaining. |
setRecommendationsFilteringOption(RecommendationsFilteringOption value)
public CatalogAttribute.Builder setRecommendationsFilteringOption(RecommendationsFilteringOption value)When AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if RECOMMENDATIONS_FILTERING_ENABLED, attribute values are filterable for recommendations. This option works for categorical features only, does not work for numerical features, inventory filtering.
.google.cloud.retail.v2alpha.RecommendationsFilteringOption recommendations_filtering_option = 8;
| Parameter | |
|---|---|
| Name | Description |
value |
RecommendationsFilteringOptionThe recommendationsFilteringOption to set. |
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.Builder |
This builder for chaining. |
setRecommendationsFilteringOptionValue(int value)
public CatalogAttribute.Builder setRecommendationsFilteringOptionValue(int value)When AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if RECOMMENDATIONS_FILTERING_ENABLED, attribute values are filterable for recommendations. This option works for categorical features only, does not work for numerical features, inventory filtering.
.google.cloud.retail.v2alpha.RecommendationsFilteringOption recommendations_filtering_option = 8;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for recommendationsFilteringOption to set. |
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public CatalogAttribute.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.Builder |
|
setRetrievableOption(CatalogAttribute.RetrievableOption value)
public CatalogAttribute.Builder setRetrievableOption(CatalogAttribute.RetrievableOption value)If RETRIEVABLE_ENABLED, attribute values are retrievable in the search results. If unset, the server behavior defaults to RETRIEVABLE_DISABLED.
.google.cloud.retail.v2alpha.CatalogAttribute.RetrievableOption retrievable_option = 12;
| Parameter | |
|---|---|
| Name | Description |
value |
CatalogAttribute.RetrievableOptionThe retrievableOption to set. |
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.Builder |
This builder for chaining. |
setRetrievableOptionValue(int value)
public CatalogAttribute.Builder setRetrievableOptionValue(int value)If RETRIEVABLE_ENABLED, attribute values are retrievable in the search results. If unset, the server behavior defaults to RETRIEVABLE_DISABLED.
.google.cloud.retail.v2alpha.CatalogAttribute.RetrievableOption retrievable_option = 12;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for retrievableOption to set. |
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.Builder |
This builder for chaining. |
setSearchableOption(CatalogAttribute.SearchableOption value)
public CatalogAttribute.Builder setSearchableOption(CatalogAttribute.SearchableOption value)When AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if SEARCHABLE_ENABLED, attribute values are searchable by text queries in SearchService.Search.
If SEARCHABLE_ENABLED but attribute type is numerical, attribute values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical attributes.
Must be specified, when AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, otherwise throws INVALID_FORMAT error.
.google.cloud.retail.v2alpha.CatalogAttribute.SearchableOption searchable_option = 7;
| Parameter | |
|---|---|
| Name | Description |
value |
CatalogAttribute.SearchableOptionThe searchableOption to set. |
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.Builder |
This builder for chaining. |
setSearchableOptionValue(int value)
public CatalogAttribute.Builder setSearchableOptionValue(int value)When AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if SEARCHABLE_ENABLED, attribute values are searchable by text queries in SearchService.Search.
If SEARCHABLE_ENABLED but attribute type is numerical, attribute values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical attributes.
Must be specified, when AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, otherwise throws INVALID_FORMAT error.
.google.cloud.retail.v2alpha.CatalogAttribute.SearchableOption searchable_option = 7;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for searchableOption to set. |
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.Builder |
This builder for chaining. |
setType(CatalogAttribute.AttributeType value)
public CatalogAttribute.Builder setType(CatalogAttribute.AttributeType value)Output only. The type of this attribute. This is derived from the attribute in Product.attributes.
.google.cloud.retail.v2alpha.CatalogAttribute.AttributeType type = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
CatalogAttribute.AttributeTypeThe type to set. |
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.Builder |
This builder for chaining. |
setTypeValue(int value)
public CatalogAttribute.Builder setTypeValue(int value)Output only. The type of this attribute. This is derived from the attribute in Product.attributes.
.google.cloud.retail.v2alpha.CatalogAttribute.AttributeType type = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for type to set. |
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final CatalogAttribute.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.Builder |
|