Package com.commercetools.api.models.order_edit

Interface StagedOrderUpdateSyncInfoAction

All Superinterfaces:
ResourceUpdateAction<StagedOrderUpdateAction>, StagedOrderUpdateAction
public interface StagedOrderUpdateSyncInfoAction extends StagedOrderUpdateAction
StagedOrderUpdateSyncInfoAction
Example to create an instance using the builder pattern 

     StagedOrderUpdateSyncInfoAction stagedOrderUpdateSyncInfoAction = StagedOrderUpdateSyncInfoAction.builder()
             .channel(channelBuilder -> channelBuilder)
             .build()

  • Field Details

    • UPDATE_SYNC_INFO

      static final String UPDATE_SYNC_INFO
      discriminator value for StagedOrderUpdateSyncInfoAction
      See Also:

  • Method Details

    • getExternalId

      String getExternalId()

      Set this to identify an external order instance, file, or other resource.

      Returns:
      externalId

    • getChannel

      @NotNull @Valid @NotNull @Valid ChannelResourceIdentifier getChannel()

      The synchronization destination to set. Must not be empty. The referenced Channel must have the Channel Role OrderExport or OrderImport. Otherwise this update action returns an InvalidInput error.

      Returns:
      channel

    • getSyncedAt

      ZonedDateTime getSyncedAt()

      If not set, it defaults to the current date and time.

      Returns:
      syncedAt

    • setExternalId

      void setExternalId(String externalId)

      Set this to identify an external order instance, file, or other resource.

      Parameters:
      externalId - value to be set

    • setChannel

      void setChannel(ChannelResourceIdentifier channel)

      The synchronization destination to set. Must not be empty. The referenced Channel must have the Channel Role OrderExport or OrderImport. Otherwise this update action returns an InvalidInput error.

      Parameters:
      channel - value to be set

    • setSyncedAt

      void setSyncedAt(ZonedDateTime syncedAt)

      If not set, it defaults to the current date and time.

      Parameters:
      syncedAt - value to be set

    • of

      static StagedOrderUpdateSyncInfoAction of()
      factory method
      Returns:
      instance of StagedOrderUpdateSyncInfoAction

    • of

      static StagedOrderUpdateSyncInfoAction of(StagedOrderUpdateSyncInfoAction template)
      factory method to create a shallow copy StagedOrderUpdateSyncInfoAction
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • deepCopy

      @Nullable static StagedOrderUpdateSyncInfoAction deepCopy(@Nullable StagedOrderUpdateSyncInfoAction template)
      factory method to create a deep copy of StagedOrderUpdateSyncInfoAction
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • builder

      static StagedOrderUpdateSyncInfoActionBuilder builder()
      builder factory method for StagedOrderUpdateSyncInfoAction
      Returns:
      builder

    • builder

      static StagedOrderUpdateSyncInfoActionBuilder builder(StagedOrderUpdateSyncInfoAction template)
      create builder for StagedOrderUpdateSyncInfoAction instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder

    • withStagedOrderUpdateSyncInfoAction

      default <T> T withStagedOrderUpdateSyncInfoAction(Function<StagedOrderUpdateSyncInfoAction,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<StagedOrderUpdateSyncInfoAction> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference