Package com.commercetools.api.models.channel

Interface ChannelSetAddressCustomTypeAction

All Superinterfaces:

ChannelUpdateAction, ResourceUpdateAction<ChannelUpdateAction>

public interface ChannelSetAddressCustomTypeAction
extends ChannelUpdateAction

To set a Custom Type for a Channel, Channel.address must be set; otherwise, an InvalidInput error is returned.

Example to create an instance using the builder pattern

     ChannelSetAddressCustomTypeAction channelSetAddressCustomTypeAction = ChannelSetAddressCustomTypeAction.builder()
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_ADDRESS_CUSTOM_TYPE	discriminator value for ChannelSetAddressCustomTypeAction

Method Summary

Modifier and Type	Method	Description
static ChannelSetAddressCustomTypeActionBuilder	builder()	builder factory method for ChannelSetAddressCustomTypeAction
static ChannelSetAddressCustomTypeActionBuilder	builder(ChannelSetAddressCustomTypeAction template)	create builder for ChannelSetAddressCustomTypeAction instance
ChannelSetAddressCustomTypeAction	copyDeep()
static ChannelSetAddressCustomTypeAction	deepCopy(ChannelSetAddressCustomTypeAction template)	factory method to create a deep copy of ChannelSetAddressCustomTypeAction
@Valid FieldContainer	getFields()	Object containing the Custom Fields fields for the address.
@Valid TypeResourceIdentifier	getType()	Defines the Type that extends the address with Custom Fields.
static ChannelSetAddressCustomTypeAction	of()	factory method
static ChannelSetAddressCustomTypeAction	of(ChannelSetAddressCustomTypeAction template)	factory method to create a shallow copy ChannelSetAddressCustomTypeAction
void	setFields(FieldContainer fields)	Object containing the Custom Fields fields for the address.
void	setType(TypeResourceIdentifier type)	Defines the Type that extends the address with Custom Fields.
static tools.jackson.core.type.TypeReference<ChannelSetAddressCustomTypeAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withChannelSetAddressCustomTypeAction(Function<ChannelSetAddressCustomTypeAction,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.channel.ChannelUpdateAction

getAction, withChannelUpdateAction

Methods inherited from interface com.commercetools.api.models.ResourceUpdateAction

get

Field Details

SET_ADDRESS_CUSTOM_TYPE

static final String SET_ADDRESS_CUSTOM_TYPE

discriminator value for ChannelSetAddressCustomTypeAction

See Also:

• Constant Field Values

Method Details

getType

@Valid
@Valid TypeResourceIdentifier getType()

Defines the Type that extends the address with Custom Fields. If absent, any existing Type and Custom Fields are removed from the address.

Returns:

type

getFields

@Valid
@Valid FieldContainer getFields()

Object containing the Custom Fields fields for the address.

Required if at least one Custom Field is defined as required in the fieldDefinitions of the referenced Type.

Returns:

fields

setType

void setType(TypeResourceIdentifier type)

Defines the Type that extends the address with Custom Fields. If absent, any existing Type and Custom Fields are removed from the address.

Parameters:

type - value to be set

setFields

void setFields(FieldContainer fields)

Object containing the Custom Fields fields for the address.

Required if at least one Custom Field is defined as required in the fieldDefinitions of the referenced Type.

Parameters:

fields - value to be set

of

static ChannelSetAddressCustomTypeAction of()

factory method

Returns:

instance of ChannelSetAddressCustomTypeAction

of

static ChannelSetAddressCustomTypeAction of(ChannelSetAddressCustomTypeAction template)

factory method to create a shallow copy ChannelSetAddressCustomTypeAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

ChannelSetAddressCustomTypeAction copyDeep()

Specified by:

copyDeep in interface ChannelUpdateAction

deepCopy

@Nullable
static ChannelSetAddressCustomTypeAction deepCopy(@Nullable
 ChannelSetAddressCustomTypeAction template)

factory method to create a deep copy of ChannelSetAddressCustomTypeAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ChannelSetAddressCustomTypeActionBuilder builder()

builder factory method for ChannelSetAddressCustomTypeAction

Returns:

builder

builder

static ChannelSetAddressCustomTypeActionBuilder builder(ChannelSetAddressCustomTypeAction template)

create builder for ChannelSetAddressCustomTypeAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withChannelSetAddressCustomTypeAction

default <T> T withChannelSetAddressCustomTypeAction(Function<ChannelSetAddressCustomTypeAction,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<ChannelSetAddressCustomTypeAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference