Package com.commercetools.api.models.agent

Interface AgentProductSearchNotEnabledError

All Superinterfaces:

ErrorObject

public interface AgentProductSearchNotEnabledError
extends ErrorObject

Returned by a /responses request when Product Search is not enabled for the project.

Example to create an instance using the builder pattern

     AgentProductSearchNotEnabledError agentProductSearchNotEnabledError = AgentProductSearchNotEnabledError.builder()
             .message("{message}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PRODUCT_SEARCH_NOT_ENABLED	discriminator value for AgentProductSearchNotEnabledError

Method Summary

Modifier and Type	Method	Description
static AgentProductSearchNotEnabledErrorBuilder	builder()	builder factory method for AgentProductSearchNotEnabledError
static AgentProductSearchNotEnabledErrorBuilder	builder(AgentProductSearchNotEnabledError template)	create builder for AgentProductSearchNotEnabledError instance
AgentProductSearchNotEnabledError	copyDeep()
static AgentProductSearchNotEnabledError	deepCopy(AgentProductSearchNotEnabledError template)	factory method to create a deep copy of AgentProductSearchNotEnabledError
@NotNull String	getCode()	Error identifier.
@NotNull String	getMessage()	Plain text description of the error.
static AgentProductSearchNotEnabledError	of()	factory method
static AgentProductSearchNotEnabledError	of(AgentProductSearchNotEnabledError template)	factory method to create a shallow copy AgentProductSearchNotEnabledError
void	setMessage(String message)	Plain text description of the error.
static tools.jackson.core.type.TypeReference<AgentProductSearchNotEnabledError>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withAgentProductSearchNotEnabledError(Function<AgentProductSearchNotEnabledError,T> helper)	accessor map function

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

setValue, values, withErrorObject

Field Details

PRODUCT_SEARCH_NOT_ENABLED

static final String PRODUCT_SEARCH_NOT_ENABLED

discriminator value for AgentProductSearchNotEnabledError

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

Plain text description of the error.

Specified by:

getMessage in interface ErrorObject

Returns:

message

setMessage

void setMessage(String message)

Plain text description of the error.

Specified by:

setMessage in interface ErrorObject

Parameters:

message - value to be set

of

static AgentProductSearchNotEnabledError of()

factory method

Returns:

instance of AgentProductSearchNotEnabledError

of

static AgentProductSearchNotEnabledError of(AgentProductSearchNotEnabledError template)

factory method to create a shallow copy AgentProductSearchNotEnabledError

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

AgentProductSearchNotEnabledError copyDeep()

Specified by:

copyDeep in interface ErrorObject

deepCopy

@Nullable
static AgentProductSearchNotEnabledError deepCopy(@Nullable
 AgentProductSearchNotEnabledError template)

factory method to create a deep copy of AgentProductSearchNotEnabledError

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static AgentProductSearchNotEnabledErrorBuilder builder()

builder factory method for AgentProductSearchNotEnabledError

Returns:

builder

builder

static AgentProductSearchNotEnabledErrorBuilder builder(AgentProductSearchNotEnabledError template)

create builder for AgentProductSearchNotEnabledError instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withAgentProductSearchNotEnabledError

default <T> T withAgentProductSearchNotEnabledError(Function<AgentProductSearchNotEnabledError,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<AgentProductSearchNotEnabledError> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference