Package com.commercetools.api.models.agent

Interface AgentStoreAmbiguousError

All Superinterfaces:

ErrorObject

public interface AgentStoreAmbiguousError
extends ErrorObject

Returned by a /responses request when the resolved Business Unit grants multiple Stores and none could be automatically selected. To resolve this error, specify an explicit store reference in the request.

Example to create an instance using the builder pattern

     AgentStoreAmbiguousError agentStoreAmbiguousError = AgentStoreAmbiguousError.builder()
             .message("{message}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	STORE_AMBIGUOUS	discriminator value for AgentStoreAmbiguousError

Method Summary

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

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

setValue, values, withErrorObject

Field Details

STORE_AMBIGUOUS

static final String STORE_AMBIGUOUS

discriminator value for AgentStoreAmbiguousError

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

factory method

Returns:

instance of AgentStoreAmbiguousError

of

static AgentStoreAmbiguousError of(AgentStoreAmbiguousError template)

factory method to create a shallow copy AgentStoreAmbiguousError

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

AgentStoreAmbiguousError copyDeep()

Specified by:

copyDeep in interface ErrorObject

deepCopy

@Nullable
static AgentStoreAmbiguousError deepCopy(@Nullable
 AgentStoreAmbiguousError template)

factory method to create a deep copy of AgentStoreAmbiguousError

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static AgentStoreAmbiguousErrorBuilder builder()

builder factory method for AgentStoreAmbiguousError

Returns:

builder

builder

static AgentStoreAmbiguousErrorBuilder builder(AgentStoreAmbiguousError template)

create builder for AgentStoreAmbiguousError instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withAgentStoreAmbiguousError

default <T> T withAgentStoreAmbiguousError(Function<AgentStoreAmbiguousError,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<AgentStoreAmbiguousError> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference