Package com.commercetools.api.models.channel

Interface ChannelResourceIdentifier

All Superinterfaces:

Identifiable<Channel>, ResourceIdentifier, WithKey

public interface ChannelResourceIdentifier
extends ResourceIdentifier, Identifiable<Channel>

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

Example to create an instance using the builder pattern

     ChannelResourceIdentifier channelResourceIdentifier = ChannelResourceIdentifier.builder()
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CHANNEL	discriminator value for ChannelResourceIdentifier

Method Summary

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

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

getTypeId, withResourceIdentifier

Field Details

CHANNEL

static final String CHANNEL

discriminator value for ChannelResourceIdentifier

See Also:

• Constant Field Values

Method Details

getId

String getId()

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

Specified by:

getId in interface Identifiable<Channel>

Specified by:

getId in interface ResourceIdentifier

Returns:

id

getKey

String getKey()

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

Specified by:

setKey in interface ResourceIdentifier

Parameters:

key - value to be set

of

static ChannelResourceIdentifier of()

factory method

Returns:

instance of ChannelResourceIdentifier

of

static ChannelResourceIdentifier of(ChannelResourceIdentifier template)

factory method to create a shallow copy ChannelResourceIdentifier

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static ChannelResourceIdentifier deepCopy(@Nullable
 ChannelResourceIdentifier template)

factory method to create a deep copy of ChannelResourceIdentifier

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ChannelResourceIdentifierBuilder builder()

builder factory method for ChannelResourceIdentifier

Returns:

builder

builder

static ChannelResourceIdentifierBuilder builder(ChannelResourceIdentifier template)

create builder for ChannelResourceIdentifier instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withChannelResourceIdentifier

default <T> T withChannelResourceIdentifier(Function<ChannelResourceIdentifier,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<ChannelResourceIdentifier> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference