Package com.commercetools.importapi.models.importcontainers

Interface ImportContainer

public interface ImportContainer

Serves as the entry point of resources. An Import Container is not resource type-specific.

Example to create an instance using the builder pattern 

     ImportContainer importContainer = ImportContainer.builder()
             .key("{key}")
             .version(0.3)
             .createdAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .lastModifiedAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .build()

  • Method Details

    • getKey

      @NotNull @NotNull String getKey()

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

      Returns:
      key

    • getResourceType

      ImportResourceType getResourceType()

      The resource type the ImportContainer is able to handle. If not present, the ImportContainer is able to import all of the supported ImportResourceTypes.

      Returns:
      resourceType

    • getVersion

      @NotNull @NotNull Long getVersion()

      The version of the ImportContainer.

      Returns:
      version

    • getCreatedAt

      @NotNull @NotNull ZonedDateTime getCreatedAt()

      The time when the ImportContainer was created.

      Returns:
      createdAt

    • getLastModifiedAt

      @NotNull @NotNull ZonedDateTime getLastModifiedAt()

      The last time when the ImportContainer was modified.

      Returns:
      lastModifiedAt

    • setKey

      void setKey(String key)

      User-defined unique identifier for 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 the ImportContainer is able to handle. If not present, the ImportContainer is able to import all of the supported ImportResourceTypes.

      Parameters:
      resourceType - value to be set

    • setVersion

      void setVersion(Long version)

      The version of the ImportContainer.

      Parameters:
      version - value to be set

    • setCreatedAt

      void setCreatedAt(ZonedDateTime createdAt)

      The time when the ImportContainer was created.

      Parameters:
      createdAt - value to be set

    • setLastModifiedAt

      void setLastModifiedAt(ZonedDateTime lastModifiedAt)

      The last time when the ImportContainer was modified.

      Parameters:
      lastModifiedAt - value to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static ImportContainerBuilder builder()
      builder factory method for ImportContainer
      Returns:
      builder

    • builder

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

    • withImportContainer

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