Package com.commercetools.api.models.error

Interface ExtensionNoResponseError

All Superinterfaces:

ErrorObject

All Known Implementing Classes:

ExtensionNoResponseErrorImpl

public interface ExtensionNoResponseError
extends ErrorObject

Returned when the API Extension does not respond within the time limit, or could not be reached.

Example to create an instance using the builder pattern

     ExtensionNoResponseError extensionNoResponseError = ExtensionNoResponseError.builder()
             .message("{message}")
             .extensionId("{extensionId}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EXTENSION_NO_RESPONSE	discriminator value for ExtensionNoResponseError

Method Summary

Modifier and Type	Method	Description
static ExtensionNoResponseErrorBuilder	builder()	builder factory method for ExtensionNoResponseError
static ExtensionNoResponseErrorBuilder	builder(ExtensionNoResponseError template)	create builder for ExtensionNoResponseError instance
static ExtensionNoResponseError	deepCopy(ExtensionNoResponseError template)	factory method to create a deep copy of ExtensionNoResponseError
@NotNull String	getCode()	Error identifier.
@NotNull String	getExtensionId()	Unique identifier of the API Extension.
String	getExtensionKey()	User-defined unique identifier of the API Extension, if available.
@NotNull String	getMessage()	"Extension did not respond in time."
static ExtensionNoResponseError	of()	factory method
static ExtensionNoResponseError	of(ExtensionNoResponseError template)	factory method to create a shallow copy ExtensionNoResponseError
void	setExtensionId(String extensionId)	Unique identifier of the API Extension.
void	setExtensionKey(String extensionKey)	User-defined unique identifier of the API Extension, if available.
void	setMessage(String message)	"Extension did not respond in time."
static com.fasterxml.jackson.core.type.TypeReference<ExtensionNoResponseError>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withExtensionNoResponseError(Function<ExtensionNoResponseError,T> helper)	accessor map function

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

setValue, values, withErrorObject

Field Details

EXTENSION_NO_RESPONSE

static final String EXTENSION_NO_RESPONSE

discriminator value for ExtensionNoResponseError

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

"Extension did not respond in time."

Specified by:

getMessage in interface ErrorObject

Returns:

message

getExtensionId

@NotNull
@NotNull String getExtensionId()

Unique identifier of the API Extension.

Returns:

extensionId

getExtensionKey

String getExtensionKey()

User-defined unique identifier of the API Extension, if available.

Returns:

extensionKey

setMessage

void setMessage(String message)

"Extension did not respond in time."

Specified by:

setMessage in interface ErrorObject

Parameters:

message - value to be set

setExtensionId

void setExtensionId(String extensionId)

Unique identifier of the API Extension.

Parameters:

extensionId - value to be set

setExtensionKey

void setExtensionKey(String extensionKey)

User-defined unique identifier of the API Extension, if available.

Parameters:

extensionKey - value to be set

of

static ExtensionNoResponseError of()

factory method

Returns:

instance of ExtensionNoResponseError

of

static ExtensionNoResponseError of(ExtensionNoResponseError template)

factory method to create a shallow copy ExtensionNoResponseError

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static ExtensionNoResponseError deepCopy(@Nullable
 ExtensionNoResponseError template)

factory method to create a deep copy of ExtensionNoResponseError

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ExtensionNoResponseErrorBuilder builder()

builder factory method for ExtensionNoResponseError

Returns:

builder

builder

static ExtensionNoResponseErrorBuilder builder(ExtensionNoResponseError template)

create builder for ExtensionNoResponseError instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withExtensionNoResponseError

default <T> T withExtensionNoResponseError(Function<ExtensionNoResponseError,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<ExtensionNoResponseError> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference