Package com.commercetools.importapi.models.importcontainers

Interface ImportContainerDraft

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

The representation sent to the server to create 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.

      Returns:
      key

    • getResourceType

      ImportResourceType getResourceType()

      The resource type the ImportContainer will accept. If not specified, the ImportContainer can import all of the supported ImportResourceTypes.

      Returns:
      resourceType

    • getRetentionPolicy

      @Valid @Valid RetentionPolicy getRetentionPolicy()

      Set a retention policy to automatically delete the ImportContainer after a defined period.

      Returns:
      retentionPolicy

    • setKey

      void setKey(String key)

      User-defined unique identifier of the ImportContainer.

      Parameters:
      key - value to be set

    • setResourceType

      void setResourceType(ImportResourceType resourceType)

      The resource type the ImportContainer will accept. If not specified, the ImportContainer can import all of the supported ImportResourceTypes.

      Parameters:
      resourceType - value to be set

    • setRetentionPolicy

      void setRetentionPolicy(RetentionPolicy retentionPolicy)

      Set a retention policy to automatically delete the ImportContainer after a defined period.

      Parameters:
      retentionPolicy - 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

    • copyDeep

      ImportContainerDraft copyDeep()

    • 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