Package com.commercetools.api.models.shopping_list

Class ShoppingListSetLineItemCustomFieldActionBuilder

java.lang.Object
com.commercetools.api.models.shopping_list.ShoppingListSetLineItemCustomFieldActionBuilder
All Implemented Interfaces:
Builder<ShoppingListSetLineItemCustomFieldAction>
public class ShoppingListSetLineItemCustomFieldActionBuilder extends Object implements Builder<ShoppingListSetLineItemCustomFieldAction>
ShoppingListSetLineItemCustomFieldActionBuilder
Example to create an instance using the builder pattern 

     ShoppingListSetLineItemCustomFieldAction shoppingListSetLineItemCustomFieldAction = ShoppingListSetLineItemCustomFieldAction.builder()
             .name("{name}")
             .build()

  • Constructor Details

    • ShoppingListSetLineItemCustomFieldActionBuilder

      public ShoppingListSetLineItemCustomFieldActionBuilder()

  • Method Details

    • lineItemId

      public ShoppingListSetLineItemCustomFieldActionBuilder lineItemId(@Nullable String lineItemId)

      The id of the ShoppingListLineItem to update. Either lineItemId or lineItemKey is required.

      Parameters:
      lineItemId - value to be set
      Returns:
      Builder

    • lineItemKey

      public ShoppingListSetLineItemCustomFieldActionBuilder lineItemKey(@Nullable String lineItemKey)

      The key of the ShoppingListLineItem to update. Either lineItemId or lineItemKey is required.

      Parameters:
      lineItemKey - value to be set
      Returns:
      Builder

    • name

      public ShoppingListSetLineItemCustomFieldActionBuilder name(String name)

      Name of the Custom Field.

      Parameters:
      name - value to be set
      Returns:
      Builder

    • value

      public ShoppingListSetLineItemCustomFieldActionBuilder 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

    • getLineItemId

      @Nullable public String getLineItemId()

      The id of the ShoppingListLineItem to update. Either lineItemId or lineItemKey is required.

      Returns:
      lineItemId

    • getLineItemKey

      @Nullable public String getLineItemKey()

      The key of the ShoppingListLineItem to update. Either lineItemId or lineItemKey is required.

      Returns:
      lineItemKey

    • 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 ShoppingListSetLineItemCustomFieldAction build()
      builds ShoppingListSetLineItemCustomFieldAction with checking for non-null required values
      Specified by:
      build in interface Builder<ShoppingListSetLineItemCustomFieldAction>
      Returns:
      ShoppingListSetLineItemCustomFieldAction

    • buildUnchecked

      public ShoppingListSetLineItemCustomFieldAction buildUnchecked()
      builds ShoppingListSetLineItemCustomFieldAction without checking for non-null required values
      Returns:
      ShoppingListSetLineItemCustomFieldAction

    • of

      public static ShoppingListSetLineItemCustomFieldActionBuilder of()
      factory method for an instance of ShoppingListSetLineItemCustomFieldActionBuilder
      Returns:
      builder

    • of

      public static ShoppingListSetLineItemCustomFieldActionBuilder of(ShoppingListSetLineItemCustomFieldAction template)
      create builder for ShoppingListSetLineItemCustomFieldAction instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder