Package com.commercetools.api.models.common

Interface ClientLogging

All Known Subinterfaces:
CreatedBy, LastModifiedBy
public interface ClientLogging

These objects represent information about which API Client created or modified a resource. For more information, see Client Logging.

Example to create an instance using the builder pattern 

     ClientLogging clientLogging = ClientLogging.builder()
             .build()

  • Method Details

    • getClientId

      String getClientId()

      id of the API Client which created the resource.

      Returns:
      clientId

    • getExternalUserId

      String getExternalUserId()

      External user ID provided by X-External-User-ID HTTP Header.

      Returns:
      externalUserId

    • getCustomer

      @Valid @Valid CustomerReference getCustomer()

      Indicates the Customer who modified the resource using a token from the password flow.

      Returns:
      customer

    • getAnonymousId

      String getAnonymousId()

      Indicates that the resource was modified during an anonymous session with the logged ID.

      Returns:
      anonymousId

    • getAssociate

      @Valid @Valid CustomerReference getAssociate()

      Indicates the Customer who created or modified the resource in the context of a Business Unit. Only present when an Associate acts on behalf of a company using the associate endpoints.

      Returns:
      associate

    • setClientId

      void setClientId(String clientId)

      id of the API Client which created the resource.

      Parameters:
      clientId - value to be set

    • setExternalUserId

      void setExternalUserId(String externalUserId)

      External user ID provided by X-External-User-ID HTTP Header.

      Parameters:
      externalUserId - value to be set

    • setCustomer

      void setCustomer(CustomerReference customer)

      Indicates the Customer who modified the resource using a token from the password flow.

      Parameters:
      customer - value to be set

    • setAnonymousId

      void setAnonymousId(String anonymousId)

      Indicates that the resource was modified during an anonymous session with the logged ID.

      Parameters:
      anonymousId - value to be set

    • setAssociate

      void setAssociate(CustomerReference associate)

      Indicates the Customer who created or modified the resource in the context of a Business Unit. Only present when an Associate acts on behalf of a company using the associate endpoints.

      Parameters:
      associate - value to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static ClientLoggingBuilder builder()
      builder factory method for ClientLogging
      Returns:
      builder

    • builder

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

    • withClientLogging

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