Package com.commercetools.api.models.business_unit

Interface BusinessUnitSetAddressCustomFieldAction

All Superinterfaces:

BusinessUnitUpdateAction, ResourceUpdateAction<BusinessUnitUpdateAction>

All Known Implementing Classes:

BusinessUnitSetAddressCustomFieldActionImpl

public interface BusinessUnitSetAddressCustomFieldAction
extends BusinessUnitUpdateAction

BusinessUnitSetAddressCustomFieldAction Example to create an instance using the builder pattern

     BusinessUnitSetAddressCustomFieldAction businessUnitSetAddressCustomFieldAction = BusinessUnitSetAddressCustomFieldAction.builder()
             .addressId("{addressId}")
             .name("{name}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_ADDRESS_CUSTOM_FIELD	discriminator value for BusinessUnitSetAddressCustomFieldAction

Method Summary

Modifier and Type	Method	Description
static BusinessUnitSetAddressCustomFieldActionBuilder	builder()	builder factory method for BusinessUnitSetAddressCustomFieldAction
static BusinessUnitSetAddressCustomFieldActionBuilder	builder(BusinessUnitSetAddressCustomFieldAction template)	create builder for BusinessUnitSetAddressCustomFieldAction instance
static BusinessUnitSetAddressCustomFieldAction	deepCopy(BusinessUnitSetAddressCustomFieldAction template)	factory method to create a deep copy of BusinessUnitSetAddressCustomFieldAction
@NotNull String	getAddressId()	ID of the address to be extended.
@NotNull String	getName()	Name of the Custom Field.
Object	getValue()	If value is absent or null, this field will be removed if it exists.
static BusinessUnitSetAddressCustomFieldAction	of()	factory method
static BusinessUnitSetAddressCustomFieldAction	of(BusinessUnitSetAddressCustomFieldAction template)	factory method to create a shallow copy BusinessUnitSetAddressCustomFieldAction
static BusinessUnitSetAddressCustomFieldAction	ofUnset(String name)
void	setAddressId(String addressId)	ID of the address to be extended.
void	setName(String name)	Name of the Custom Field.
void	setValue(Object value)	If value is absent or null, this field will be removed if it exists.
static com.fasterxml.jackson.core.type.TypeReference<BusinessUnitSetAddressCustomFieldAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withBusinessUnitSetAddressCustomFieldAction(Function<BusinessUnitSetAddressCustomFieldAction,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.business_unit.BusinessUnitUpdateAction

getAction, withBusinessUnitUpdateAction

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

get

Field Details

SET_ADDRESS_CUSTOM_FIELD

static final String SET_ADDRESS_CUSTOM_FIELD

discriminator value for BusinessUnitSetAddressCustomFieldAction

See Also:

• Constant Field Values

Method Details

getAddressId

@NotNull
@NotNull String getAddressId()

ID of the address to be extended.

Returns:

addressId

getName

@NotNull
@NotNull String getName()

Name of the Custom Field.

Returns:

name

getValue

Object getValue()

If value is absent or null, this field will be removed if it exists. Trying to remove a field that does not exist will fail with an InvalidOperation error. If value is provided, it is set for the field defined by name.

Returns:

value

setAddressId

void setAddressId(String addressId)

ID of the address to be extended.

Parameters:

addressId - value to be set

setName

void setName(String name)

Name of the Custom Field.

Parameters:

name - value to be set

setValue

void setValue(Object value)

If value is absent or null, this field will be removed if it exists. Trying to remove a field that does not exist will fail with an InvalidOperation error. If value is provided, it is set for the field defined by name.

Parameters:

value - value to be set

of

static BusinessUnitSetAddressCustomFieldAction of()

factory method

Returns:

instance of BusinessUnitSetAddressCustomFieldAction

of

static BusinessUnitSetAddressCustomFieldAction of(BusinessUnitSetAddressCustomFieldAction template)

factory method to create a shallow copy BusinessUnitSetAddressCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static BusinessUnitSetAddressCustomFieldAction deepCopy(@Nullable
 BusinessUnitSetAddressCustomFieldAction template)

factory method to create a deep copy of BusinessUnitSetAddressCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static BusinessUnitSetAddressCustomFieldActionBuilder builder()

builder factory method for BusinessUnitSetAddressCustomFieldAction

Returns:

builder

builder

static BusinessUnitSetAddressCustomFieldActionBuilder builder(BusinessUnitSetAddressCustomFieldAction template)

create builder for BusinessUnitSetAddressCustomFieldAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withBusinessUnitSetAddressCustomFieldAction

default <T> T withBusinessUnitSetAddressCustomFieldAction(Function<BusinessUnitSetAddressCustomFieldAction,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

ofUnset

static BusinessUnitSetAddressCustomFieldAction ofUnset(String name)

typeReference

static com.fasterxml.jackson.core.type.TypeReference<BusinessUnitSetAddressCustomFieldAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference