Package com.commercetools.api.models.error

Interface DuplicateFieldWithConflictingResourceError

All Superinterfaces:

ErrorObject

All Known Implementing Classes:

DuplicateFieldWithConflictingResourceErrorImpl

public interface DuplicateFieldWithConflictingResourceError
extends ErrorObject

Returned when a field value conflicts with an existing value stored in a particular resource causing a duplicate.

Example to create an instance using the builder pattern

     DuplicateFieldWithConflictingResourceError duplicateFieldWithConflictingResourceError = DuplicateFieldWithConflictingResourceError.builder()
             .message("{message}")
             .field("{field}")
             .conflictingResource(conflictingResourceBuilder -> conflictingResourceBuilder)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DUPLICATE_FIELD_WITH_CONFLICTING_RESOURCE	discriminator value for DuplicateFieldWithConflictingResourceError

Method Summary

Modifier and Type	Method	Description
static DuplicateFieldWithConflictingResourceErrorBuilder	builder()	builder factory method for DuplicateFieldWithConflictingResourceError
static DuplicateFieldWithConflictingResourceErrorBuilder	builder(DuplicateFieldWithConflictingResourceError template)	create builder for DuplicateFieldWithConflictingResourceError instance
static DuplicateFieldWithConflictingResourceError	deepCopy(DuplicateFieldWithConflictingResourceError template)	factory method to create a deep copy of DuplicateFieldWithConflictingResourceError
@NotNull String	getCode()	Error identifier.
@NotNull @Valid Reference	getConflictingResource()	Reference to the resource that has the conflicting value.
@NotNull Object	getDuplicateValue()	Conflicting duplicate value.
@NotNull String	getField()	Name of the conflicting field.
@NotNull String	getMessage()	"A duplicate value $duplicateValue exists for field $field on $conflictingResource."
static DuplicateFieldWithConflictingResourceError	of()	factory method
static DuplicateFieldWithConflictingResourceError	of(DuplicateFieldWithConflictingResourceError template)	factory method to create a shallow copy DuplicateFieldWithConflictingResourceError
void	setConflictingResource(Reference conflictingResource)	Reference to the resource that has the conflicting value.
void	setDuplicateValue(Object duplicateValue)	Conflicting duplicate value.
void	setField(String field)	Name of the conflicting field.
void	setMessage(String message)	"A duplicate value $duplicateValue exists for field $field on $conflictingResource."
static com.fasterxml.jackson.core.type.TypeReference<DuplicateFieldWithConflictingResourceError>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withDuplicateFieldWithConflictingResourceError(Function<DuplicateFieldWithConflictingResourceError,T> helper)	accessor map function

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

setValue, values, withErrorObject

Field Details

DUPLICATE_FIELD_WITH_CONFLICTING_RESOURCE

static final String DUPLICATE_FIELD_WITH_CONFLICTING_RESOURCE

discriminator value for DuplicateFieldWithConflictingResourceError

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

"A duplicate value $duplicateValue exists for field $field on $conflictingResource."

Specified by:

getMessage in interface ErrorObject

Returns:

message

getField

@NotNull
@NotNull String getField()

Name of the conflicting field.

Returns:

field

getDuplicateValue

@NotNull
@NotNull Object getDuplicateValue()

Conflicting duplicate value.

Returns:

duplicateValue

getConflictingResource

@NotNull
@Valid
@NotNull @Valid Reference getConflictingResource()

Reference to the resource that has the conflicting value.

Returns:

conflictingResource

setMessage

void setMessage(String message)

"A duplicate value $duplicateValue exists for field $field on $conflictingResource."

Specified by:

setMessage in interface ErrorObject

Parameters:

message - value to be set

setField

void setField(String field)

Name of the conflicting field.

Parameters:

field - value to be set

setDuplicateValue

void setDuplicateValue(Object duplicateValue)

Conflicting duplicate value.

Parameters:

duplicateValue - value to be set

setConflictingResource

void setConflictingResource(Reference conflictingResource)

Reference to the resource that has the conflicting value.

Parameters:

conflictingResource - value to be set

of

static DuplicateFieldWithConflictingResourceError of()

factory method

Returns:

instance of DuplicateFieldWithConflictingResourceError

of

static DuplicateFieldWithConflictingResourceError of(DuplicateFieldWithConflictingResourceError template)

factory method to create a shallow copy DuplicateFieldWithConflictingResourceError

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static DuplicateFieldWithConflictingResourceError deepCopy(@Nullable
 DuplicateFieldWithConflictingResourceError template)

factory method to create a deep copy of DuplicateFieldWithConflictingResourceError

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static DuplicateFieldWithConflictingResourceErrorBuilder builder()

builder factory method for DuplicateFieldWithConflictingResourceError

Returns:

builder

builder

static DuplicateFieldWithConflictingResourceErrorBuilder builder(DuplicateFieldWithConflictingResourceError template)

create builder for DuplicateFieldWithConflictingResourceError instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withDuplicateFieldWithConflictingResourceError

default <T> T withDuplicateFieldWithConflictingResourceError(Function<DuplicateFieldWithConflictingResourceError,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<DuplicateFieldWithConflictingResourceError> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference