Package com.commercetools.importapi.models.importcontainers

Interface ImportContainerDraft

All Superinterfaces:
Draft<ImportContainerDraft>
public interface ImportContainerDraft extends Draft<ImportContainerDraft>

The representation sent to the server when creating an ImportContainer.

Example to create an instance using the builder pattern 

     ImportContainerDraft importContainerDraft = ImportContainerDraft.builder()
             .key("{key}")
             .build()

  • Method Details

    • getKey

      @NotNull @NotNull String getKey()

      User-defined unique identifier of the ImportContainer. Keys can only contain alphanumeric characters (a-Z, 0-9), underscores and hyphens (_, -).

      Returns:
      key

    • getResourceType

      ImportResourceType getResourceType()

      The resource type to be imported. If not given, the ImportContainer is able to import all of the supported ImportResourceTypes.

      Returns:
      resourceType

    • setKey

      void setKey(String key)

      User-defined unique identifier of the ImportContainer. Keys can only contain alphanumeric characters (a-Z, 0-9), underscores and hyphens (_, -).

      Parameters:
      key - value to be set

    • setResourceType

      void setResourceType(ImportResourceType resourceType)

      The resource type to be imported. If not given, the ImportContainer is able to import all of the supported ImportResourceTypes.

      Parameters:
      resourceType - value to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static ImportContainerDraftBuilder builder()
      builder factory method for ImportContainerDraft
      Returns:
      builder

    • builder

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

    • withImportContainerDraft

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