public static final class CatalogAttribute.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<CatalogAttribute.Builder> implements CatalogAttributeOrBuilder
Catalog level attribute config for an attribute. For example, if customers want to enable/disable facet for a specific attribute.Protobuf type
google.cloud.retail.v2beta.CatalogAttribute| Modifier and Type | Method and Description |
|---|---|
CatalogAttribute.Builder |
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
CatalogAttribute |
build() |
CatalogAttribute |
buildPartial() |
CatalogAttribute.Builder |
clear() |
CatalogAttribute.Builder |
clearDynamicFacetableOption()
If DYNAMIC_FACETABLE_ENABLED, attribute values are available for dynamic
facet.
|
CatalogAttribute.Builder |
clearExactSearchableOption()
If EXACT_SEARCHABLE_ENABLED, attribute values will be exact searchable.
|
CatalogAttribute.Builder |
clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
CatalogAttribute.Builder |
clearIndexableOption()
When
[AttributesConfig.attribute_config_level][google.cloud.retail.v2beta.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][google.cloud.retail.v2beta.SearchService.Search].
|
CatalogAttribute.Builder |
clearInUse()
Output only.
|
CatalogAttribute.Builder |
clearKey()
Required.
|
CatalogAttribute.Builder |
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
CatalogAttribute.Builder |
clearRecommendationsFilteringOption()
When
[AttributesConfig.attribute_config_level][google.cloud.retail.v2beta.AttributesConfig.attribute_config_level]
is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if RECOMMENDATIONS_FILTERING_ENABLED,
attribute values are filterable for recommendations.
|
CatalogAttribute.Builder |
clearRetrievableOption()
If RETRIEVABLE_ENABLED, attribute values are retrievable in the search
results.
|
CatalogAttribute.Builder |
clearSearchableOption()
When
[AttributesConfig.attribute_config_level][google.cloud.retail.v2beta.AttributesConfig.attribute_config_level]
is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if SEARCHABLE_ENABLED, attribute values
are searchable by text queries in
[SearchService.Search][google.cloud.retail.v2beta.SearchService.Search].
|
CatalogAttribute.Builder |
clearType()
Output only.
|
CatalogAttribute.Builder |
clone() |
CatalogAttribute |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
CatalogAttribute.DynamicFacetableOption |
getDynamicFacetableOption()
If DYNAMIC_FACETABLE_ENABLED, attribute values are available for dynamic
facet.
|
int |
getDynamicFacetableOptionValue()
If DYNAMIC_FACETABLE_ENABLED, attribute values are available for dynamic
facet.
|
CatalogAttribute.ExactSearchableOption |
getExactSearchableOption()
If EXACT_SEARCHABLE_ENABLED, attribute values will be exact searchable.
|
int |
getExactSearchableOptionValue()
If EXACT_SEARCHABLE_ENABLED, attribute values will be exact searchable.
|
CatalogAttribute.IndexableOption |
getIndexableOption()
When
[AttributesConfig.attribute_config_level][google.cloud.retail.v2beta.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][google.cloud.retail.v2beta.SearchService.Search].
|
int |
getIndexableOptionValue()
When
[AttributesConfig.attribute_config_level][google.cloud.retail.v2beta.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][google.cloud.retail.v2beta.SearchService.Search].
|
boolean |
getInUse()
Output only.
|
String |
getKey()
Required.
|
com.google.protobuf.ByteString |
getKeyBytes()
Required.
|
RecommendationsFilteringOption |
getRecommendationsFilteringOption()
When
[AttributesConfig.attribute_config_level][google.cloud.retail.v2beta.AttributesConfig.attribute_config_level]
is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if RECOMMENDATIONS_FILTERING_ENABLED,
attribute values are filterable for recommendations.
|
int |
getRecommendationsFilteringOptionValue()
When
[AttributesConfig.attribute_config_level][google.cloud.retail.v2beta.AttributesConfig.attribute_config_level]
is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if RECOMMENDATIONS_FILTERING_ENABLED,
attribute values are filterable for recommendations.
|
CatalogAttribute.RetrievableOption |
getRetrievableOption()
If RETRIEVABLE_ENABLED, attribute values are retrievable in the search
results.
|
int |
getRetrievableOptionValue()
If RETRIEVABLE_ENABLED, attribute values are retrievable in the search
results.
|
CatalogAttribute.SearchableOption |
getSearchableOption()
When
[AttributesConfig.attribute_config_level][google.cloud.retail.v2beta.AttributesConfig.attribute_config_level]
is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if SEARCHABLE_ENABLED, attribute values
are searchable by text queries in
[SearchService.Search][google.cloud.retail.v2beta.SearchService.Search].
|
int |
getSearchableOptionValue()
When
[AttributesConfig.attribute_config_level][google.cloud.retail.v2beta.AttributesConfig.attribute_config_level]
is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if SEARCHABLE_ENABLED, attribute values
are searchable by text queries in
[SearchService.Search][google.cloud.retail.v2beta.SearchService.Search].
|
CatalogAttribute.AttributeType |
getType()
Output only.
|
int |
getTypeValue()
Output only.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
CatalogAttribute.Builder |
mergeFrom(CatalogAttribute other) |
CatalogAttribute.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
CatalogAttribute.Builder |
mergeFrom(com.google.protobuf.Message other) |
CatalogAttribute.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
CatalogAttribute.Builder |
setDynamicFacetableOption(CatalogAttribute.DynamicFacetableOption value)
If DYNAMIC_FACETABLE_ENABLED, attribute values are available for dynamic
facet.
|
CatalogAttribute.Builder |
setDynamicFacetableOptionValue(int value)
If DYNAMIC_FACETABLE_ENABLED, attribute values are available for dynamic
facet.
|
CatalogAttribute.Builder |
setExactSearchableOption(CatalogAttribute.ExactSearchableOption value)
If EXACT_SEARCHABLE_ENABLED, attribute values will be exact searchable.
|
CatalogAttribute.Builder |
setExactSearchableOptionValue(int value)
If EXACT_SEARCHABLE_ENABLED, attribute values will be exact searchable.
|
CatalogAttribute.Builder |
setField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
CatalogAttribute.Builder |
setIndexableOption(CatalogAttribute.IndexableOption value)
When
[AttributesConfig.attribute_config_level][google.cloud.retail.v2beta.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][google.cloud.retail.v2beta.SearchService.Search].
|
CatalogAttribute.Builder |
setIndexableOptionValue(int value)
When
[AttributesConfig.attribute_config_level][google.cloud.retail.v2beta.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][google.cloud.retail.v2beta.SearchService.Search].
|
CatalogAttribute.Builder |
setInUse(boolean value)
Output only.
|
CatalogAttribute.Builder |
setKey(String value)
Required.
|
CatalogAttribute.Builder |
setKeyBytes(com.google.protobuf.ByteString value)
Required.
|
CatalogAttribute.Builder |
setRecommendationsFilteringOption(RecommendationsFilteringOption value)
When
[AttributesConfig.attribute_config_level][google.cloud.retail.v2beta.AttributesConfig.attribute_config_level]
is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if RECOMMENDATIONS_FILTERING_ENABLED,
attribute values are filterable for recommendations.
|
CatalogAttribute.Builder |
setRecommendationsFilteringOptionValue(int value)
When
[AttributesConfig.attribute_config_level][google.cloud.retail.v2beta.AttributesConfig.attribute_config_level]
is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if RECOMMENDATIONS_FILTERING_ENABLED,
attribute values are filterable for recommendations.
|
CatalogAttribute.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
Object value) |
CatalogAttribute.Builder |
setRetrievableOption(CatalogAttribute.RetrievableOption value)
If RETRIEVABLE_ENABLED, attribute values are retrievable in the search
results.
|
CatalogAttribute.Builder |
setRetrievableOptionValue(int value)
If RETRIEVABLE_ENABLED, attribute values are retrievable in the search
results.
|
CatalogAttribute.Builder |
setSearchableOption(CatalogAttribute.SearchableOption value)
When
[AttributesConfig.attribute_config_level][google.cloud.retail.v2beta.AttributesConfig.attribute_config_level]
is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if SEARCHABLE_ENABLED, attribute values
are searchable by text queries in
[SearchService.Search][google.cloud.retail.v2beta.SearchService.Search].
|
CatalogAttribute.Builder |
setSearchableOptionValue(int value)
When
[AttributesConfig.attribute_config_level][google.cloud.retail.v2beta.AttributesConfig.attribute_config_level]
is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if SEARCHABLE_ENABLED, attribute values
are searchable by text queries in
[SearchService.Search][google.cloud.retail.v2beta.SearchService.Search].
|
CatalogAttribute.Builder |
setType(CatalogAttribute.AttributeType value)
Output only.
|
CatalogAttribute.Builder |
setTypeValue(int value)
Output only.
|
CatalogAttribute.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<CatalogAttribute.Builder>public CatalogAttribute.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<CatalogAttribute.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<CatalogAttribute.Builder>public CatalogAttribute getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic CatalogAttribute build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic CatalogAttribute buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic CatalogAttribute.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<CatalogAttribute.Builder>public CatalogAttribute.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<CatalogAttribute.Builder>public CatalogAttribute.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<CatalogAttribute.Builder>public CatalogAttribute.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<CatalogAttribute.Builder>public CatalogAttribute.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<CatalogAttribute.Builder>public CatalogAttribute.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<CatalogAttribute.Builder>public CatalogAttribute.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<CatalogAttribute.Builder>public CatalogAttribute.Builder mergeFrom(CatalogAttribute other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<CatalogAttribute.Builder>public CatalogAttribute.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<CatalogAttribute.Builder>IOExceptionpublic 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];getKey in interface CatalogAttributeOrBuilderpublic com.google.protobuf.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];getKeyBytes in interface CatalogAttributeOrBuilderpublic 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];value - The key to set.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];public CatalogAttribute.Builder setKeyBytes(com.google.protobuf.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];value - The bytes for key to set.public boolean getInUse()
Output only. Indicates whether this attribute has been used by any products. `True` if at least one [Product][google.cloud.retail.v2beta.Product] is using this attribute in [Product.attributes][google.cloud.retail.v2beta.Product.attributes]. Otherwise, this field is `False`. [CatalogAttribute][google.cloud.retail.v2beta.CatalogAttribute] can be pre-loaded by using [CatalogService.AddCatalogAttribute][google.cloud.retail.v2beta.CatalogService.AddCatalogAttribute], [CatalogService.ImportCatalogAttributes][], or [CatalogService.UpdateAttributesConfig][google.cloud.retail.v2beta.CatalogService.UpdateAttributesConfig] APIs. This field is `False` for pre-loaded [CatalogAttribute][google.cloud.retail.v2beta.CatalogAttribute]s. Only pre-loaded [catalog attributes][google.cloud.retail.v2beta.CatalogAttribute] that are neither in use by products nor predefined can be deleted. [Catalog attributes][google.cloud.retail.v2beta.CatalogAttribute] 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];getInUse in interface CatalogAttributeOrBuilderpublic CatalogAttribute.Builder setInUse(boolean value)
Output only. Indicates whether this attribute has been used by any products. `True` if at least one [Product][google.cloud.retail.v2beta.Product] is using this attribute in [Product.attributes][google.cloud.retail.v2beta.Product.attributes]. Otherwise, this field is `False`. [CatalogAttribute][google.cloud.retail.v2beta.CatalogAttribute] can be pre-loaded by using [CatalogService.AddCatalogAttribute][google.cloud.retail.v2beta.CatalogService.AddCatalogAttribute], [CatalogService.ImportCatalogAttributes][], or [CatalogService.UpdateAttributesConfig][google.cloud.retail.v2beta.CatalogService.UpdateAttributesConfig] APIs. This field is `False` for pre-loaded [CatalogAttribute][google.cloud.retail.v2beta.CatalogAttribute]s. Only pre-loaded [catalog attributes][google.cloud.retail.v2beta.CatalogAttribute] that are neither in use by products nor predefined can be deleted. [Catalog attributes][google.cloud.retail.v2beta.CatalogAttribute] 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];value - The inUse to set.public CatalogAttribute.Builder clearInUse()
Output only. Indicates whether this attribute has been used by any products. `True` if at least one [Product][google.cloud.retail.v2beta.Product] is using this attribute in [Product.attributes][google.cloud.retail.v2beta.Product.attributes]. Otherwise, this field is `False`. [CatalogAttribute][google.cloud.retail.v2beta.CatalogAttribute] can be pre-loaded by using [CatalogService.AddCatalogAttribute][google.cloud.retail.v2beta.CatalogService.AddCatalogAttribute], [CatalogService.ImportCatalogAttributes][], or [CatalogService.UpdateAttributesConfig][google.cloud.retail.v2beta.CatalogService.UpdateAttributesConfig] APIs. This field is `False` for pre-loaded [CatalogAttribute][google.cloud.retail.v2beta.CatalogAttribute]s. Only pre-loaded [catalog attributes][google.cloud.retail.v2beta.CatalogAttribute] that are neither in use by products nor predefined can be deleted. [Catalog attributes][google.cloud.retail.v2beta.CatalogAttribute] 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];public int getTypeValue()
Output only. The type of this attribute. This is derived from the attribute in [Product.attributes][google.cloud.retail.v2beta.Product.attributes].
.google.cloud.retail.v2beta.CatalogAttribute.AttributeType type = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
getTypeValue in interface CatalogAttributeOrBuilderpublic CatalogAttribute.Builder setTypeValue(int value)
Output only. The type of this attribute. This is derived from the attribute in [Product.attributes][google.cloud.retail.v2beta.Product.attributes].
.google.cloud.retail.v2beta.CatalogAttribute.AttributeType type = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
value - The enum numeric value on the wire for type to set.public CatalogAttribute.AttributeType getType()
Output only. The type of this attribute. This is derived from the attribute in [Product.attributes][google.cloud.retail.v2beta.Product.attributes].
.google.cloud.retail.v2beta.CatalogAttribute.AttributeType type = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
getType in interface CatalogAttributeOrBuilderpublic 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.v2beta.Product.attributes].
.google.cloud.retail.v2beta.CatalogAttribute.AttributeType type = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
value - The type to set.public CatalogAttribute.Builder clearType()
Output only. The type of this attribute. This is derived from the attribute in [Product.attributes][google.cloud.retail.v2beta.Product.attributes].
.google.cloud.retail.v2beta.CatalogAttribute.AttributeType type = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
public int getIndexableOptionValue()
When [AttributesConfig.attribute_config_level][google.cloud.retail.v2beta.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][google.cloud.retail.v2beta.SearchService.Search]. Must be specified, otherwise throws INVALID_FORMAT error.
.google.cloud.retail.v2beta.CatalogAttribute.IndexableOption indexable_option = 5;
getIndexableOptionValue in interface CatalogAttributeOrBuilderpublic CatalogAttribute.Builder setIndexableOptionValue(int value)
When [AttributesConfig.attribute_config_level][google.cloud.retail.v2beta.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][google.cloud.retail.v2beta.SearchService.Search]. Must be specified, otherwise throws INVALID_FORMAT error.
.google.cloud.retail.v2beta.CatalogAttribute.IndexableOption indexable_option = 5;
value - The enum numeric value on the wire for indexableOption to set.public CatalogAttribute.IndexableOption getIndexableOption()
When [AttributesConfig.attribute_config_level][google.cloud.retail.v2beta.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][google.cloud.retail.v2beta.SearchService.Search]. Must be specified, otherwise throws INVALID_FORMAT error.
.google.cloud.retail.v2beta.CatalogAttribute.IndexableOption indexable_option = 5;
getIndexableOption in interface CatalogAttributeOrBuilderpublic CatalogAttribute.Builder setIndexableOption(CatalogAttribute.IndexableOption value)
When [AttributesConfig.attribute_config_level][google.cloud.retail.v2beta.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][google.cloud.retail.v2beta.SearchService.Search]. Must be specified, otherwise throws INVALID_FORMAT error.
.google.cloud.retail.v2beta.CatalogAttribute.IndexableOption indexable_option = 5;
value - The indexableOption to set.public CatalogAttribute.Builder clearIndexableOption()
When [AttributesConfig.attribute_config_level][google.cloud.retail.v2beta.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][google.cloud.retail.v2beta.SearchService.Search]. Must be specified, otherwise throws INVALID_FORMAT error.
.google.cloud.retail.v2beta.CatalogAttribute.IndexableOption indexable_option = 5;
public int getDynamicFacetableOptionValue()
If DYNAMIC_FACETABLE_ENABLED, attribute values are available for dynamic facet. Could only be DYNAMIC_FACETABLE_DISABLED if [CatalogAttribute.indexable_option][google.cloud.retail.v2beta.CatalogAttribute.indexable_option] is INDEXABLE_DISABLED. Otherwise, an INVALID_ARGUMENT error is returned. Must be specified, otherwise throws INVALID_FORMAT error.
.google.cloud.retail.v2beta.CatalogAttribute.DynamicFacetableOption dynamic_facetable_option = 6;
getDynamicFacetableOptionValue in interface CatalogAttributeOrBuilderpublic 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][google.cloud.retail.v2beta.CatalogAttribute.indexable_option] is INDEXABLE_DISABLED. Otherwise, an INVALID_ARGUMENT error is returned. Must be specified, otherwise throws INVALID_FORMAT error.
.google.cloud.retail.v2beta.CatalogAttribute.DynamicFacetableOption dynamic_facetable_option = 6;
value - The enum numeric value on the wire for dynamicFacetableOption to set.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][google.cloud.retail.v2beta.CatalogAttribute.indexable_option] is INDEXABLE_DISABLED. Otherwise, an INVALID_ARGUMENT error is returned. Must be specified, otherwise throws INVALID_FORMAT error.
.google.cloud.retail.v2beta.CatalogAttribute.DynamicFacetableOption dynamic_facetable_option = 6;
getDynamicFacetableOption in interface CatalogAttributeOrBuilderpublic 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][google.cloud.retail.v2beta.CatalogAttribute.indexable_option] is INDEXABLE_DISABLED. Otherwise, an INVALID_ARGUMENT error is returned. Must be specified, otherwise throws INVALID_FORMAT error.
.google.cloud.retail.v2beta.CatalogAttribute.DynamicFacetableOption dynamic_facetable_option = 6;
value - The dynamicFacetableOption to set.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][google.cloud.retail.v2beta.CatalogAttribute.indexable_option] is INDEXABLE_DISABLED. Otherwise, an INVALID_ARGUMENT error is returned. Must be specified, otherwise throws INVALID_FORMAT error.
.google.cloud.retail.v2beta.CatalogAttribute.DynamicFacetableOption dynamic_facetable_option = 6;
public int getSearchableOptionValue()
When [AttributesConfig.attribute_config_level][google.cloud.retail.v2beta.AttributesConfig.attribute_config_level] is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if SEARCHABLE_ENABLED, attribute values are searchable by text queries in [SearchService.Search][google.cloud.retail.v2beta.SearchService.Search]. If SEARCHABLE_ENABLED but attribute type is numerical, attribute values will not be searchable by text queries in [SearchService.Search][google.cloud.retail.v2beta.SearchService.Search], as there are no text values associated to numerical attributes. Must be specified, otherwise throws INVALID_FORMAT error.
.google.cloud.retail.v2beta.CatalogAttribute.SearchableOption searchable_option = 7;
getSearchableOptionValue in interface CatalogAttributeOrBuilderpublic CatalogAttribute.Builder setSearchableOptionValue(int value)
When [AttributesConfig.attribute_config_level][google.cloud.retail.v2beta.AttributesConfig.attribute_config_level] is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if SEARCHABLE_ENABLED, attribute values are searchable by text queries in [SearchService.Search][google.cloud.retail.v2beta.SearchService.Search]. If SEARCHABLE_ENABLED but attribute type is numerical, attribute values will not be searchable by text queries in [SearchService.Search][google.cloud.retail.v2beta.SearchService.Search], as there are no text values associated to numerical attributes. Must be specified, otherwise throws INVALID_FORMAT error.
.google.cloud.retail.v2beta.CatalogAttribute.SearchableOption searchable_option = 7;
value - The enum numeric value on the wire for searchableOption to set.public CatalogAttribute.SearchableOption getSearchableOption()
When [AttributesConfig.attribute_config_level][google.cloud.retail.v2beta.AttributesConfig.attribute_config_level] is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if SEARCHABLE_ENABLED, attribute values are searchable by text queries in [SearchService.Search][google.cloud.retail.v2beta.SearchService.Search]. If SEARCHABLE_ENABLED but attribute type is numerical, attribute values will not be searchable by text queries in [SearchService.Search][google.cloud.retail.v2beta.SearchService.Search], as there are no text values associated to numerical attributes. Must be specified, otherwise throws INVALID_FORMAT error.
.google.cloud.retail.v2beta.CatalogAttribute.SearchableOption searchable_option = 7;
getSearchableOption in interface CatalogAttributeOrBuilderpublic CatalogAttribute.Builder setSearchableOption(CatalogAttribute.SearchableOption value)
When [AttributesConfig.attribute_config_level][google.cloud.retail.v2beta.AttributesConfig.attribute_config_level] is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if SEARCHABLE_ENABLED, attribute values are searchable by text queries in [SearchService.Search][google.cloud.retail.v2beta.SearchService.Search]. If SEARCHABLE_ENABLED but attribute type is numerical, attribute values will not be searchable by text queries in [SearchService.Search][google.cloud.retail.v2beta.SearchService.Search], as there are no text values associated to numerical attributes. Must be specified, otherwise throws INVALID_FORMAT error.
.google.cloud.retail.v2beta.CatalogAttribute.SearchableOption searchable_option = 7;
value - The searchableOption to set.public CatalogAttribute.Builder clearSearchableOption()
When [AttributesConfig.attribute_config_level][google.cloud.retail.v2beta.AttributesConfig.attribute_config_level] is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if SEARCHABLE_ENABLED, attribute values are searchable by text queries in [SearchService.Search][google.cloud.retail.v2beta.SearchService.Search]. If SEARCHABLE_ENABLED but attribute type is numerical, attribute values will not be searchable by text queries in [SearchService.Search][google.cloud.retail.v2beta.SearchService.Search], as there are no text values associated to numerical attributes. Must be specified, otherwise throws INVALID_FORMAT error.
.google.cloud.retail.v2beta.CatalogAttribute.SearchableOption searchable_option = 7;
public int getRecommendationsFilteringOptionValue()
When [AttributesConfig.attribute_config_level][google.cloud.retail.v2beta.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.v2beta.RecommendationsFilteringOption recommendations_filtering_option = 8;
getRecommendationsFilteringOptionValue in interface CatalogAttributeOrBuilderpublic CatalogAttribute.Builder setRecommendationsFilteringOptionValue(int value)
When [AttributesConfig.attribute_config_level][google.cloud.retail.v2beta.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.v2beta.RecommendationsFilteringOption recommendations_filtering_option = 8;
value - The enum numeric value on the wire for recommendationsFilteringOption to set.public RecommendationsFilteringOption getRecommendationsFilteringOption()
When [AttributesConfig.attribute_config_level][google.cloud.retail.v2beta.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.v2beta.RecommendationsFilteringOption recommendations_filtering_option = 8;
getRecommendationsFilteringOption in interface CatalogAttributeOrBuilderpublic CatalogAttribute.Builder setRecommendationsFilteringOption(RecommendationsFilteringOption value)
When [AttributesConfig.attribute_config_level][google.cloud.retail.v2beta.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.v2beta.RecommendationsFilteringOption recommendations_filtering_option = 8;
value - The recommendationsFilteringOption to set.public CatalogAttribute.Builder clearRecommendationsFilteringOption()
When [AttributesConfig.attribute_config_level][google.cloud.retail.v2beta.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.v2beta.RecommendationsFilteringOption recommendations_filtering_option = 8;
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.v2beta.CatalogAttribute.ExactSearchableOption.EXACT_SEARCHABLE_DISABLED].
.google.cloud.retail.v2beta.CatalogAttribute.ExactSearchableOption exact_searchable_option = 11;
getExactSearchableOptionValue in interface CatalogAttributeOrBuilderpublic 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.v2beta.CatalogAttribute.ExactSearchableOption.EXACT_SEARCHABLE_DISABLED].
.google.cloud.retail.v2beta.CatalogAttribute.ExactSearchableOption exact_searchable_option = 11;
value - The enum numeric value on the wire for exactSearchableOption to set.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.v2beta.CatalogAttribute.ExactSearchableOption.EXACT_SEARCHABLE_DISABLED].
.google.cloud.retail.v2beta.CatalogAttribute.ExactSearchableOption exact_searchable_option = 11;
getExactSearchableOption in interface CatalogAttributeOrBuilderpublic 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.v2beta.CatalogAttribute.ExactSearchableOption.EXACT_SEARCHABLE_DISABLED].
.google.cloud.retail.v2beta.CatalogAttribute.ExactSearchableOption exact_searchable_option = 11;
value - The exactSearchableOption to set.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.v2beta.CatalogAttribute.ExactSearchableOption.EXACT_SEARCHABLE_DISABLED].
.google.cloud.retail.v2beta.CatalogAttribute.ExactSearchableOption exact_searchable_option = 11;
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.v2beta.CatalogAttribute.RetrievableOption.RETRIEVABLE_DISABLED].
.google.cloud.retail.v2beta.CatalogAttribute.RetrievableOption retrievable_option = 12;
getRetrievableOptionValue in interface CatalogAttributeOrBuilderpublic 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.v2beta.CatalogAttribute.RetrievableOption.RETRIEVABLE_DISABLED].
.google.cloud.retail.v2beta.CatalogAttribute.RetrievableOption retrievable_option = 12;
value - The enum numeric value on the wire for retrievableOption to set.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.v2beta.CatalogAttribute.RetrievableOption.RETRIEVABLE_DISABLED].
.google.cloud.retail.v2beta.CatalogAttribute.RetrievableOption retrievable_option = 12;
getRetrievableOption in interface CatalogAttributeOrBuilderpublic 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.v2beta.CatalogAttribute.RetrievableOption.RETRIEVABLE_DISABLED].
.google.cloud.retail.v2beta.CatalogAttribute.RetrievableOption retrievable_option = 12;
value - The retrievableOption to set.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.v2beta.CatalogAttribute.RetrievableOption.RETRIEVABLE_DISABLED].
.google.cloud.retail.v2beta.CatalogAttribute.RetrievableOption retrievable_option = 12;
public final CatalogAttribute.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<CatalogAttribute.Builder>public final CatalogAttribute.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<CatalogAttribute.Builder>Copyright © 2024 Google LLC. All rights reserved.