Package com.commercetools.importapi.models.common

Interface CustomObjectKeyReference

All Superinterfaces:

KeyReference

All Known Implementing Classes:

CustomObjectKeyReferenceImpl

public interface CustomObjectKeyReference
extends KeyReference

References a key value document by key.

Example to create an instance using the builder pattern

     CustomObjectKeyReference customObjectKeyReference = CustomObjectKeyReference.builder()
             .key("{key}")
             .container("{container}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	KEY_VALUE_DOCUMENT	discriminator value for CustomObjectKeyReference

Method Summary

Modifier and Type	Method	Description
static CustomObjectKeyReferenceBuilder	builder()	builder factory method for CustomObjectKeyReference
static CustomObjectKeyReferenceBuilder	builder(CustomObjectKeyReference template)	create builder for CustomObjectKeyReference instance
static CustomObjectKeyReference	deepCopy(CustomObjectKeyReference template)	factory method to create a deep copy of CustomObjectKeyReference
@NotNull String	getContainer()
static CustomObjectKeyReference	of()	factory method
static CustomObjectKeyReference	of(CustomObjectKeyReference template)	factory method to create a shallow copy CustomObjectKeyReference
void	setContainer(String container)	set container
static com.fasterxml.jackson.core.type.TypeReference<CustomObjectKeyReference>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withCustomObjectKeyReference(Function<CustomObjectKeyReference,T> helper)	accessor map function

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

getKey, getTypeId, setKey, withKeyReference

Field Details

KEY_VALUE_DOCUMENT

static final String KEY_VALUE_DOCUMENT

discriminator value for CustomObjectKeyReference

See Also:

• Constant Field Values

Method Details

getContainer

@NotNull
@NotNull String getContainer()

Returns:

container

setContainer

void setContainer(String container)

set container

Parameters:

container - value to be set

of

static CustomObjectKeyReference of()

factory method

Returns:

instance of CustomObjectKeyReference

of

static CustomObjectKeyReference of(CustomObjectKeyReference template)

factory method to create a shallow copy CustomObjectKeyReference

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static CustomObjectKeyReference deepCopy(@Nullable
 CustomObjectKeyReference template)

factory method to create a deep copy of CustomObjectKeyReference

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static CustomObjectKeyReferenceBuilder builder()

builder factory method for CustomObjectKeyReference

Returns:

builder

builder

static CustomObjectKeyReferenceBuilder builder(CustomObjectKeyReference template)

create builder for CustomObjectKeyReference instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withCustomObjectKeyReference

default <T> T withCustomObjectKeyReference(Function<CustomObjectKeyReference,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<CustomObjectKeyReference> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference