Package com.commercetools.api.models.error

Interface ResourceNotFoundError

All Superinterfaces:

ErrorObject

All Known Implementing Classes:

ResourceNotFoundErrorImpl

public interface ResourceNotFoundError
extends ErrorObject

Returned when the resource addressed by the request URL does not exist.

Example to create an instance using the builder pattern

     ResourceNotFoundError resourceNotFoundError = ResourceNotFoundError.builder()
             .message("{message}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	RESOURCE_NOT_FOUND	discriminator value for ResourceNotFoundError

Method Summary

Modifier and Type	Method	Description
static ResourceNotFoundErrorBuilder	builder()	builder factory method for ResourceNotFoundError
static ResourceNotFoundErrorBuilder	builder(ResourceNotFoundError template)	create builder for ResourceNotFoundError instance
static ResourceNotFoundError	deepCopy(ResourceNotFoundError template)	factory method to create a deep copy of ResourceNotFoundError
@NotNull String	getCode()	Error identifier.
@NotNull String	getMessage()	"The Resource with ID $resourceId was not found."
static ResourceNotFoundError	of()	factory method
static ResourceNotFoundError	of(ResourceNotFoundError template)	factory method to create a shallow copy ResourceNotFoundError
void	setMessage(String message)	"The Resource with ID $resourceId was not found."
static com.fasterxml.jackson.core.type.TypeReference<ResourceNotFoundError>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withResourceNotFoundError(Function<ResourceNotFoundError,T> helper)	accessor map function

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

setValue, values, withErrorObject

Field Details

RESOURCE_NOT_FOUND

static final String RESOURCE_NOT_FOUND

discriminator value for ResourceNotFoundError

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

"The Resource with ID $resourceId was not found."

Specified by:

getMessage in interface ErrorObject

Returns:

message

setMessage

void setMessage(String message)

"The Resource with ID $resourceId was not found."

Specified by:

setMessage in interface ErrorObject

Parameters:

message - value to be set

of

static ResourceNotFoundError of()

factory method

Returns:

instance of ResourceNotFoundError

of

static ResourceNotFoundError of(ResourceNotFoundError template)

factory method to create a shallow copy ResourceNotFoundError

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static ResourceNotFoundError deepCopy(@Nullable
 ResourceNotFoundError template)

factory method to create a deep copy of ResourceNotFoundError

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ResourceNotFoundErrorBuilder builder()

builder factory method for ResourceNotFoundError

Returns:

builder

builder

static ResourceNotFoundErrorBuilder builder(ResourceNotFoundError template)

create builder for ResourceNotFoundError instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withResourceNotFoundError

default <T> T withResourceNotFoundError(Function<ResourceNotFoundError,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<ResourceNotFoundError> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference