Package com.commercetools.api.models.error

Interface GraphQLBulkOperationMaxItemsExceededError

All Superinterfaces:

GraphQLErrorObject

public interface GraphQLBulkOperationMaxItemsExceededError
extends GraphQLErrorObject

Returned when a bulk request contains more items than the allowed maximum.

Reduce the number of items in the request to at most limit and retry.

Example to create an instance using the builder pattern

     GraphQLBulkOperationMaxItemsExceededError graphQLBulkOperationMaxItemsExceededError = GraphQLBulkOperationMaxItemsExceededError.builder()
             .limit(0.3)
             .provided(0.3)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BULK_OPERATION_MAX_ITEMS_EXCEEDED	discriminator value for GraphQLBulkOperationMaxItemsExceededError

Method Summary

Modifier and Type	Method	Description
static GraphQLBulkOperationMaxItemsExceededErrorBuilder	builder()	builder factory method for GraphQLBulkOperationMaxItemsExceededError
static GraphQLBulkOperationMaxItemsExceededErrorBuilder	builder(GraphQLBulkOperationMaxItemsExceededError template)	create builder for GraphQLBulkOperationMaxItemsExceededError instance
GraphQLBulkOperationMaxItemsExceededError	copyDeep()
static GraphQLBulkOperationMaxItemsExceededError	deepCopy(GraphQLBulkOperationMaxItemsExceededError template)	factory method to create a deep copy of GraphQLBulkOperationMaxItemsExceededError
@NotNull String	getCode()	One of the error codes that is listed on the Errors page.
@NotNull Integer	getLimit()	Maximum number of items allowed in a single bulk request.
@NotNull Integer	getProvided()	Number of items provided in the request.
static GraphQLBulkOperationMaxItemsExceededError	of()	factory method
static GraphQLBulkOperationMaxItemsExceededError	of(GraphQLBulkOperationMaxItemsExceededError template)	factory method to create a shallow copy GraphQLBulkOperationMaxItemsExceededError
void	setLimit(Integer limit)	Maximum number of items allowed in a single bulk request.
void	setProvided(Integer provided)	Number of items provided in the request.
static tools.jackson.core.type.TypeReference<GraphQLBulkOperationMaxItemsExceededError>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withGraphQLBulkOperationMaxItemsExceededError(Function<GraphQLBulkOperationMaxItemsExceededError,T> helper)	accessor map function

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

setValue, values, withGraphQLErrorObject

Field Details

BULK_OPERATION_MAX_ITEMS_EXCEEDED

static final String BULK_OPERATION_MAX_ITEMS_EXCEEDED

discriminator value for GraphQLBulkOperationMaxItemsExceededError

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

getLimit

@NotNull
@NotNull Integer getLimit()

Maximum number of items allowed in a single bulk request.

Returns:

limit

getProvided

@NotNull
@NotNull Integer getProvided()

Number of items provided in the request.

Returns:

provided

setLimit

void setLimit(Integer limit)

Maximum number of items allowed in a single bulk request.

Parameters:

limit - value to be set

setProvided

void setProvided(Integer provided)

Number of items provided in the request.

Parameters:

provided - value to be set

of

static GraphQLBulkOperationMaxItemsExceededError of()

factory method

Returns:

instance of GraphQLBulkOperationMaxItemsExceededError

of

static GraphQLBulkOperationMaxItemsExceededError of(GraphQLBulkOperationMaxItemsExceededError template)

factory method to create a shallow copy GraphQLBulkOperationMaxItemsExceededError

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

GraphQLBulkOperationMaxItemsExceededError copyDeep()

Specified by:

copyDeep in interface GraphQLErrorObject

deepCopy

@Nullable
static GraphQLBulkOperationMaxItemsExceededError deepCopy(@Nullable
 GraphQLBulkOperationMaxItemsExceededError template)

factory method to create a deep copy of GraphQLBulkOperationMaxItemsExceededError

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static GraphQLBulkOperationMaxItemsExceededErrorBuilder builder()

builder factory method for GraphQLBulkOperationMaxItemsExceededError

Returns:

builder

builder

static GraphQLBulkOperationMaxItemsExceededErrorBuilder builder(GraphQLBulkOperationMaxItemsExceededError template)

create builder for GraphQLBulkOperationMaxItemsExceededError instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withGraphQLBulkOperationMaxItemsExceededError

default <T> T withGraphQLBulkOperationMaxItemsExceededError(Function<GraphQLBulkOperationMaxItemsExceededError,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<GraphQLBulkOperationMaxItemsExceededError> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference