Package com.commercetools.api.models.variant

Interface VariantResourceIdentifier

All Superinterfaces:

ResourceIdentifier, WithKey

public interface VariantResourceIdentifier
extends ResourceIdentifier

ResourceIdentifier to a Variant. Either id or key is required. If both are set, an InvalidJsonInput error is returned.

Example to create an instance using the builder pattern

     VariantResourceIdentifier variantResourceIdentifier = VariantResourceIdentifier.builder()
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	VARIANT	discriminator value for VariantResourceIdentifier

Method Summary

Modifier and Type	Method	Description
static VariantResourceIdentifierBuilder	builder()	builder factory method for VariantResourceIdentifier
static VariantResourceIdentifierBuilder	builder(VariantResourceIdentifier template)	create builder for VariantResourceIdentifier instance
VariantResourceIdentifier	copyDeep()
static VariantResourceIdentifier	deepCopy(VariantResourceIdentifier template)	factory method to create a deep copy of VariantResourceIdentifier
String	getId()	Unique identifier of the referenced Variant.
String	getKey()	User-defined unique identifier of the referenced Variant.
static VariantResourceIdentifier	of()	factory method
static VariantResourceIdentifier	of(VariantResourceIdentifier template)	factory method to create a shallow copy VariantResourceIdentifier
void	setId(String id)	Unique identifier of the referenced Variant.
void	setKey(String key)	User-defined unique identifier of the referenced Variant.
static tools.jackson.core.type.TypeReference<VariantResourceIdentifier>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withVariantResourceIdentifier(Function<VariantResourceIdentifier,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.common.ResourceIdentifier

getTypeId, withResourceIdentifier

Field Details

VARIANT

static final String VARIANT

discriminator value for VariantResourceIdentifier

See Also:

• Constant Field Values

Method Details

getId

String getId()

Unique identifier of the referenced Variant. Required if key is absent.

Specified by:

getId in interface ResourceIdentifier

Returns:

id

getKey

String getKey()

User-defined unique identifier of the referenced Variant. Required if id is absent.

Specified by:

getKey in interface ResourceIdentifier

Specified by:

getKey in interface WithKey

Returns:

key

setId

void setId(String id)

Unique identifier of the referenced Variant. Required if key is absent.

Specified by:

setId in interface ResourceIdentifier

Parameters:

id - value to be set

setKey

void setKey(String key)

User-defined unique identifier of the referenced Variant. Required if id is absent.

Specified by:

setKey in interface ResourceIdentifier

Parameters:

key - value to be set

of

static VariantResourceIdentifier of()

factory method

Returns:

instance of VariantResourceIdentifier

of

static VariantResourceIdentifier of(VariantResourceIdentifier template)

factory method to create a shallow copy VariantResourceIdentifier

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

VariantResourceIdentifier copyDeep()

Specified by:

copyDeep in interface ResourceIdentifier

deepCopy

@Nullable
static VariantResourceIdentifier deepCopy(@Nullable
 VariantResourceIdentifier template)

factory method to create a deep copy of VariantResourceIdentifier

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static VariantResourceIdentifierBuilder builder()

builder factory method for VariantResourceIdentifier

Returns:

builder

builder

static VariantResourceIdentifierBuilder builder(VariantResourceIdentifier template)

create builder for VariantResourceIdentifier instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withVariantResourceIdentifier

default <T> T withVariantResourceIdentifier(Function<VariantResourceIdentifier,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

typeReference

static tools.jackson.core.type.TypeReference<VariantResourceIdentifier> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference