Package com.commercetools.api.models.error

Interface SearchDeactivatedError

All Superinterfaces:

ErrorObject

All Known Implementing Classes:

SearchDeactivatedErrorImpl

public interface SearchDeactivatedError
extends ErrorObject

Returned when the indexing of Product information is deactivated in a Project.

To activate indexing, call Change Product Search Indexing Enabled and set enabled to true.

Example to create an instance using the builder pattern

     SearchDeactivatedError searchDeactivatedError = SearchDeactivatedError.builder()
             .message("{message}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SEARCH_DEACTIVATED	discriminator value for SearchDeactivatedError

Method Summary

Modifier and Type	Method	Description
static SearchDeactivatedErrorBuilder	builder()	builder factory method for SearchDeactivatedError
static SearchDeactivatedErrorBuilder	builder(SearchDeactivatedError template)	create builder for SearchDeactivatedError instance
static SearchDeactivatedError	deepCopy(SearchDeactivatedError template)	factory method to create a deep copy of SearchDeactivatedError
@NotNull String	getCode()	Error identifier.
@NotNull String	getMessage()	"The endpoint is deactivated for this project.

Methods inherited from interface com.commercetools.api.models.error.ErrorObject

setValue, values, withErrorObject

Field Details

SEARCH_DEACTIVATED

static final String SEARCH_DEACTIVATED

discriminator value for SearchDeactivatedError

See Also:

• Constant Field Values

Method Details

getCode

@NotNull
@NotNull String getCode()

Description copied from interface: ErrorObject

Error identifier.

Specified by:

getCode in interface ErrorObject

Returns:

code

getMessage

@NotNull
@NotNull String getMessage()

"The endpoint is deactivated for this project. Please enable it via the Project endpoint, via the Merchant Center in the Project settings, or reach out to Support to enable it."

Specified by:

getMessage in interface ErrorObject

Returns:

message

setMessage

void setMessage(String message)

"The endpoint is deactivated for this project. Please enable it via the Project endpoint, via the Merchant Center in the Project settings, or reach out to Support to enable it."

Specified by:

setMessage in interface ErrorObject

Parameters:

message - value to be set

of

static SearchDeactivatedError of()

factory method

Returns:

instance of SearchDeactivatedError

of

static SearchDeactivatedError of(SearchDeactivatedError template)

factory method to create a shallow copy SearchDeactivatedError

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static SearchDeactivatedError deepCopy(@Nullable
 SearchDeactivatedError template)

factory method to create a deep copy of SearchDeactivatedError

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static SearchDeactivatedErrorBuilder builder()

builder factory method for SearchDeactivatedError

Returns:

builder

builder

static SearchDeactivatedErrorBuilder builder(SearchDeactivatedError template)

create builder for SearchDeactivatedError instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withSearchDeactivatedError

default <T> T withSearchDeactivatedError(Function<SearchDeactivatedError,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

typeReference

static com.fasterxml.jackson.core.type.TypeReference<SearchDeactivatedError> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference