Package com.commercetools.api.models.error

Interface BulkOperationMaxItemsExceededError

All Superinterfaces:
ErrorObject
public interface BulkOperationMaxItemsExceededError extends ErrorObject

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 

     BulkOperationMaxItemsExceededError bulkOperationMaxItemsExceededError = BulkOperationMaxItemsExceededError.builder()
             .message("{message}")
             .limit(0.3)
             .provided(0.3)
             .build()

  • Field Details

    • BULK_OPERATION_MAX_ITEMS_EXCEEDED

      static final String BULK_OPERATION_MAX_ITEMS_EXCEEDED
      discriminator value for BulkOperationMaxItemsExceededError
      See Also:

  • 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()

      "The bulk request exceeds the maximum allowed items of $limit."

      Specified by:
      getMessage in interface ErrorObject
      Returns:
      message

    • 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

    • setMessage

      void setMessage(String message)

      "The bulk request exceeds the maximum allowed items of $limit."

      Specified by:
      setMessage in interface ErrorObject
      Parameters:
      message - value to be set

    • 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 BulkOperationMaxItemsExceededError of()
      factory method
      Returns:
      instance of BulkOperationMaxItemsExceededError

    • of

      static BulkOperationMaxItemsExceededError of(BulkOperationMaxItemsExceededError template)
      factory method to create a shallow copy BulkOperationMaxItemsExceededError
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • copyDeep

      BulkOperationMaxItemsExceededError copyDeep()
      Specified by:
      copyDeep in interface ErrorObject

    • deepCopy

      @Nullable static BulkOperationMaxItemsExceededError deepCopy(@Nullable BulkOperationMaxItemsExceededError template)
      factory method to create a deep copy of BulkOperationMaxItemsExceededError
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • builder

      static BulkOperationMaxItemsExceededErrorBuilder builder()
      builder factory method for BulkOperationMaxItemsExceededError
      Returns:
      builder

    • builder

      static BulkOperationMaxItemsExceededErrorBuilder builder(BulkOperationMaxItemsExceededError template)
      create builder for BulkOperationMaxItemsExceededError instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder

    • withBulkOperationMaxItemsExceededError

      default <T> T withBulkOperationMaxItemsExceededError(Function<BulkOperationMaxItemsExceededError,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<BulkOperationMaxItemsExceededError> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference