Package com.commercetools.api.models.product_type

Interface ProductTypeChangeIsSearchableAction

All Superinterfaces:

ProductTypeUpdateAction, ResourceUpdateAction<ProductTypeUpdateAction>

public interface ProductTypeChangeIsSearchableAction
extends ProductTypeUpdateAction

Following this update the Products are reindexed asynchronously to reflect this change on the search endpoint. When enabling search on an existing Attribute type definition, the constraint regarding the maximum size of a searchable Attribute will not be enforced. Instead, AttributeDefinitions exceeding this limit will be treated as not searchable and will not be available for full-text search. To use the Attribute in search, filters, or facets, set isSearchable to true for all AttributeDefinitions with the same name across different ProductTypes. If the isSearchable values are different, the Attribute isn't available for search, filters, or facets.

Example to create an instance using the builder pattern

     ProductTypeChangeIsSearchableAction productTypeChangeIsSearchableAction = ProductTypeChangeIsSearchableAction.builder()
             .attributeName("{attributeName}")
             .isSearchable(true)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CHANGE_IS_SEARCHABLE	discriminator value for ProductTypeChangeIsSearchableAction

Method Summary

Modifier and Type	Method	Description
static ProductTypeChangeIsSearchableActionBuilder	builder()	builder factory method for ProductTypeChangeIsSearchableAction
static ProductTypeChangeIsSearchableActionBuilder	builder(ProductTypeChangeIsSearchableAction template)	create builder for ProductTypeChangeIsSearchableAction instance
ProductTypeChangeIsSearchableAction	copyDeep()
static ProductTypeChangeIsSearchableAction	deepCopy(ProductTypeChangeIsSearchableAction template)	factory method to create a deep copy of ProductTypeChangeIsSearchableAction
@NotNull String	getAttributeName()	Name of the AttributeDefinition to update.
@NotNull Boolean	getIsSearchable()	Determines whether the Attribute's values can be used in full-text search queries, filters, and facets.
static ProductTypeChangeIsSearchableAction	of()	factory method
static ProductTypeChangeIsSearchableAction	of(ProductTypeChangeIsSearchableAction template)	factory method to create a shallow copy ProductTypeChangeIsSearchableAction
void	setAttributeName(String attributeName)	Name of the AttributeDefinition to update.
void	setIsSearchable(Boolean isSearchable)	Determines whether the Attribute's values can be used in full-text search queries, filters, and facets.
static tools.jackson.core.type.TypeReference<ProductTypeChangeIsSearchableAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withProductTypeChangeIsSearchableAction(Function<ProductTypeChangeIsSearchableAction,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.product_type.ProductTypeUpdateAction

getAction, withProductTypeUpdateAction

Methods inherited from interface com.commercetools.api.models.ResourceUpdateAction

get

Field Details

CHANGE_IS_SEARCHABLE

static final String CHANGE_IS_SEARCHABLE

discriminator value for ProductTypeChangeIsSearchableAction

See Also:

• Constant Field Values

Method Details

getAttributeName

@NotNull
@NotNull String getAttributeName()

Name of the AttributeDefinition to update.

Returns:

attributeName

getIsSearchable

@NotNull
@NotNull Boolean getIsSearchable()

Determines whether the Attribute's values can be used in full-text search queries, filters, and facets. See AttributeDefinition for details.

Returns:

isSearchable

setAttributeName

void setAttributeName(String attributeName)

Name of the AttributeDefinition to update.

Parameters:

attributeName - value to be set

setIsSearchable

void setIsSearchable(Boolean isSearchable)

Determines whether the Attribute's values can be used in full-text search queries, filters, and facets. See AttributeDefinition for details.

Parameters:

isSearchable - value to be set

of

static ProductTypeChangeIsSearchableAction of()

factory method

Returns:

instance of ProductTypeChangeIsSearchableAction

of

static ProductTypeChangeIsSearchableAction of(ProductTypeChangeIsSearchableAction template)

factory method to create a shallow copy ProductTypeChangeIsSearchableAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

ProductTypeChangeIsSearchableAction copyDeep()

Specified by:

copyDeep in interface ProductTypeUpdateAction

deepCopy

@Nullable
static ProductTypeChangeIsSearchableAction deepCopy(@Nullable
 ProductTypeChangeIsSearchableAction template)

factory method to create a deep copy of ProductTypeChangeIsSearchableAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ProductTypeChangeIsSearchableActionBuilder builder()

builder factory method for ProductTypeChangeIsSearchableAction

Returns:

builder

builder

static ProductTypeChangeIsSearchableActionBuilder builder(ProductTypeChangeIsSearchableAction template)

create builder for ProductTypeChangeIsSearchableAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withProductTypeChangeIsSearchableAction

default <T> T withProductTypeChangeIsSearchableAction(Function<ProductTypeChangeIsSearchableAction,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

typeReference

static tools.jackson.core.type.TypeReference<ProductTypeChangeIsSearchableAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference