Package com.commercetools.api.models.error

Interface InsufficientScopeError

All Superinterfaces:
ErrorObject
public interface InsufficientScopeError extends ErrorObject

This error occurs when your API Client does not have the OAuth scope required for the endpoint. Use an API Client with the required permissions for this endpoint instead.

Example to create an instance using the builder pattern 

     InsufficientScopeError insufficientScopeError = InsufficientScopeError.builder()
             .message("{message}")
             .build()

  • Field Details

    • INSUFFICIENT_SCOPE

      static final String INSUFFICIENT_SCOPE
      discriminator value for InsufficientScopeError
      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()

      "Insufficient scope. One of the following scopes is missing:"

      Specified by:
      getMessage in interface ErrorObject
      Returns:
      message

    • setMessage

      void setMessage(String message)

      "Insufficient scope. One of the following scopes is missing:"

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

    • of

      static InsufficientScopeError of()
      factory method
      Returns:
      instance of InsufficientScopeError

    • of

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

    • deepCopy

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

    • builder

      static InsufficientScopeErrorBuilder builder()
      builder factory method for InsufficientScopeError
      Returns:
      builder

    • builder

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

    • withInsufficientScopeError

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