Package com.commercetools.api.models.zone

Interface ZoneResourceIdentifier

All Superinterfaces:

Identifiable<Zone>, ResourceIdentifier, WithKey

public interface ZoneResourceIdentifier
extends ResourceIdentifier, Identifiable<Zone>

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

Example to create an instance using the builder pattern

     ZoneResourceIdentifier zoneResourceIdentifier = ZoneResourceIdentifier.builder()
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ZONE	discriminator value for ZoneResourceIdentifier

Method Summary

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

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

getTypeId, withResourceIdentifier

Field Details

ZONE

static final String ZONE

discriminator value for ZoneResourceIdentifier

See Also:

• Constant Field Values

Method Details

getId

String getId()

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

Specified by:

getId in interface Identifiable<Zone>

Specified by:

getId in interface ResourceIdentifier

Returns:

id

getKey

String getKey()

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

Specified by:

setKey in interface ResourceIdentifier

Parameters:

key - value to be set

of

static ZoneResourceIdentifier of()

factory method

Returns:

instance of ZoneResourceIdentifier

of

static ZoneResourceIdentifier of(ZoneResourceIdentifier template)

factory method to create a shallow copy ZoneResourceIdentifier

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

ZoneResourceIdentifier copyDeep()

Specified by:

copyDeep in interface ResourceIdentifier

deepCopy

@Nullable
static ZoneResourceIdentifier deepCopy(@Nullable
 ZoneResourceIdentifier template)

factory method to create a deep copy of ZoneResourceIdentifier

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ZoneResourceIdentifierBuilder builder()

builder factory method for ZoneResourceIdentifier

Returns:

builder

builder

static ZoneResourceIdentifierBuilder builder(ZoneResourceIdentifier template)

create builder for ZoneResourceIdentifier instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withZoneResourceIdentifier

default <T> T withZoneResourceIdentifier(Function<ZoneResourceIdentifier,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<ZoneResourceIdentifier> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference