Package com.commercetools.api.models.type

Interface TypeRemoveFieldDefinitionAction

All Superinterfaces:

ResourceUpdateAction<TypeUpdateAction>, TypeUpdateAction

All Known Implementing Classes:

TypeRemoveFieldDefinitionActionImpl

public interface TypeRemoveFieldDefinitionAction
extends TypeUpdateAction

TypeRemoveFieldDefinitionAction Example to create an instance using the builder pattern

     TypeRemoveFieldDefinitionAction typeRemoveFieldDefinitionAction = TypeRemoveFieldDefinitionAction.builder()
             .fieldName("{fieldName}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	REMOVE_FIELD_DEFINITION	discriminator value for TypeRemoveFieldDefinitionAction

Method Summary

Modifier and Type	Method	Description
static TypeRemoveFieldDefinitionActionBuilder	builder()	builder factory method for TypeRemoveFieldDefinitionAction
static TypeRemoveFieldDefinitionActionBuilder	builder(TypeRemoveFieldDefinitionAction template)	create builder for TypeRemoveFieldDefinitionAction instance
static TypeRemoveFieldDefinitionAction	deepCopy(TypeRemoveFieldDefinitionAction template)	factory method to create a deep copy of TypeRemoveFieldDefinitionAction
@NotNull String	getFieldName()	name of the FieldDefinition to remove.
static TypeRemoveFieldDefinitionAction	of()	factory method
static TypeRemoveFieldDefinitionAction	of(TypeRemoveFieldDefinitionAction template)	factory method to create a shallow copy TypeRemoveFieldDefinitionAction
void	setFieldName(String fieldName)	name of the FieldDefinition to remove.
static com.fasterxml.jackson.core.type.TypeReference<TypeRemoveFieldDefinitionAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withTypeRemoveFieldDefinitionAction(Function<TypeRemoveFieldDefinitionAction,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

REMOVE_FIELD_DEFINITION

static final String REMOVE_FIELD_DEFINITION

discriminator value for TypeRemoveFieldDefinitionAction

See Also:

• Constant Field Values

Method Details

getFieldName

@NotNull
@NotNull String getFieldName()

name of the FieldDefinition to remove. The removal of a FieldDefinition deletes asynchronously all Custom Fields using the FieldDefinition as well.

Returns:

fieldName

setFieldName

void setFieldName(String fieldName)

name of the FieldDefinition to remove. The removal of a FieldDefinition deletes asynchronously all Custom Fields using the FieldDefinition as well.

Parameters:

fieldName - value to be set

of

static TypeRemoveFieldDefinitionAction of()

factory method

Returns:

instance of TypeRemoveFieldDefinitionAction

of

static TypeRemoveFieldDefinitionAction of(TypeRemoveFieldDefinitionAction template)

factory method to create a shallow copy TypeRemoveFieldDefinitionAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static TypeRemoveFieldDefinitionAction deepCopy(@Nullable
 TypeRemoveFieldDefinitionAction template)

factory method to create a deep copy of TypeRemoveFieldDefinitionAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static TypeRemoveFieldDefinitionActionBuilder builder()

builder factory method for TypeRemoveFieldDefinitionAction

Returns:

builder

builder

static TypeRemoveFieldDefinitionActionBuilder builder(TypeRemoveFieldDefinitionAction template)

create builder for TypeRemoveFieldDefinitionAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withTypeRemoveFieldDefinitionAction

default <T> T withTypeRemoveFieldDefinitionAction(Function<TypeRemoveFieldDefinitionAction,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<TypeRemoveFieldDefinitionAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference