Package com.commercetools.api.models.type

Interface TypeAddFieldDefinitionAction

All Superinterfaces:

ResourceUpdateAction<TypeUpdateAction>, TypeUpdateAction

All Known Implementing Classes:

TypeAddFieldDefinitionActionImpl

public interface TypeAddFieldDefinitionAction
extends TypeUpdateAction

Defines a new field for a Type. Adding new required fields to a Type that is already referenced by existing entities can put those entities in a temporarily inconsistent state.

If a Type that is already in use requires new fields, we recommend making them optional (required set to false) whenever possible. Alternatively, any new required fields should be added one at a time followed by an update to all the resources using the Type. This prevents validation errors caused by an entity missing more than one required custom field.

Example to create an instance using the builder pattern

     TypeAddFieldDefinitionAction typeAddFieldDefinitionAction = TypeAddFieldDefinitionAction.builder()
             .fieldDefinition(fieldDefinitionBuilder -> fieldDefinitionBuilder)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ADD_FIELD_DEFINITION	discriminator value for TypeAddFieldDefinitionAction

Method Summary

Modifier and Type	Method	Description
static TypeAddFieldDefinitionActionBuilder	builder()	builder factory method for TypeAddFieldDefinitionAction
static TypeAddFieldDefinitionActionBuilder	builder(TypeAddFieldDefinitionAction template)	create builder for TypeAddFieldDefinitionAction instance
static TypeAddFieldDefinitionAction	deepCopy(TypeAddFieldDefinitionAction template)	factory method to create a deep copy of TypeAddFieldDefinitionAction
@NotNull @Valid FieldDefinition	getFieldDefinition()	Value to append to the array.
static TypeAddFieldDefinitionAction	of()	factory method
static TypeAddFieldDefinitionAction	of(TypeAddFieldDefinitionAction template)	factory method to create a shallow copy TypeAddFieldDefinitionAction
void	setFieldDefinition(FieldDefinition fieldDefinition)	Value to append to the array.
static com.fasterxml.jackson.core.type.TypeReference<TypeAddFieldDefinitionAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withTypeAddFieldDefinitionAction(Function<TypeAddFieldDefinitionAction,T> helper)	accessor map function

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

get

Methods inherited from interface com.commercetools.api.models.type.TypeUpdateAction

getAction, withTypeUpdateAction

Field Details

ADD_FIELD_DEFINITION

static final String ADD_FIELD_DEFINITION

discriminator value for TypeAddFieldDefinitionAction

See Also:

• Constant Field Values

Method Details

getFieldDefinition

@NotNull
@Valid
@NotNull @Valid FieldDefinition getFieldDefinition()

Value to append to the array.

Returns:

fieldDefinition

setFieldDefinition

void setFieldDefinition(FieldDefinition fieldDefinition)

Value to append to the array.

Parameters:

fieldDefinition - value to be set

of

static TypeAddFieldDefinitionAction of()

factory method

Returns:

instance of TypeAddFieldDefinitionAction

of

static TypeAddFieldDefinitionAction of(TypeAddFieldDefinitionAction template)

factory method to create a shallow copy TypeAddFieldDefinitionAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static TypeAddFieldDefinitionAction deepCopy(@Nullable
 TypeAddFieldDefinitionAction template)

factory method to create a deep copy of TypeAddFieldDefinitionAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static TypeAddFieldDefinitionActionBuilder builder()

builder factory method for TypeAddFieldDefinitionAction

Returns:

builder

builder

static TypeAddFieldDefinitionActionBuilder builder(TypeAddFieldDefinitionAction template)

create builder for TypeAddFieldDefinitionAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withTypeAddFieldDefinitionAction

default <T> T withTypeAddFieldDefinitionAction(Function<TypeAddFieldDefinitionAction,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<TypeAddFieldDefinitionAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference