Package com.commercetools.api.models.agent

Interface AgentFeatureDisabledError

All Superinterfaces:

ErrorObject

public interface AgentFeatureDisabledError
extends ErrorObject

Returned by a /responses request when the Intake Agent is not enabled for the Project.

Example to create an instance using the builder pattern

     AgentFeatureDisabledError agentFeatureDisabledError = AgentFeatureDisabledError.builder()
             .message("{message}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FEATURE_DISABLED	discriminator value for AgentFeatureDisabledError

Method Summary

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

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

setValue, values, withErrorObject

Field Details

FEATURE_DISABLED

static final String FEATURE_DISABLED

discriminator value for AgentFeatureDisabledError

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

factory method

Returns:

instance of AgentFeatureDisabledError

of

static AgentFeatureDisabledError of(AgentFeatureDisabledError template)

factory method to create a shallow copy AgentFeatureDisabledError

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

AgentFeatureDisabledError copyDeep()

Specified by:

copyDeep in interface ErrorObject

deepCopy

@Nullable
static AgentFeatureDisabledError deepCopy(@Nullable
 AgentFeatureDisabledError template)

factory method to create a deep copy of AgentFeatureDisabledError

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static AgentFeatureDisabledErrorBuilder builder()

builder factory method for AgentFeatureDisabledError

Returns:

builder

builder

static AgentFeatureDisabledErrorBuilder builder(AgentFeatureDisabledError template)

create builder for AgentFeatureDisabledError instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withAgentFeatureDisabledError

default <T> T withAgentFeatureDisabledError(Function<AgentFeatureDisabledError,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<AgentFeatureDisabledError> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference