Package com.commercetools.api.models.common

Class ClientLoggingBuilder

java.lang.Object
com.commercetools.api.models.common.ClientLoggingBuilder
All Implemented Interfaces:
Builder<ClientLogging>
public class ClientLoggingBuilder extends Object implements Builder<ClientLogging>
ClientLoggingBuilder
Example to create an instance using the builder pattern 

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

  • Constructor Details

    • ClientLoggingBuilder

      public ClientLoggingBuilder()

  • Method Details

    • clientId

      public ClientLoggingBuilder clientId(@Nullable String clientId)

      id of the API Client which created the resource.

      Parameters:
      clientId - value to be set
      Returns:
      Builder

    • externalUserId

      public ClientLoggingBuilder externalUserId(@Nullable String externalUserId)

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

      Parameters:
      externalUserId - value to be set
      Returns:
      Builder

    • customer

      public ClientLoggingBuilder customer(Function<CustomerReferenceBuilder,CustomerReferenceBuilder> builder)

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

      Parameters:
      builder - function to build the customer value
      Returns:
      Builder

    • withCustomer

      public ClientLoggingBuilder withCustomer(Function<CustomerReferenceBuilder,CustomerReference> builder)

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

      Parameters:
      builder - function to build the customer value
      Returns:
      Builder

    • customer

      public ClientLoggingBuilder customer(@Nullable CustomerReference customer)

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

      Parameters:
      customer - value to be set
      Returns:
      Builder

    • anonymousId

      public ClientLoggingBuilder anonymousId(@Nullable String anonymousId)

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

      Parameters:
      anonymousId - value to be set
      Returns:
      Builder

    • associate

      public ClientLoggingBuilder associate(Function<CustomerReferenceBuilder,CustomerReferenceBuilder> builder)

      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:
      builder - function to build the associate value
      Returns:
      Builder

    • withAssociate

      public ClientLoggingBuilder withAssociate(Function<CustomerReferenceBuilder,CustomerReference> builder)

      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:
      builder - function to build the associate value
      Returns:
      Builder

    • associate

      public ClientLoggingBuilder associate(@Nullable 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
      Returns:
      Builder

    • getClientId

      @Nullable public String getClientId()

      id of the API Client which created the resource.

      Returns:
      clientId

    • getExternalUserId

      @Nullable public String getExternalUserId()

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

      Returns:
      externalUserId

    • getCustomer

      @Nullable public CustomerReference getCustomer()

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

      Returns:
      customer

    • getAnonymousId

      @Nullable public String getAnonymousId()

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

      Returns:
      anonymousId

    • getAssociate

      @Nullable public 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

    • build

      public ClientLogging build()
      builds ClientLogging with checking for non-null required values
      Specified by:
      build in interface Builder<ClientLogging>
      Returns:
      ClientLogging

    • buildUnchecked

      public ClientLogging buildUnchecked()
      builds ClientLogging without checking for non-null required values
      Returns:
      ClientLogging

    • of

      public static ClientLoggingBuilder of()
      factory method for an instance of ClientLoggingBuilder
      Returns:
      builder

    • of

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