Package com.commercetools.api.models.agent

Interface AgentShoppingListCreationFailedError

All Superinterfaces:

ErrorObject

public interface AgentShoppingListCreationFailedError
extends ErrorObject

Returned by a /responses request when the ShoppingList could not be created, for example because the request has no verified Customer or because commercetools rejected the ShoppingList draft. No entity is created, so there is nothing to clean up.

Example to create an instance using the builder pattern

     AgentShoppingListCreationFailedError agentShoppingListCreationFailedError = AgentShoppingListCreationFailedError.builder()
             .message("{message}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SHOPPING_LIST_CREATION_FAILED	discriminator value for AgentShoppingListCreationFailedError

Method Summary

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

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

setValue, values, withErrorObject

Field Details

SHOPPING_LIST_CREATION_FAILED

static final String SHOPPING_LIST_CREATION_FAILED

discriminator value for AgentShoppingListCreationFailedError

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

factory method

Returns:

instance of AgentShoppingListCreationFailedError

of

static AgentShoppingListCreationFailedError of(AgentShoppingListCreationFailedError template)

factory method to create a shallow copy AgentShoppingListCreationFailedError

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

AgentShoppingListCreationFailedError copyDeep()

Specified by:

copyDeep in interface ErrorObject

deepCopy

@Nullable
static AgentShoppingListCreationFailedError deepCopy(@Nullable
 AgentShoppingListCreationFailedError template)

factory method to create a deep copy of AgentShoppingListCreationFailedError

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static AgentShoppingListCreationFailedErrorBuilder builder()

builder factory method for AgentShoppingListCreationFailedError

Returns:

builder

builder

static AgentShoppingListCreationFailedErrorBuilder builder(AgentShoppingListCreationFailedError template)

create builder for AgentShoppingListCreationFailedError instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withAgentShoppingListCreationFailedError

default <T> T withAgentShoppingListCreationFailedError(Function<AgentShoppingListCreationFailedError,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<AgentShoppingListCreationFailedError> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference