Package com.commercetools.api.models.error

Interface GraphQLExtensionBadResponseError

All Superinterfaces:

GraphQLErrorObject

All Known Implementing Classes:

GraphQLExtensionBadResponseErrorImpl

public interface GraphQLExtensionBadResponseError
extends GraphQLErrorObject

Returned when the response from the API Extension could not be parsed successfully (such as a 500 HTTP status code, or an invalid JSON response).

Example to create an instance using the builder pattern

     GraphQLExtensionBadResponseError graphQLExtensionBadResponseError = GraphQLExtensionBadResponseError.builder()
             .plusExtensionErrors(extensionErrorsBuilder -> extensionErrorsBuilder)
             .extensionId("{extensionId}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EXTENSION_BAD_RESPONSE	discriminator value for GraphQLExtensionBadResponseError

Method Summary

Modifier and Type	Method	Description
static GraphQLExtensionBadResponseErrorBuilder	builder()	builder factory method for GraphQLExtensionBadResponseError
static GraphQLExtensionBadResponseErrorBuilder	builder(GraphQLExtensionBadResponseError template)	create builder for GraphQLExtensionBadResponseError instance
static GraphQLExtensionBadResponseError	deepCopy(GraphQLExtensionBadResponseError template)	factory method to create a deep copy of GraphQLExtensionBadResponseError
@NotNull String	getCode()	Error identifier.
String	getExtensionBody()	The response body returned by the Extension.
@NotNull @Valid List<ExtensionError>	getExtensionErrors()	Additional errors related to the API Extension.
@Valid Object	getExtensionExtraInfo()	Any information that should be returned to the API caller.
@NotNull String	getExtensionId()	Unique identifier of the Extension.
String	getExtensionKey()	User-defined unique identifier of the Extension.
Integer	getExtensionStatusCode()	Http status code returned by the Extension.
@Valid LocalizedString	getLocalizedMessage()	User-defined localized description of the error.
static GraphQLExtensionBadResponseError	of()	factory method
static GraphQLExtensionBadResponseError	of(GraphQLExtensionBadResponseError template)	factory method to create a shallow copy GraphQLExtensionBadResponseError
void	setExtensionBody(String extensionBody)	The response body returned by the Extension.
void	setExtensionErrors(ExtensionError... extensionErrors)	Additional errors related to the API Extension.
void	setExtensionErrors(List<ExtensionError> extensionErrors)	Additional errors related to the API Extension.
void	setExtensionExtraInfo(Object extensionExtraInfo)	Any information that should be returned to the API caller.
void	setExtensionId(String extensionId)	Unique identifier of the Extension.
void	setExtensionKey(String extensionKey)	User-defined unique identifier of the Extension.
void	setExtensionStatusCode(Integer extensionStatusCode)	Http status code returned by the Extension.
void	setLocalizedMessage(LocalizedString localizedMessage)	User-defined localized description of the error.
static com.fasterxml.jackson.core.type.TypeReference<GraphQLExtensionBadResponseError>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withGraphQLExtensionBadResponseError(Function<GraphQLExtensionBadResponseError,T> helper)	accessor map function

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

setValue, values, withGraphQLErrorObject

Field Details

EXTENSION_BAD_RESPONSE

static final String EXTENSION_BAD_RESPONSE

discriminator value for GraphQLExtensionBadResponseError

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

getLocalizedMessage

@Valid
@Valid LocalizedString getLocalizedMessage()

User-defined localized description of the error.

Returns:

localizedMessage

getExtensionExtraInfo

@Valid
@Valid Object getExtensionExtraInfo()

Any information that should be returned to the API caller.

Returns:

extensionExtraInfo

getExtensionErrors

@NotNull
@Valid
@NotNull @Valid List<ExtensionError> getExtensionErrors()

Additional errors related to the API Extension.

Returns:

extensionErrors

getExtensionBody

String getExtensionBody()

The response body returned by the Extension.

Returns:

extensionBody

getExtensionStatusCode

Integer getExtensionStatusCode()

Http status code returned by the Extension.

Returns:

extensionStatusCode

getExtensionId

@NotNull
@NotNull String getExtensionId()

Unique identifier of the Extension.

Returns:

extensionId

getExtensionKey

String getExtensionKey()

User-defined unique identifier of the Extension.

Returns:

extensionKey

setLocalizedMessage

void setLocalizedMessage(LocalizedString localizedMessage)

User-defined localized description of the error.

Parameters:

localizedMessage - value to be set

setExtensionExtraInfo

void setExtensionExtraInfo(Object extensionExtraInfo)

Any information that should be returned to the API caller.

Parameters:

extensionExtraInfo - value to be set

setExtensionErrors

void setExtensionErrors(ExtensionError... extensionErrors)

Additional errors related to the API Extension.

Parameters:

extensionErrors - values to be set

setExtensionErrors

void setExtensionErrors(List<ExtensionError> extensionErrors)

Additional errors related to the API Extension.

Parameters:

extensionErrors - values to be set

setExtensionBody

void setExtensionBody(String extensionBody)

The response body returned by the Extension.

Parameters:

extensionBody - value to be set

setExtensionStatusCode

void setExtensionStatusCode(Integer extensionStatusCode)

Http status code returned by the Extension.

Parameters:

extensionStatusCode - value to be set

setExtensionId

void setExtensionId(String extensionId)

Unique identifier of the Extension.

Parameters:

extensionId - value to be set

setExtensionKey

void setExtensionKey(String extensionKey)

User-defined unique identifier of the Extension.

Parameters:

extensionKey - value to be set

of

static GraphQLExtensionBadResponseError of()

factory method

Returns:

instance of GraphQLExtensionBadResponseError

of

static GraphQLExtensionBadResponseError of(GraphQLExtensionBadResponseError template)

factory method to create a shallow copy GraphQLExtensionBadResponseError

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static GraphQLExtensionBadResponseError deepCopy(@Nullable
 GraphQLExtensionBadResponseError template)

factory method to create a deep copy of GraphQLExtensionBadResponseError

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static GraphQLExtensionBadResponseErrorBuilder builder()

builder factory method for GraphQLExtensionBadResponseError

Returns:

builder

builder

static GraphQLExtensionBadResponseErrorBuilder builder(GraphQLExtensionBadResponseError template)

create builder for GraphQLExtensionBadResponseError instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withGraphQLExtensionBadResponseError

default <T> T withGraphQLExtensionBadResponseError(Function<GraphQLExtensionBadResponseError,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<GraphQLExtensionBadResponseError> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference