Package com.commercetools.api.models.agent

Interface AgentExtractionFailedError

All Superinterfaces:

ErrorObject

public interface AgentExtractionFailedError
extends ErrorObject

Returned by a /responses request when the input could not be processed due to an internal error.

Example to create an instance using the builder pattern

     AgentExtractionFailedError agentExtractionFailedError = AgentExtractionFailedError.builder()
             .message("{message}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EXTRACTION_FAILED	discriminator value for AgentExtractionFailedError

Method Summary

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

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

setValue, values, withErrorObject

Field Details

EXTRACTION_FAILED

static final String EXTRACTION_FAILED

discriminator value for AgentExtractionFailedError

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

factory method

Returns:

instance of AgentExtractionFailedError

of

static AgentExtractionFailedError of(AgentExtractionFailedError template)

factory method to create a shallow copy AgentExtractionFailedError

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

AgentExtractionFailedError copyDeep()

Specified by:

copyDeep in interface ErrorObject

deepCopy

@Nullable
static AgentExtractionFailedError deepCopy(@Nullable
 AgentExtractionFailedError template)

factory method to create a deep copy of AgentExtractionFailedError

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static AgentExtractionFailedErrorBuilder builder()

builder factory method for AgentExtractionFailedError

Returns:

builder

builder

static AgentExtractionFailedErrorBuilder builder(AgentExtractionFailedError template)

create builder for AgentExtractionFailedError instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withAgentExtractionFailedError

default <T> T withAgentExtractionFailedError(Function<AgentExtractionFailedError,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<AgentExtractionFailedError> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference