Package com.commercetools.importapi.models.common

Interface UnresolvedReferences

public interface UnresolvedReferences

Contains a reference to a resource which does not exist. For example, if a Category is imported with a parent Category that does not exist, the reference to the parent Category is an unresolved reference.

Example to create an instance using the builder pattern 

     UnresolvedReferences unresolvedReferences = UnresolvedReferences.builder()
             .key("{key}")
             .typeId(ReferenceType.ASSOCIATE_ROLE)
             .build()

  • Method Details

    • getKey

      @NotNull @NotNull String getKey()

      key of the unresolved resource.

      Returns:
      key

    • getTypeId

      @NotNull @NotNull ReferenceType getTypeId()

      Type of the unresolved resource.

      Returns:
      typeId

    • setKey

      void setKey(String key)

      key of the unresolved resource.

      Parameters:
      key - value to be set

    • setTypeId

      void setTypeId(ReferenceType typeId)

      Type of the unresolved resource.

      Parameters:
      typeId - value to be set

    • of

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

    • of

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

    • copyDeep

      UnresolvedReferences copyDeep()

    • deepCopy

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

    • builder

      static UnresolvedReferencesBuilder builder()
      builder factory method for UnresolvedReferences
      Returns:
      builder

    • builder

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

    • withUnresolvedReferences

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