Package com.commercetools.api.models.error

Interface GraphQLMaxResourceLimitExceededError

All Superinterfaces:

GraphQLErrorObject

All Known Implementing Classes:

GraphQLMaxResourceLimitExceededErrorImpl

public interface GraphQLMaxResourceLimitExceededError
extends GraphQLErrorObject

Returned when a resource type cannot be created as it has reached its limits.

The limits must be adjusted for this resource before sending the request again.

Example to create an instance using the builder pattern

     GraphQLMaxResourceLimitExceededError graphQLMaxResourceLimitExceededError = GraphQLMaxResourceLimitExceededError.builder()
             .exceededResource(ReferenceTypeId.ASSOCIATE_ROLE)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MAX_RESOURCE_LIMIT_EXCEEDED	discriminator value for GraphQLMaxResourceLimitExceededError

Method Summary

Modifier and Type	Method	Description
static GraphQLMaxResourceLimitExceededErrorBuilder	builder()	builder factory method for GraphQLMaxResourceLimitExceededError
static GraphQLMaxResourceLimitExceededErrorBuilder	builder(GraphQLMaxResourceLimitExceededError template)	create builder for GraphQLMaxResourceLimitExceededError instance
static GraphQLMaxResourceLimitExceededError	deepCopy(GraphQLMaxResourceLimitExceededError template)	factory method to create a deep copy of GraphQLMaxResourceLimitExceededError
@NotNull String	getCode()	Error identifier.
@NotNull ReferenceTypeId	getExceededResource()	Resource type that reached its maximum limit of configured elements (for example, 100 Zones per Project).
static GraphQLMaxResourceLimitExceededError	of()	factory method
static GraphQLMaxResourceLimitExceededError	of(GraphQLMaxResourceLimitExceededError template)	factory method to create a shallow copy GraphQLMaxResourceLimitExceededError
void	setExceededResource(ReferenceTypeId exceededResource)	Resource type that reached its maximum limit of configured elements (for example, 100 Zones per Project).
static com.fasterxml.jackson.core.type.TypeReference<GraphQLMaxResourceLimitExceededError>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withGraphQLMaxResourceLimitExceededError(Function<GraphQLMaxResourceLimitExceededError,T> helper)	accessor map function

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

setValue, values, withGraphQLErrorObject

Field Details

MAX_RESOURCE_LIMIT_EXCEEDED

static final String MAX_RESOURCE_LIMIT_EXCEEDED

discriminator value for GraphQLMaxResourceLimitExceededError

See Also:

• Constant Field Values

Method Details

getCode

@NotNull
@NotNull String getCode()

Description copied from interface: GraphQLErrorObject

Error identifier.

Specified by:

getCode in interface GraphQLErrorObject

Returns:

code

getExceededResource

@NotNull
@NotNull ReferenceTypeId getExceededResource()

Resource type that reached its maximum limit of configured elements (for example, 100 Zones per Project).

Returns:

exceededResource

setExceededResource

void setExceededResource(ReferenceTypeId exceededResource)

Resource type that reached its maximum limit of configured elements (for example, 100 Zones per Project).

Parameters:

exceededResource - value to be set

of

static GraphQLMaxResourceLimitExceededError of()

factory method

Returns:

instance of GraphQLMaxResourceLimitExceededError

of

static GraphQLMaxResourceLimitExceededError of(GraphQLMaxResourceLimitExceededError template)

factory method to create a shallow copy GraphQLMaxResourceLimitExceededError

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static GraphQLMaxResourceLimitExceededError deepCopy(@Nullable
 GraphQLMaxResourceLimitExceededError template)

factory method to create a deep copy of GraphQLMaxResourceLimitExceededError

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static GraphQLMaxResourceLimitExceededErrorBuilder builder()

builder factory method for GraphQLMaxResourceLimitExceededError

Returns:

builder

builder

static GraphQLMaxResourceLimitExceededErrorBuilder builder(GraphQLMaxResourceLimitExceededError template)

create builder for GraphQLMaxResourceLimitExceededError instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withGraphQLMaxResourceLimitExceededError

default <T> T withGraphQLMaxResourceLimitExceededError(Function<GraphQLMaxResourceLimitExceededError,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<GraphQLMaxResourceLimitExceededError> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference