Package com.commercetools.api.models.project

Interface ProjectChangeProductSearchIndexingEnabledAction

All Superinterfaces:

ProjectUpdateAction, ResourceUpdateAction<ProjectUpdateAction>

public interface ProjectChangeProductSearchIndexingEnabledAction
extends ProjectUpdateAction

Product Projection Search is deprecated. For Projects created after 31 August 2026, the "ProductProjectionsSearch" mode cannot be activated. Use ProductsSearch instead. For such Projects, setting enabled to true with mode "ProductProjectionsSearch" returns an InvalidOperation error.

Example to create an instance using the builder pattern

     ProjectChangeProductSearchIndexingEnabledAction projectChangeProductSearchIndexingEnabledAction = ProjectChangeProductSearchIndexingEnabledAction.builder()
             .enabled(true)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CHANGE_PRODUCT_SEARCH_INDEXING_ENABLED	discriminator value for ProjectChangeProductSearchIndexingEnabledAction

Method Summary

Modifier and Type	Method	Description
static ProjectChangeProductSearchIndexingEnabledActionBuilder	builder()	builder factory method for ProjectChangeProductSearchIndexingEnabledAction
static ProjectChangeProductSearchIndexingEnabledActionBuilder	builder(ProjectChangeProductSearchIndexingEnabledAction template)	create builder for ProjectChangeProductSearchIndexingEnabledAction instance
ProjectChangeProductSearchIndexingEnabledAction	copyDeep()
static ProjectChangeProductSearchIndexingEnabledAction	deepCopy(ProjectChangeProductSearchIndexingEnabledAction template)	factory method to create a deep copy of ProjectChangeProductSearchIndexingEnabledAction
@NotNull Boolean	getEnabled()	Whether to enable product indexing for the storefront search APIs selected by mode.
ProductSearchIndexingMode	getMode()	Controls whether the action should apply to Product Projection Search or to Product Search.
static ProjectChangeProductSearchIndexingEnabledAction	of()	factory method
static ProjectChangeProductSearchIndexingEnabledAction	of(ProjectChangeProductSearchIndexingEnabledAction template)	factory method to create a shallow copy ProjectChangeProductSearchIndexingEnabledAction
void	setEnabled(Boolean enabled)	Whether to enable product indexing for the storefront search APIs selected by mode.
void	setMode(ProductSearchIndexingMode mode)	Controls whether the action should apply to Product Projection Search or to Product Search.
static tools.jackson.core.type.TypeReference<ProjectChangeProductSearchIndexingEnabledAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withProjectChangeProductSearchIndexingEnabledAction(Function<ProjectChangeProductSearchIndexingEnabledAction,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.project.ProjectUpdateAction

getAction, withProjectUpdateAction

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

get

Field Details

CHANGE_PRODUCT_SEARCH_INDEXING_ENABLED

static final String CHANGE_PRODUCT_SEARCH_INDEXING_ENABLED

discriminator value for ProjectChangeProductSearchIndexingEnabledAction

See Also:

• Constant Field Values

Method Details

getEnabled

@NotNull
@NotNull Boolean getEnabled()

Whether to enable product indexing for the storefront search APIs selected by mode.

• If true, indexing starts for the selected API and the corresponding status changes to "Indexing". After indexing finishes, the status changes to "Activated" and the selected API becomes available.
• If false, indexing stops and the selected API become unavailable. The corresponding SearchIndexingConfiguration status changes to "Deactivated".

Returns:

enabled

getMode

ProductSearchIndexingMode getMode()

Controls whether the action should apply to Product Projection Search or to Product Search.

Returns:

mode

setEnabled

void setEnabled(Boolean enabled)

Whether to enable product indexing for the storefront search APIs selected by mode.

• If true, indexing starts for the selected API and the corresponding status changes to "Indexing". After indexing finishes, the status changes to "Activated" and the selected API becomes available.
• If false, indexing stops and the selected API become unavailable. The corresponding SearchIndexingConfiguration status changes to "Deactivated".

Parameters:

enabled - value to be set

setMode

void setMode(ProductSearchIndexingMode mode)

Controls whether the action should apply to Product Projection Search or to Product Search.

Parameters:

mode - value to be set

of

static ProjectChangeProductSearchIndexingEnabledAction of()

factory method

Returns:

instance of ProjectChangeProductSearchIndexingEnabledAction

of

static ProjectChangeProductSearchIndexingEnabledAction of(ProjectChangeProductSearchIndexingEnabledAction template)

factory method to create a shallow copy ProjectChangeProductSearchIndexingEnabledAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

ProjectChangeProductSearchIndexingEnabledAction copyDeep()

Specified by:

copyDeep in interface ProjectUpdateAction

deepCopy

@Nullable
static ProjectChangeProductSearchIndexingEnabledAction deepCopy(@Nullable
 ProjectChangeProductSearchIndexingEnabledAction template)

factory method to create a deep copy of ProjectChangeProductSearchIndexingEnabledAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ProjectChangeProductSearchIndexingEnabledActionBuilder builder()

builder factory method for ProjectChangeProductSearchIndexingEnabledAction

Returns:

builder

builder

static ProjectChangeProductSearchIndexingEnabledActionBuilder builder(ProjectChangeProductSearchIndexingEnabledAction template)

create builder for ProjectChangeProductSearchIndexingEnabledAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withProjectChangeProductSearchIndexingEnabledAction

default <T> T withProjectChangeProductSearchIndexingEnabledAction(Function<ProjectChangeProductSearchIndexingEnabledAction,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<ProjectChangeProductSearchIndexingEnabledAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference