Package com.commercetools.api.models.error

Interface PendingOperationError

All Superinterfaces:

ErrorObject

All Known Implementing Classes:

PendingOperationErrorImpl

public interface PendingOperationError
extends ErrorObject

Returned when a previous conflicting operation is still pending and needs to finish before the request can succeed.

The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. If the error persists, report it using the Support Portal.

Example to create an instance using the builder pattern

     PendingOperationError pendingOperationError = PendingOperationError.builder()
             .message("{message}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PENDING_OPERATION	discriminator value for PendingOperationError

Method Summary

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

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

setValue, values, withErrorObject

Field Details

PENDING_OPERATION

static final String PENDING_OPERATION

discriminator value for PendingOperationError

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

factory method

Returns:

instance of PendingOperationError

of

static PendingOperationError of(PendingOperationError template)

factory method to create a shallow copy PendingOperationError

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static PendingOperationError deepCopy(@Nullable
 PendingOperationError template)

factory method to create a deep copy of PendingOperationError

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static PendingOperationErrorBuilder builder()

builder factory method for PendingOperationError

Returns:

builder

builder

static PendingOperationErrorBuilder builder(PendingOperationError template)

create builder for PendingOperationError instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withPendingOperationError

default <T> T withPendingOperationError(Function<PendingOperationError,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<PendingOperationError> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference