Package com.commercetools.api.models.order

Interface SyncInfo

public interface SyncInfo

Contains synchronization activity information of the Order (like export or import).

Example to create an instance using the builder pattern 

     SyncInfo syncInfo = SyncInfo.builder()
             .channel(channelBuilder -> channelBuilder)
             .syncedAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .build()

  • Method Details

    • getChannel

      @NotNull @Valid @NotNull @Valid ChannelReference getChannel()

      Connection to a synchronization destination.

      Returns:
      channel

    • getExternalId

      String getExternalId()

      Identifier of an external order instance, file, or other resource.

      Returns:
      externalId

    • getSyncedAt

      @NotNull @NotNull ZonedDateTime getSyncedAt()

      Date and time (UTC) the information was synced.

      Returns:
      syncedAt

    • setChannel

      void setChannel(ChannelReference channel)

      Connection to a synchronization destination.

      Parameters:
      channel - value to be set

    • setExternalId

      void setExternalId(String externalId)

      Identifier of an external order instance, file, or other resource.

      Parameters:
      externalId - value to be set

    • setSyncedAt

      void setSyncedAt(ZonedDateTime syncedAt)

      Date and time (UTC) the information was synced.

      Parameters:
      syncedAt - value to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static SyncInfoBuilder builder()
      builder factory method for SyncInfo
      Returns:
      builder

    • builder

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

    • withSyncInfo

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