Package com.commercetools.api.models.error

Interface SearchExecutionFailureError

All Superinterfaces:

ErrorObject

All Known Implementing Classes:

SearchExecutionFailureErrorImpl

public interface SearchExecutionFailureError
extends ErrorObject

Returned when a search query could not be completed due to an unexpected failure.

Example to create an instance using the builder pattern

     SearchExecutionFailureError searchExecutionFailureError = SearchExecutionFailureError.builder()
             .message("{message}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SEARCH_EXECUTION_FAILURE	discriminator value for SearchExecutionFailureError

Method Summary

Modifier and Type	Method	Description
static SearchExecutionFailureErrorBuilder	builder()	builder factory method for SearchExecutionFailureError
static SearchExecutionFailureErrorBuilder	builder(SearchExecutionFailureError template)	create builder for SearchExecutionFailureError instance
static SearchExecutionFailureError	deepCopy(SearchExecutionFailureError template)	factory method to create a deep copy of SearchExecutionFailureError
@NotNull String	getCode()	Error identifier.
@NotNull String	getMessage()	"Something went wrong during the search query execution.

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

setValue, values, withErrorObject

Field Details

SEARCH_EXECUTION_FAILURE

static final String SEARCH_EXECUTION_FAILURE

discriminator value for SearchExecutionFailureError

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()

"Something went wrong during the search query execution. In most case this happens due to usage of non-existing fields and custom product attributes. Please verify all filters and facets in your search query and make sure that all paths are correct."

Specified by:

getMessage in interface ErrorObject

Returns:

message

setMessage

void setMessage(String message)

"Something went wrong during the search query execution. In most case this happens due to usage of non-existing fields and custom product attributes. Please verify all filters and facets in your search query and make sure that all paths are correct."

Specified by:

setMessage in interface ErrorObject

Parameters:

message - value to be set

of

static SearchExecutionFailureError of()

factory method

Returns:

instance of SearchExecutionFailureError

of

static SearchExecutionFailureError of(SearchExecutionFailureError template)

factory method to create a shallow copy SearchExecutionFailureError

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static SearchExecutionFailureError deepCopy(@Nullable
 SearchExecutionFailureError template)

factory method to create a deep copy of SearchExecutionFailureError

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static SearchExecutionFailureErrorBuilder builder()

builder factory method for SearchExecutionFailureError

Returns:

builder

builder

static SearchExecutionFailureErrorBuilder builder(SearchExecutionFailureError template)

create builder for SearchExecutionFailureError instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withSearchExecutionFailureError

default <T> T withSearchExecutionFailureError(Function<SearchExecutionFailureError,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<SearchExecutionFailureError> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference