Package com.commercetools.api.models.order_edit

Class StagedOrderSetParcelCustomFieldActionBuilder

java.lang.Object

com.commercetools.api.models.order_edit.StagedOrderSetParcelCustomFieldActionBuilder

All Implemented Interfaces:

Builder<StagedOrderSetParcelCustomFieldAction>

public class StagedOrderSetParcelCustomFieldActionBuilder
extends Object
implements Builder<StagedOrderSetParcelCustomFieldAction>

StagedOrderSetParcelCustomFieldActionBuilder Example to create an instance using the builder pattern

     StagedOrderSetParcelCustomFieldAction stagedOrderSetParcelCustomFieldAction = StagedOrderSetParcelCustomFieldAction.builder()
             .name("{name}")
             .build()
 

Constructor Summary

Constructors

Constructor	Description
StagedOrderSetParcelCustomFieldActionBuilder()

Method Summary

Modifier and Type	Method	Description
StagedOrderSetParcelCustomFieldAction	build()	builds StagedOrderSetParcelCustomFieldAction with checking for non-null required values
StagedOrderSetParcelCustomFieldAction	buildUnchecked()	builds StagedOrderSetParcelCustomFieldAction without checking for non-null required values
String	getName()	Name of the Custom Field.
String	getParcelId()	id of an existing Parcel.
String	getParcelKey()	key of an existing Parcel.
Object	getValue()	If value is absent or null, this field will be removed if it exists.
StagedOrderSetParcelCustomFieldActionBuilder	name(String name)	Name of the Custom Field.
static StagedOrderSetParcelCustomFieldActionBuilder	of()	factory method for an instance of StagedOrderSetParcelCustomFieldActionBuilder
static StagedOrderSetParcelCustomFieldActionBuilder	of(StagedOrderSetParcelCustomFieldAction template)	create builder for StagedOrderSetParcelCustomFieldAction instance
StagedOrderSetParcelCustomFieldActionBuilder	parcelId(String parcelId)	id of an existing Parcel.
StagedOrderSetParcelCustomFieldActionBuilder	parcelKey(String parcelKey)	key of an existing Parcel.
StagedOrderSetParcelCustomFieldActionBuilder	value(Object value)	If value is absent or null, this field will be removed if it exists.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

StagedOrderSetParcelCustomFieldActionBuilder

public StagedOrderSetParcelCustomFieldActionBuilder()

Method Details

parcelId

public StagedOrderSetParcelCustomFieldActionBuilder parcelId(@Nullable
 String parcelId)

id of an existing Parcel.

Either parcelId or parcelKey must be provided.

Parameters:

parcelId - value to be set

Returns:

Builder

parcelKey

public StagedOrderSetParcelCustomFieldActionBuilder parcelKey(@Nullable
 String parcelKey)

key of an existing Parcel.

Either parcelId or parcelKey must be provided.

Parameters:

parcelKey - value to be set

Returns:

Builder

name

public StagedOrderSetParcelCustomFieldActionBuilder name(String name)

Name of the Custom Field.

Parameters:

name - value to be set

Returns:

Builder

value

public StagedOrderSetParcelCustomFieldActionBuilder value(@Nullable
 Object value)

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

Parameters:

value - value to be set

Returns:

Builder

getParcelId

@Nullable
public String getParcelId()

id of an existing Parcel.

Either parcelId or parcelKey must be provided.

Returns:

parcelId

getParcelKey

@Nullable
public String getParcelKey()

key of an existing Parcel.

Either parcelId or parcelKey must be provided.

Returns:

parcelKey

getName

public String getName()

Name of the Custom Field.

Returns:

name

getValue

@Nullable
public Object getValue()

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

Returns:

value

build

public StagedOrderSetParcelCustomFieldAction build()

builds StagedOrderSetParcelCustomFieldAction with checking for non-null required values

Specified by:

build in interface Builder<StagedOrderSetParcelCustomFieldAction>

Returns:

StagedOrderSetParcelCustomFieldAction

buildUnchecked

public StagedOrderSetParcelCustomFieldAction buildUnchecked()

builds StagedOrderSetParcelCustomFieldAction without checking for non-null required values

Returns:

StagedOrderSetParcelCustomFieldAction

of

public static StagedOrderSetParcelCustomFieldActionBuilder of()

factory method for an instance of StagedOrderSetParcelCustomFieldActionBuilder

Returns:

builder

of

public static StagedOrderSetParcelCustomFieldActionBuilder of(StagedOrderSetParcelCustomFieldAction template)

create builder for StagedOrderSetParcelCustomFieldAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder