Package com.commercetools.api.models.common

Interface Attribution

public interface Attribution

Indicates the source and method that indirectly created or modified the resource. This is present on resources created or updated after 1 April 2024.

Example to create an instance using the builder pattern 

     Attribution attribution = Attribution.builder()
             .source(AttributionSource.IMPORT)
             .build()

  • Method Details

    • getClientId

      String getClientId()

      id of the API Client that created or modified the resource.

      Returns:
      clientId

    • getSource

      @NotNull @NotNull AttributionSource getSource()

      Method used to initiate the creation or modification of the resource.

      Returns:
      source

    • setClientId

      void setClientId(String clientId)

      id of the API Client that created or modified the resource.

      Parameters:
      clientId - value to be set

    • setSource

      void setSource(AttributionSource source)

      Method used to initiate the creation or modification of the resource.

      Parameters:
      source - value to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static AttributionBuilder builder()
      builder factory method for Attribution
      Returns:
      builder

    • builder

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

    • withAttribution

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