Package com.commercetools.api.models.customer_search

Interface CustomerSearchIndexingStatusResponse

public interface CustomerSearchIndexingStatusResponse
CustomerSearchIndexingStatusResponse
Example to create an instance using the builder pattern 

     CustomerSearchIndexingStatusResponse customerSearchIndexingStatusResponse = CustomerSearchIndexingStatusResponse.builder()
             .status(CustomerIndexingStatus.SCHEDULED)
             .build()

  • Method Details

    • getStatus

      @NotNull @NotNull CustomerIndexingStatus getStatus()

      Current status of indexing the Customer Search.

      Returns:
      status

    • getStates

      @Valid @Valid CustomerIndexingProgress getStates()

      Progress of indexing. Only available when indexing is in progress.

      Returns:
      states

    • getStartedAt

      ZonedDateTime getStartedAt()

      Date and time (UTC) when the last indexing started.

      Returns:
      startedAt

    • getLastModifiedAt

      ZonedDateTime getLastModifiedAt()

      Time when the status was last modified.

      Returns:
      lastModifiedAt

    • getRetryCount

      Integer getRetryCount()

      Indicates how many times the system tried to start indexing after failed attempts. The counter is set to null after an indexing finished successfully.

      Returns:
      retryCount

    • setStatus

      void setStatus(CustomerIndexingStatus status)

      Current status of indexing the Customer Search.

      Parameters:
      status - value to be set

    • setStates

      void setStates(CustomerIndexingProgress states)

      Progress of indexing. Only available when indexing is in progress.

      Parameters:
      states - value to be set

    • setStartedAt

      void setStartedAt(ZonedDateTime startedAt)

      Date and time (UTC) when the last indexing started.

      Parameters:
      startedAt - value to be set

    • setLastModifiedAt

      void setLastModifiedAt(ZonedDateTime lastModifiedAt)

      Time when the status was last modified.

      Parameters:
      lastModifiedAt - value to be set

    • setRetryCount

      void setRetryCount(Integer retryCount)

      Indicates how many times the system tried to start indexing after failed attempts. The counter is set to null after an indexing finished successfully.

      Parameters:
      retryCount - value to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static CustomerSearchIndexingStatusResponseBuilder builder()
      builder factory method for CustomerSearchIndexingStatusResponse
      Returns:
      builder

    • builder

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

    • withCustomerSearchIndexingStatusResponse

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