Package com.commercetools.api.models.error

Interface GraphQLRequiredFieldError

All Superinterfaces:
GraphQLErrorObject
public interface GraphQLRequiredFieldError extends GraphQLErrorObject

Returned when a value is not defined for a required field.

Example to create an instance using the builder pattern 

     GraphQLRequiredFieldError graphQLRequiredFieldError = GraphQLRequiredFieldError.builder()
             .field("{field}")
             .build()

  • Field Details

    • REQUIRED_FIELD

      static final String REQUIRED_FIELD
      discriminator value for GraphQLRequiredFieldError
      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

    • getField

      @NotNull @NotNull String getField()

      Name of the field missing the value.

      Returns:
      field

    • setField

      void setField(String field)

      Name of the field missing the value.

      Parameters:
      field - value to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static GraphQLRequiredFieldErrorBuilder builder()
      builder factory method for GraphQLRequiredFieldError
      Returns:
      builder

    • builder

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

    • withGraphQLRequiredFieldError

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