Package com.commercetools.api.models.error

Interface GraphQLInvalidJsonInputError

All Superinterfaces:
GraphQLErrorObject
public interface GraphQLInvalidJsonInputError extends GraphQLErrorObject

Returned when an invalid JSON input has been sent. Either the JSON is syntactically incorrect or does not conform to the expected shape (for example is missing a required field).

The client application should validate the input according to the constraints described in the error message before sending the request.

Example to create an instance using the builder pattern 

     GraphQLInvalidJsonInputError graphQLInvalidJsonInputError = GraphQLInvalidJsonInputError.builder()
             .detailedErrorMessage("{detailedErrorMessage}")
             .build()

  • Field Details

    • INVALID_JSON_INPUT

      static final String INVALID_JSON_INPUT
      discriminator value for GraphQLInvalidJsonInputError
      See Also:

  • 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

    • getDetailedErrorMessage

      @NotNull @NotNull String getDetailedErrorMessage()

      Further explanation about why the JSON is invalid.

      Returns:
      detailedErrorMessage

    • setDetailedErrorMessage

      void setDetailedErrorMessage(String detailedErrorMessage)

      Further explanation about why the JSON is invalid.

      Parameters:
      detailedErrorMessage - value to be set

    • of

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

    • of

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

    • copyDeep

      GraphQLInvalidJsonInputError copyDeep()
      Specified by:
      copyDeep in interface GraphQLErrorObject

    • deepCopy

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

    • builder

      static GraphQLInvalidJsonInputErrorBuilder builder()
      builder factory method for GraphQLInvalidJsonInputError
      Returns:
      builder

    • builder

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

    • withGraphQLInvalidJsonInputError

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