Package com.commercetools.api.models.cart

Class CartSetShippingCustomTypeActionBuilder

java.lang.Object

com.commercetools.api.models.cart.CartSetShippingCustomTypeActionBuilder

All Implemented Interfaces:

Builder<CartSetShippingCustomTypeAction>

public class CartSetShippingCustomTypeActionBuilder
extends Object
implements Builder<CartSetShippingCustomTypeAction>

CartSetShippingCustomTypeActionBuilder Example to create an instance using the builder pattern

     CartSetShippingCustomTypeAction cartSetShippingCustomTypeAction = CartSetShippingCustomTypeAction.builder()
             .build()
 

Constructor Summary

Constructors

Constructor	Description
CartSetShippingCustomTypeActionBuilder()

Method Summary

Modifier and Type	Method	Description
CartSetShippingCustomTypeAction	build()	builds CartSetShippingCustomTypeAction with checking for non-null required values
CartSetShippingCustomTypeAction	buildUnchecked()	builds CartSetShippingCustomTypeAction without checking for non-null required values
CartSetShippingCustomTypeActionBuilder	fields(FieldContainer fields)	Object containing the Custom Fields fields for the shippingMethod.
CartSetShippingCustomTypeActionBuilder	fields(Function<FieldContainerBuilder,FieldContainerBuilder> builder)	Object containing the Custom Fields fields for the shippingMethod.
FieldContainer	getFields()	Object containing the Custom Fields fields for the shippingMethod.
String	getShippingKey()	The shippingKey of the Shipping to customize.
TypeResourceIdentifier	getType()	Defines the Type that extends the specified ShippingMethod with Custom Fields.
static CartSetShippingCustomTypeActionBuilder	of()	factory method for an instance of CartSetShippingCustomTypeActionBuilder
static CartSetShippingCustomTypeActionBuilder	of(CartSetShippingCustomTypeAction template)	create builder for CartSetShippingCustomTypeAction instance
CartSetShippingCustomTypeActionBuilder	shippingKey(String shippingKey)	The shippingKey of the Shipping to customize.
CartSetShippingCustomTypeActionBuilder	type(TypeResourceIdentifier type)	Defines the Type that extends the specified ShippingMethod with Custom Fields.
CartSetShippingCustomTypeActionBuilder	type(Function<TypeResourceIdentifierBuilder,TypeResourceIdentifierBuilder> builder)	Defines the Type that extends the specified ShippingMethod with Custom Fields.
CartSetShippingCustomTypeActionBuilder	withFields(Function<FieldContainerBuilder,FieldContainer> builder)	Object containing the Custom Fields fields for the shippingMethod.
CartSetShippingCustomTypeActionBuilder	withType(Function<TypeResourceIdentifierBuilder,TypeResourceIdentifier> builder)	Defines the Type that extends the specified ShippingMethod with Custom Fields.

Methods inherited from class java.lang.Object

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

Constructor Details

CartSetShippingCustomTypeActionBuilder

public CartSetShippingCustomTypeActionBuilder()

Method Details

shippingKey

public CartSetShippingCustomTypeActionBuilder shippingKey(@Nullable
 String shippingKey)

The shippingKey of the Shipping to customize. Used to specify which Shipping Method to customize on a Cart with Multiple ShippingMode. Leave this empty to customize the one and only ShippingMethod on a Single ShippingMode Cart.

Parameters:

shippingKey - value to be set

Returns:

Builder

type

public CartSetShippingCustomTypeActionBuilder type(Function<TypeResourceIdentifierBuilder,TypeResourceIdentifierBuilder> builder)

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

Parameters:

builder - function to build the type value

Returns:

Builder

withType

public CartSetShippingCustomTypeActionBuilder withType(Function<TypeResourceIdentifierBuilder,TypeResourceIdentifier> builder)

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

Parameters:

builder - function to build the type value

Returns:

Builder

type

public CartSetShippingCustomTypeActionBuilder type(@Nullable
 TypeResourceIdentifier type)

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

Parameters:

type - value to be set

Returns:

Builder

fields

public CartSetShippingCustomTypeActionBuilder fields(Function<FieldContainerBuilder,FieldContainerBuilder> builder)

Object containing the Custom Fields fields for the shippingMethod.

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

Parameters:

builder - function to build the fields value

Returns:

Builder

withFields

public CartSetShippingCustomTypeActionBuilder withFields(Function<FieldContainerBuilder,FieldContainer> builder)

Object containing the Custom Fields fields for the shippingMethod.

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

Parameters:

builder - function to build the fields value

Returns:

Builder

fields

public CartSetShippingCustomTypeActionBuilder fields(@Nullable
 FieldContainer fields)

Object containing the Custom Fields fields for the shippingMethod.

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

Parameters:

fields - value to be set

Returns:

Builder

getShippingKey

@Nullable
public String getShippingKey()

The shippingKey of the Shipping to customize. Used to specify which Shipping Method to customize on a Cart with Multiple ShippingMode. Leave this empty to customize the one and only ShippingMethod on a Single ShippingMode Cart.

Returns:

shippingKey

getType

@Nullable
public TypeResourceIdentifier getType()

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

Returns:

type

getFields

@Nullable
public FieldContainer getFields()

Object containing the Custom Fields fields for the shippingMethod.

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

Returns:

fields

build

public CartSetShippingCustomTypeAction build()

builds CartSetShippingCustomTypeAction with checking for non-null required values

Specified by:

build in interface Builder<CartSetShippingCustomTypeAction>

Returns:

CartSetShippingCustomTypeAction

buildUnchecked

public CartSetShippingCustomTypeAction buildUnchecked()

builds CartSetShippingCustomTypeAction without checking for non-null required values

Returns:

CartSetShippingCustomTypeAction

of

public static CartSetShippingCustomTypeActionBuilder of()

factory method for an instance of CartSetShippingCustomTypeActionBuilder

Returns:

builder

of

public static CartSetShippingCustomTypeActionBuilder of(CartSetShippingCustomTypeAction template)

create builder for CartSetShippingCustomTypeAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder