Package com.commercetools.api.models.error

Interface InvalidJsonInputError

All Superinterfaces:

ErrorObject

All Known Implementing Classes:

InvalidJsonInputErrorImpl

public interface InvalidJsonInputError
extends ErrorObject

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

     InvalidJsonInputError invalidJsonInputError = InvalidJsonInputError.builder()
             .message("{message}")
             .detailedErrorMessage("{detailedErrorMessage}")
             .build()
 

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static InvalidJsonInputErrorBuilder	builder()	builder factory method for InvalidJsonInputError
static InvalidJsonInputErrorBuilder	builder(InvalidJsonInputError template)	create builder for InvalidJsonInputError instance
static InvalidJsonInputError	deepCopy(InvalidJsonInputError template)	factory method to create a deep copy of InvalidJsonInputError
@NotNull String	getCode()	Error identifier.
@NotNull String	getDetailedErrorMessage()	Further explanation about why the JSON is invalid.
@NotNull String	getMessage()	"Request body does not contain valid JSON."
static InvalidJsonInputError	of()	factory method
static InvalidJsonInputError	of(InvalidJsonInputError template)	factory method to create a shallow copy InvalidJsonInputError
void	setDetailedErrorMessage(String detailedErrorMessage)	Further explanation about why the JSON is invalid.
void	setMessage(String message)	"Request body does not contain valid JSON."
static com.fasterxml.jackson.core.type.TypeReference<InvalidJsonInputError>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withInvalidJsonInputError(Function<InvalidJsonInputError,T> helper)	accessor map function

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

setValue, values, withErrorObject

Field Details

INVALID_JSON_INPUT

static final String INVALID_JSON_INPUT

discriminator value for InvalidJsonInputError

See Also:

• Constant Field Values

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()

"Request body does not contain valid JSON."

Specified by:

getMessage in interface ErrorObject

Returns:

message

getDetailedErrorMessage

@NotNull
@NotNull String getDetailedErrorMessage()

Further explanation about why the JSON is invalid.

Returns:

detailedErrorMessage

setMessage

void setMessage(String message)

"Request body does not contain valid JSON."

Specified by:

setMessage in interface ErrorObject

Parameters:

message - value to be set

setDetailedErrorMessage

void setDetailedErrorMessage(String detailedErrorMessage)

Further explanation about why the JSON is invalid.

Parameters:

detailedErrorMessage - value to be set

of

static InvalidJsonInputError of()

factory method

Returns:

instance of InvalidJsonInputError

of

static InvalidJsonInputError of(InvalidJsonInputError template)

factory method to create a shallow copy InvalidJsonInputError

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static InvalidJsonInputError deepCopy(@Nullable
 InvalidJsonInputError template)

factory method to create a deep copy of InvalidJsonInputError

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static InvalidJsonInputErrorBuilder builder()

builder factory method for InvalidJsonInputError

Returns:

builder

builder

static InvalidJsonInputErrorBuilder builder(InvalidJsonInputError template)

create builder for InvalidJsonInputError instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withInvalidJsonInputError

default <T> T withInvalidJsonInputError(Function<InvalidJsonInputError,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<InvalidJsonInputError> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference