Package com.commercetools.api.models.error

Interface GraphQLOverCapacityError

All Superinterfaces:

GraphQLErrorObject

public interface GraphQLOverCapacityError
extends GraphQLErrorObject

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

     GraphQLOverCapacityError graphQLOverCapacityError = GraphQLOverCapacityError.builder()
             .build()
 

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static GraphQLOverCapacityErrorBuilder	builder()	builder factory method for GraphQLOverCapacityError
static GraphQLOverCapacityErrorBuilder	builder(GraphQLOverCapacityError template)	create builder for GraphQLOverCapacityError instance
static GraphQLOverCapacityError	deepCopy(GraphQLOverCapacityError template)	factory method to create a deep copy of GraphQLOverCapacityError
@NotNull String	getCode()	One of the error codes that is listed on the Errors page.
static GraphQLOverCapacityError	of()	factory method
static GraphQLOverCapacityError	of(GraphQLOverCapacityError template)	factory method to create a shallow copy GraphQLOverCapacityError
static com.fasterxml.jackson.core.type.TypeReference<GraphQLOverCapacityError>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withGraphQLOverCapacityError(Function<GraphQLOverCapacityError,T> helper)	accessor map function

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

setValue, values, withGraphQLErrorObject

Field Details

OVER_CAPACITY

static final String OVER_CAPACITY

discriminator value for GraphQLOverCapacityError

See Also:

• Constant Field Values

Method Details

getCode

@NotNull
@NotNull String getCode()

Description copied from interface: GraphQLErrorObject

One of the error codes that is listed on the Errors page.

Specified by:

getCode in interface GraphQLErrorObject

Returns:

code

of

static GraphQLOverCapacityError of()

factory method

Returns:

instance of GraphQLOverCapacityError

of

static GraphQLOverCapacityError of(GraphQLOverCapacityError template)

factory method to create a shallow copy GraphQLOverCapacityError

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static GraphQLOverCapacityError deepCopy(@Nullable
 GraphQLOverCapacityError template)

factory method to create a deep copy of GraphQLOverCapacityError

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static GraphQLOverCapacityErrorBuilder builder()

builder factory method for GraphQLOverCapacityError

Returns:

builder

builder

static GraphQLOverCapacityErrorBuilder builder(GraphQLOverCapacityError template)

create builder for GraphQLOverCapacityError instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withGraphQLOverCapacityError

default <T> T withGraphQLOverCapacityError(Function<GraphQLOverCapacityError,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<GraphQLOverCapacityError> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference