Package com.commercetools.api.models.shipping_method

Interface ShippingMethodResourceIdentifier

All Superinterfaces:

Identifiable<ShippingMethod>, ResourceIdentifier, WithKey

public interface ShippingMethodResourceIdentifier
extends ResourceIdentifier, Identifiable<ShippingMethod>

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

Example to create an instance using the builder pattern

     ShippingMethodResourceIdentifier shippingMethodResourceIdentifier = ShippingMethodResourceIdentifier.builder()
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SHIPPING_METHOD	discriminator value for ShippingMethodResourceIdentifier

Method Summary

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

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

getTypeId, withResourceIdentifier

Field Details

SHIPPING_METHOD

static final String SHIPPING_METHOD

discriminator value for ShippingMethodResourceIdentifier

See Also:

• Constant Field Values

Method Details

getId

String getId()

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

Specified by:

getId in interface Identifiable<ShippingMethod>

Specified by:

getId in interface ResourceIdentifier

Returns:

id

getKey

String getKey()

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

Specified by:

setKey in interface ResourceIdentifier

Parameters:

key - value to be set

of

static ShippingMethodResourceIdentifier of()

factory method

Returns:

instance of ShippingMethodResourceIdentifier

of

static ShippingMethodResourceIdentifier of(ShippingMethodResourceIdentifier template)

factory method to create a shallow copy ShippingMethodResourceIdentifier

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

ShippingMethodResourceIdentifier copyDeep()

Specified by:

copyDeep in interface ResourceIdentifier

deepCopy

@Nullable
static ShippingMethodResourceIdentifier deepCopy(@Nullable
 ShippingMethodResourceIdentifier template)

factory method to create a deep copy of ShippingMethodResourceIdentifier

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ShippingMethodResourceIdentifierBuilder builder()

builder factory method for ShippingMethodResourceIdentifier

Returns:

builder

builder

static ShippingMethodResourceIdentifierBuilder builder(ShippingMethodResourceIdentifier template)

create builder for ShippingMethodResourceIdentifier instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withShippingMethodResourceIdentifier

default <T> T withShippingMethodResourceIdentifier(Function<ShippingMethodResourceIdentifier,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<ShippingMethodResourceIdentifier> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference