Package com.commercetools.importapi.models.common

Interface ChannelKeyReference

All Superinterfaces:
KeyReference
public interface ChannelKeyReference extends KeyReference

Used by the Import API to identify a Channel.

Example to create an instance using the builder pattern 

     ChannelKeyReference channelKeyReference = ChannelKeyReference.builder()
             .key("{key}")
             .build()

  • Field Details

  • Method Details

    • getKey

      @NotNull @NotNull String getKey()

      User-defined unique identifier of the referenced Channel.

      Specified by:
      getKey in interface KeyReference
      Returns:
      key

    • setKey

      void setKey(String key)

      User-defined unique identifier of the referenced Channel.

      Specified by:
      setKey in interface KeyReference
      Parameters:
      key - value to be set

    • of

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

    • of

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

    • copyDeep

      ChannelKeyReference copyDeep()
      Specified by:
      copyDeep in interface KeyReference

    • deepCopy

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

    • builder

      static ChannelKeyReferenceBuilder builder()
      builder factory method for ChannelKeyReference
      Returns:
      builder

    • builder

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

    • withChannelKeyReference

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