Package com.commercetools.importapi.models.common

Interface ShippingMethodKeyReference

All Superinterfaces:

KeyReference

public interface ShippingMethodKeyReference
extends KeyReference

Used by the Import API to identify a ShippingMethod.

Example to create an instance using the builder pattern

     ShippingMethodKeyReference shippingMethodKeyReference = ShippingMethodKeyReference.builder()
             .key("{key}")
             .build()
 

Field Summary

Fields

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

Method Summary

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

Methods inherited from interface com.commercetools.importapi.models.common.KeyReference

getTypeId, withKeyReference

Field Details

SHIPPING_METHOD

static final String SHIPPING_METHOD

discriminator value for ShippingMethodKeyReference

See Also:

• Constant Field Values

Method Details

getKey

@NotNull
@NotNull String getKey()

User-defined unique identifier of the referenced ShippingMethod.

Specified by:

getKey in interface KeyReference

Returns:

key

setKey

void setKey(String key)

User-defined unique identifier of the referenced ShippingMethod.

Specified by:

setKey in interface KeyReference

Parameters:

key - value to be set

of

static ShippingMethodKeyReference of()

factory method

Returns:

instance of ShippingMethodKeyReference

of

static ShippingMethodKeyReference of(ShippingMethodKeyReference template)

factory method to create a shallow copy ShippingMethodKeyReference

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

ShippingMethodKeyReference copyDeep()

Specified by:

copyDeep in interface KeyReference

deepCopy

@Nullable
static ShippingMethodKeyReference deepCopy(@Nullable
 ShippingMethodKeyReference template)

factory method to create a deep copy of ShippingMethodKeyReference

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ShippingMethodKeyReferenceBuilder builder()

builder factory method for ShippingMethodKeyReference

Returns:

builder

builder

static ShippingMethodKeyReferenceBuilder builder(ShippingMethodKeyReference template)

create builder for ShippingMethodKeyReference instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withShippingMethodKeyReference

default <T> T withShippingMethodKeyReference(Function<ShippingMethodKeyReference,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<ShippingMethodKeyReference> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference