Interface GraphQLInvalidJsonInputError
- All Superinterfaces:
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
Modifier and TypeFieldDescriptionstatic final String
discriminator value for GraphQLInvalidJsonInputError -
Method Summary
Modifier and TypeMethodDescriptionbuilder()
builder factory method for GraphQLInvalidJsonInputErrorbuilder
(GraphQLInvalidJsonInputError template) create builder for GraphQLInvalidJsonInputError instancestatic GraphQLInvalidJsonInputError
deepCopy
(GraphQLInvalidJsonInputError template) factory method to create a deep copy of GraphQLInvalidJsonInputError@NotNull String
getCode()
Error identifier.@NotNull String
Further explanation about why the JSON is invalid.static GraphQLInvalidJsonInputError
of()
factory methodstatic GraphQLInvalidJsonInputError
of
(GraphQLInvalidJsonInputError template) factory method to create a shallow copy GraphQLInvalidJsonInputErrorvoid
setDetailedErrorMessage
(String detailedErrorMessage) Further explanation about why the JSON is invalid.static com.fasterxml.jackson.core.type.TypeReference<GraphQLInvalidJsonInputError>
gives a TypeReference for usage with Jackson DataBinddefault <T> T
accessor map functionMethods inherited from interface com.commercetools.api.models.error.GraphQLErrorObject
setValue, values, withGraphQLErrorObject
-
Field Details
-
INVALID_JSON_INPUT
discriminator value for GraphQLInvalidJsonInputError- See Also:
-
-
Method Details
-
getCode
Description copied from interface:GraphQLErrorObject
Error identifier.
- Specified by:
getCode
in interfaceGraphQLErrorObject
- Returns:
- code
-
getDetailedErrorMessage
Further explanation about why the JSON is invalid.
- Returns:
- detailedErrorMessage
-
setDetailedErrorMessage
Further explanation about why the JSON is invalid.
- Parameters:
detailedErrorMessage
- value to be set
-
of
factory method- Returns:
- instance of GraphQLInvalidJsonInputError
-
of
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
builder factory method for GraphQLInvalidJsonInputError- Returns:
- builder
-
builder
create builder for GraphQLInvalidJsonInputError instance- Parameters:
template
- instance with prefilled values for the builder- Returns:
- builder
-
withGraphQLInvalidJsonInputError
accessor map function- Type Parameters:
T
- mapped type- Parameters:
helper
- function to map the object- Returns:
- mapped value
-
typeReference
gives a TypeReference for usage with Jackson DataBind- Returns:
- TypeReference
-