Package com.commercetools.importapi.models.common

Interface CustomerGroupKeyReference

All Superinterfaces:

KeyReference

public interface CustomerGroupKeyReference
extends KeyReference

Used by the Import API to identify a CustomerGroup.

Example to create an instance using the builder pattern

     CustomerGroupKeyReference customerGroupKeyReference = CustomerGroupKeyReference.builder()
             .key("{key}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CUSTOMER_GROUP	discriminator value for CustomerGroupKeyReference

Method Summary

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

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

withKeyReference

Field Details

CUSTOMER_GROUP

static final String CUSTOMER_GROUP

discriminator value for CustomerGroupKeyReference

See Also:

• Constant Field Values

Method Details

getTypeId

@NotNull
@NotNull ReferenceType getTypeId()

Description copied from interface: KeyReference

Type of referenced resource.

Specified by:

getTypeId in interface KeyReference

Returns:

typeId

getKey

@NotNull
@NotNull String getKey()

User-defined unique identifier of the referenced CustomerGroup.

Specified by:

getKey in interface KeyReference

Returns:

key

setKey

void setKey(String key)

User-defined unique identifier of the referenced CustomerGroup.

Specified by:

setKey in interface KeyReference

Parameters:

key - value to be set

of

static CustomerGroupKeyReference of()

factory method

Returns:

instance of CustomerGroupKeyReference

of

static CustomerGroupKeyReference of(CustomerGroupKeyReference template)

factory method to create a shallow copy CustomerGroupKeyReference

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

CustomerGroupKeyReference copyDeep()

Specified by:

copyDeep in interface KeyReference

deepCopy

@Nullable
static CustomerGroupKeyReference deepCopy(@Nullable
 CustomerGroupKeyReference template)

factory method to create a deep copy of CustomerGroupKeyReference

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static CustomerGroupKeyReferenceBuilder builder()

builder factory method for CustomerGroupKeyReference

Returns:

builder

builder

static CustomerGroupKeyReferenceBuilder builder(CustomerGroupKeyReference template)

create builder for CustomerGroupKeyReference instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withCustomerGroupKeyReference

default <T> T withCustomerGroupKeyReference(Function<CustomerGroupKeyReference,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

typeReference

static tools.jackson.core.type.TypeReference<CustomerGroupKeyReference> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference