Package com.commercetools.api.models.extension

Interface ExtensionResourceIdentifier

All Superinterfaces:

ResourceIdentifier, WithKey

public interface ExtensionResourceIdentifier
extends ResourceIdentifier

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

Example to create an instance using the builder pattern

     ExtensionResourceIdentifier extensionResourceIdentifier = ExtensionResourceIdentifier.builder()
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EXTENSION	discriminator value for ExtensionResourceIdentifier

Method Summary

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

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

withResourceIdentifier

Field Details

EXTENSION

static final String EXTENSION

discriminator value for ExtensionResourceIdentifier

See Also:

• Constant Field Values

Method Details

getTypeId

ReferenceTypeId getTypeId()

Description copied from interface: ResourceIdentifier

Type of referenced resource. If given, it must match the expected ReferenceTypeId of the referenced resource.

Specified by:

getTypeId in interface ResourceIdentifier

Returns:

typeId

getId

String getId()

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

Specified by:

getId in interface ResourceIdentifier

Returns:

id

getKey

String getKey()

User-defined unique identifier of the referenced Extension. 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 Extension. 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 Extension. Required if id is absent.

Specified by:

setKey in interface ResourceIdentifier

Parameters:

key - value to be set

of

static ExtensionResourceIdentifier of()

factory method

Returns:

instance of ExtensionResourceIdentifier

of

static ExtensionResourceIdentifier of(ExtensionResourceIdentifier template)

factory method to create a shallow copy ExtensionResourceIdentifier

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

ExtensionResourceIdentifier copyDeep()

Specified by:

copyDeep in interface ResourceIdentifier

deepCopy

@Nullable
static ExtensionResourceIdentifier deepCopy(@Nullable
 ExtensionResourceIdentifier template)

factory method to create a deep copy of ExtensionResourceIdentifier

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ExtensionResourceIdentifierBuilder builder()

builder factory method for ExtensionResourceIdentifier

Returns:

builder

builder

static ExtensionResourceIdentifierBuilder builder(ExtensionResourceIdentifier template)

create builder for ExtensionResourceIdentifier instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withExtensionResourceIdentifier

default <T> T withExtensionResourceIdentifier(Function<ExtensionResourceIdentifier,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<ExtensionResourceIdentifier> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference