Package com.commercetools.importapi.models.common

Interface CustomObjectKeyReference

All Superinterfaces:
KeyReference
public interface CustomObjectKeyReference extends KeyReference

Used by the Import API to identify a CustomObject.

Example to create an instance using the builder pattern 

     CustomObjectKeyReference customObjectKeyReference = CustomObjectKeyReference.builder()
             .key("{key}")
             .container("{container}")
             .build()

  • Field Details

    • KEY_VALUE_DOCUMENT

      static final String KEY_VALUE_DOCUMENT
      discriminator value for CustomObjectKeyReference
      See Also:

  • Method Details

    • getKey

      @NotNull @NotNull String getKey()

      User-defined unique identifier of the referenced CustomObject.

      Specified by:
      getKey in interface KeyReference
      Returns:
      key

    • getContainer

      @NotNull @NotNull String getContainer()

      The container of the referenced CustomObject.

      Returns:
      container

    • setKey

      void setKey(String key)

      User-defined unique identifier of the referenced CustomObject.

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

    • setContainer

      void setContainer(String container)

      The container of the referenced CustomObject.

      Parameters:
      container - value to be set

    • of

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

    • of

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

    • copyDeep

      CustomObjectKeyReference copyDeep()
      Specified by:
      copyDeep in interface KeyReference

    • deepCopy

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

    • builder

      static CustomObjectKeyReferenceBuilder builder()
      builder factory method for CustomObjectKeyReference
      Returns:
      builder

    • builder

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

    • withCustomObjectKeyReference

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