Package com.commercetools.api.models.channel

Class ChannelDraftBuilder

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

     ChannelDraft channelDraft = ChannelDraft.builder()
             .key("{key}")
             .build()

  • Constructor Details

    • ChannelDraftBuilder

      public ChannelDraftBuilder()

  • Method Details

    • key

      public ChannelDraftBuilder key(String key)

      User-defined unique identifier for the Channel.

      Parameters:
      key - value to be set
      Returns:
      Builder

    • roles

      public ChannelDraftBuilder roles(@Nullable ChannelRoleEnum... roles)

      Roles of the Channel. Each channel must have at least one role. If not specified, then InventorySupply is assigned by default.

      Parameters:
      roles - value to be set
      Returns:
      Builder

    • roles

      public ChannelDraftBuilder roles(@Nullable List<ChannelRoleEnum> roles)

      Roles of the Channel. Each channel must have at least one role. If not specified, then InventorySupply is assigned by default.

      Parameters:
      roles - value to be set
      Returns:
      Builder

    • plusRoles

      public ChannelDraftBuilder plusRoles(@Nullable ChannelRoleEnum... roles)

      Roles of the Channel. Each channel must have at least one role. If not specified, then InventorySupply is assigned by default.

      Parameters:
      roles - value to be set
      Returns:
      Builder

    • name

      public ChannelDraftBuilder name(Function<LocalizedStringBuilder,LocalizedStringBuilder> builder)

      Name of the Channel.

      Parameters:
      builder - function to build the name value
      Returns:
      Builder

    • withName

      public ChannelDraftBuilder withName(Function<LocalizedStringBuilder,LocalizedString> builder)

      Name of the Channel.

      Parameters:
      builder - function to build the name value
      Returns:
      Builder

    • name

      public ChannelDraftBuilder name(@Nullable LocalizedString name)

      Name of the Channel.

      Parameters:
      name - value to be set
      Returns:
      Builder

    • description

      public ChannelDraftBuilder description(Function<LocalizedStringBuilder,LocalizedStringBuilder> builder)

      Description of the Channel.

      Parameters:
      builder - function to build the description value
      Returns:
      Builder

    • withDescription

      public ChannelDraftBuilder withDescription(Function<LocalizedStringBuilder,LocalizedString> builder)

      Description of the Channel.

      Parameters:
      builder - function to build the description value
      Returns:
      Builder

    • description

      public ChannelDraftBuilder description(@Nullable LocalizedString description)

      Description of the Channel.

      Parameters:
      description - value to be set
      Returns:
      Builder

    • address

      public ChannelDraftBuilder address(Function<BaseAddressBuilder,BaseAddressBuilder> builder)

      Address where the Channel is located.

      Parameters:
      builder - function to build the address value
      Returns:
      Builder

    • withAddress

      public ChannelDraftBuilder withAddress(Function<BaseAddressBuilder,BaseAddress> builder)

      Address where the Channel is located.

      Parameters:
      builder - function to build the address value
      Returns:
      Builder

    • address

      public ChannelDraftBuilder address(@Nullable BaseAddress address)

      Address where the Channel is located.

      Parameters:
      address - value to be set
      Returns:
      Builder

    • custom

      public ChannelDraftBuilder custom(Function<CustomFieldsDraftBuilder,CustomFieldsDraftBuilder> builder)

      Custom fields defined for the Channel.

      Parameters:
      builder - function to build the custom value
      Returns:
      Builder

    • withCustom

      public ChannelDraftBuilder withCustom(Function<CustomFieldsDraftBuilder,CustomFieldsDraft> builder)

      Custom fields defined for the Channel.

      Parameters:
      builder - function to build the custom value
      Returns:
      Builder

    • custom

      public ChannelDraftBuilder custom(@Nullable CustomFieldsDraft custom)

      Custom fields defined for the Channel.

      Parameters:
      custom - value to be set
      Returns:
      Builder

    • geoLocation

      public ChannelDraftBuilder geoLocation(@Nullable GeoJson geoLocation)

      GeoJSON geometry object encoding the geo location of the Channel. Currently, only the Point type is supported.

      Parameters:
      geoLocation - value to be set
      Returns:
      Builder

    • geoLocation

      public ChannelDraftBuilder geoLocation(Function<GeoJsonBuilder,Builder<? extends GeoJson>> builder)

      GeoJSON geometry object encoding the geo location of the Channel. Currently, only the Point type is supported.

      Parameters:
      builder - function to build the geoLocation value
      Returns:
      Builder

    • getKey

      public String getKey()

      User-defined unique identifier for the Channel.

      Returns:
      key

    • getRoles

      @Nullable public List<ChannelRoleEnum> getRoles()

      Roles of the Channel. Each channel must have at least one role. If not specified, then InventorySupply is assigned by default.

      Returns:
      roles

    • getName

      @Nullable public LocalizedString getName()

      Name of the Channel.

      Returns:
      name

    • getDescription

      @Nullable public LocalizedString getDescription()

      Description of the Channel.

      Returns:
      description

    • getAddress

      @Nullable public BaseAddress getAddress()

      Address where the Channel is located.

      Returns:
      address

    • getCustom

      @Nullable public CustomFieldsDraft getCustom()

      Custom fields defined for the Channel.

      Returns:
      custom

    • getGeoLocation

      @Nullable public GeoJson getGeoLocation()

      GeoJSON geometry object encoding the geo location of the Channel. Currently, only the Point type is supported.

      Returns:
      geoLocation

    • build

      public ChannelDraft build()
      builds ChannelDraft with checking for non-null required values
      Specified by:
      build in interface Builder<ChannelDraft>
      Returns:
      ChannelDraft

    • buildUnchecked

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

    • of

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

    • of

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