Package com.commercetools.api.models.error

Interface GraphQLInvalidJsonInputError

All Superinterfaces:

GraphQLErrorObject

All Known Implementing Classes:

GraphQLInvalidJsonInputErrorImpl

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 Summary

Fields

Modifier and Type	Field	Description
static final String	INVALID_JSON_INPUT	discriminator value for GraphQLInvalidJsonInputError

Method Summary

Modifier and Type	Method	Description
static GraphQLInvalidJsonInputErrorBuilder	builder()	builder factory method for GraphQLInvalidJsonInputError
static GraphQLInvalidJsonInputErrorBuilder	builder(GraphQLInvalidJsonInputError template)	create builder for GraphQLInvalidJsonInputError instance
static GraphQLInvalidJsonInputError	deepCopy(GraphQLInvalidJsonInputError template)	factory method to create a deep copy of GraphQLInvalidJsonInputError
@NotNull String	getCode()	Error identifier.
@NotNull String	getDetailedErrorMessage()	Further explanation about why the JSON is invalid.
static GraphQLInvalidJsonInputError	of()	factory method
static GraphQLInvalidJsonInputError	of(GraphQLInvalidJsonInputError template)	factory method to create a shallow copy GraphQLInvalidJsonInputError
void	setDetailedErrorMessage(String detailedErrorMessage)	Further explanation about why the JSON is invalid.
static com.fasterxml.jackson.core.type.TypeReference<GraphQLInvalidJsonInputError>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withGraphQLInvalidJsonInputError(Function<GraphQLInvalidJsonInputError,T> helper)	accessor map function

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

setValue, values, withGraphQLErrorObject

Field Details

INVALID_JSON_INPUT

static final String INVALID_JSON_INPUT

discriminator value for GraphQLInvalidJsonInputError

See Also:

• Constant Field Values

Method Details

getCode

@NotNull
@NotNull String getCode()

Description copied from interface: GraphQLErrorObject

Error identifier.

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

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