Package com.commercetools.importapi.models.importoperations

Interface ImportOperation

public interface ImportOperation

Import Operation describes the import status of a specific resource.

Example to create an instance using the builder pattern 

     ImportOperation importOperation = ImportOperation.builder()
             .version(1)
             .importContainerKey("{importContainerKey}")
             .resourceKey("{resourceKey}")
             .id("{id}")
             .state(ProcessingState.PROCESSING)
             .createdAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .lastModifiedAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .expiresAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .build()

  • Method Details

    • getVersion

      @NotNull @NotNull Long getVersion()

      The version of the ImportOperation.

      Returns:
      version

    • getImportContainerKey

      @NotNull @NotNull String getImportContainerKey()

      The key of the importContainer.

      Returns:
      importContainerKey

    • getResourceKey

      @NotNull @NotNull String getResourceKey()

      The key of the resource.

      Returns:
      resourceKey

    • getId

      @NotNull @NotNull String getId()

      The ID of the ImportOperation.

      Returns:
      id

    • getState

      @NotNull @NotNull ProcessingState getState()

      The import status of the resource. Set to rejected or validationFailed if the import of the resource was not successful.

      Returns:
      state

    • getResourceVersion

      Long getResourceVersion()

      The version of the imported resource when the import was successful.

      Returns:
      resourceVersion

    • getErrors

      @Valid @Valid List<ErrorObject> getErrors()

      Contains an error if the import of the resource was not successful. See Errors.

      Returns:
      errors

    • getUnresolvedReferences

      @Valid @Valid List<UnresolvedReferences> getUnresolvedReferences()

      In case of unresolved status this array will show the unresolved references

      Returns:
      unresolvedReferences

    • getCreatedAt

      @NotNull @NotNull ZonedDateTime getCreatedAt()

      The time when the ImportOperation was created.

      Returns:
      createdAt

    • getLastModifiedAt

      @NotNull @NotNull ZonedDateTime getLastModifiedAt()

      The last time When the ImportOperation was modified.

      Returns:
      lastModifiedAt

    • getExpiresAt

      @NotNull @NotNull ZonedDateTime getExpiresAt()

      The expiration time of the ImportOperation.

      Returns:
      expiresAt

    • setVersion

      void setVersion(Long version)

      The version of the ImportOperation.

      Parameters:
      version - value to be set

    • setImportContainerKey

      void setImportContainerKey(String importContainerKey)

      The key of the importContainer.

      Parameters:
      importContainerKey - value to be set

    • setResourceKey

      void setResourceKey(String resourceKey)

      The key of the resource.

      Parameters:
      resourceKey - value to be set

    • setId

      void setId(String id)

      The ID of the ImportOperation.

      Parameters:
      id - value to be set

    • setState

      void setState(ProcessingState state)

      The import status of the resource. Set to rejected or validationFailed if the import of the resource was not successful.

      Parameters:
      state - value to be set

    • setResourceVersion

      void setResourceVersion(Long resourceVersion)

      The version of the imported resource when the import was successful.

      Parameters:
      resourceVersion - value to be set

    • setErrors

      void setErrors(ErrorObject... errors)

      Contains an error if the import of the resource was not successful. See Errors.

      Parameters:
      errors - values to be set

    • setErrors

      void setErrors(List<ErrorObject> errors)

      Contains an error if the import of the resource was not successful. See Errors.

      Parameters:
      errors - values to be set

    • setUnresolvedReferences

      void setUnresolvedReferences(UnresolvedReferences... unresolvedReferences)

      In case of unresolved status this array will show the unresolved references

      Parameters:
      unresolvedReferences - values to be set

    • setUnresolvedReferences

      void setUnresolvedReferences(List<UnresolvedReferences> unresolvedReferences)

      In case of unresolved status this array will show the unresolved references

      Parameters:
      unresolvedReferences - values to be set

    • setCreatedAt

      void setCreatedAt(ZonedDateTime createdAt)

      The time when the ImportOperation was created.

      Parameters:
      createdAt - value to be set

    • setLastModifiedAt

      void setLastModifiedAt(ZonedDateTime lastModifiedAt)

      The last time When the ImportOperation was modified.

      Parameters:
      lastModifiedAt - value to be set

    • setExpiresAt

      void setExpiresAt(ZonedDateTime expiresAt)

      The expiration time of the ImportOperation.

      Parameters:
      expiresAt - value to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static ImportOperationBuilder builder()
      builder factory method for ImportOperation
      Returns:
      builder

    • builder

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

    • withImportOperation

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