Package com.commercetools.api.models.error

Interface OverCapacityError

All Superinterfaces:

ErrorObject

All Known Implementing Classes:

OverCapacityErrorImpl

public interface OverCapacityError
extends ErrorObject

Returned when the service is having trouble handling the load.

The client application should retry the request with exponential backoff up to a point where further delay is unacceptable.

Example to create an instance using the builder pattern

     OverCapacityError overCapacityError = OverCapacityError.builder()
             .message("{message}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	OVER_CAPACITY	discriminator value for OverCapacityError

Method Summary

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

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

setValue, values, withErrorObject

Field Details

OVER_CAPACITY

static final String OVER_CAPACITY

discriminator value for OverCapacityError

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

factory method

Returns:

instance of OverCapacityError

of

static OverCapacityError of(OverCapacityError template)

factory method to create a shallow copy OverCapacityError

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static OverCapacityError deepCopy(@Nullable
 OverCapacityError template)

factory method to create a deep copy of OverCapacityError

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static OverCapacityErrorBuilder builder()

builder factory method for OverCapacityError

Returns:

builder

builder

static OverCapacityErrorBuilder builder(OverCapacityError template)

create builder for OverCapacityError instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withOverCapacityError

default <T> T withOverCapacityError(Function<OverCapacityError,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

typeReference

static com.fasterxml.jackson.core.type.TypeReference<OverCapacityError> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference