Package com.broadleafcommerce.search.index.core.domain

Class ReindexRequest

java.lang.Object
com.broadleafcommerce.search.index.core.domain.ReindexRequest
All Implemented Interfaces:
Serializable
public class ReindexRequest extends Object implements Serializable
Payload object representing a request to fully reindex an indexable type.
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    ReindexRequest()
     
    ReindexRequest(String name, com.broadleafcommerce.search.api.type.IndexableType type, boolean enablePartialIndexWithFilters, Instant startDate, Instant endDate, boolean useAllTenants)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected boolean
    canEqual(Object other)
     
    boolean
    equals(Object o)
     
    Instant
    getEndDate()
    A date used to filter the reindex of items.
    String
    getName()
    The requested name to identify the requested reindex to administrators.
    Instant
    getStartDate()
    A date used to filter the reindex of items.
    com.broadleafcommerce.search.api.type.IndexableType
    getType()
    The IndexableType for which the reindex is requested.
    int
    hashCode()
     
    boolean
    isEnablePartialIndexWithFilters()
    Determines if the current reindex request has potential filters to limit the items indexed.
    boolean
    isUseAllTenants()
    A toggle used to filter the reindex of items.
    void
    setEnablePartialIndexWithFilters(boolean enablePartialIndexWithFilters)
    Determines if the current reindex request has potential filters to limit the items indexed.
    void
    setEndDate(Instant endDate)
    A date used to filter the reindex of items.
    void
    setName(String name)
    The requested name to identify the requested reindex to administrators.
    void
    setStartDate(Instant startDate)
    A date used to filter the reindex of items.
    void
    setType(com.broadleafcommerce.search.api.type.IndexableType type)
    The IndexableType for which the reindex is requested.
    void
    setUseAllTenants(boolean useAllTenants)
    A toggle used to filter the reindex of items.
    String
    toString()
     

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • ReindexRequest

      public ReindexRequest(@Nullable String name, com.broadleafcommerce.search.api.type.IndexableType type, boolean enablePartialIndexWithFilters, Instant startDate, Instant endDate, boolean useAllTenants)

    • ReindexRequest

      public ReindexRequest()

  • Method Details

    • getName

      @Nullable public String getName()
      The requested name to identify the requested reindex to administrators.

      If this is left null, a name will be generated with the following format:

      $type + " Reindex - " + $timestamp

      Returns:
      the requested name to identify the requested reindex to administrators

    • getType

      public com.broadleafcommerce.search.api.type.IndexableType getType()
      The IndexableType for which the reindex is requested.
      Returns:
      the type for which the reindex is requested

    • isEnablePartialIndexWithFilters

      public boolean isEnablePartialIndexWithFilters()
      Determines if the current reindex request has potential filters to limit the items indexed. Turns the reindex request into a partial reindex based on the provided filters.

    • getStartDate

      public Instant getStartDate()
      A date used to filter the reindex of items. This is used to determine the minimum date when filtering items to be indexed.

    • getEndDate

      public Instant getEndDate()
      A date used to filter the reindex of items. This is used to determine the maximum date when filtering items to be indexed.

    • isUseAllTenants

      public boolean isUseAllTenants()
      A toggle used to filter the reindex of items. This is used to determine if the current Tenant should be used to limit the items indexed. True if the tenant is not taken into account, false otherwise.

    • setName

      public void setName(@Nullable String name)
      The requested name to identify the requested reindex to administrators.

      If this is left null, a name will be generated with the following format:

      $type + " Reindex - " + $timestamp

      Parameters:
      type - the requested name to identify the requested reindex to administrators

    • setType

      public void setType(com.broadleafcommerce.search.api.type.IndexableType type)
      The IndexableType for which the reindex is requested.
      Parameters:
      type - the type for which the reindex is requested

    • setEnablePartialIndexWithFilters

      public void setEnablePartialIndexWithFilters(boolean enablePartialIndexWithFilters)
      Determines if the current reindex request has potential filters to limit the items indexed. Turns the reindex request into a partial reindex based on the provided filters.

    • setStartDate

      public void setStartDate(Instant startDate)
      A date used to filter the reindex of items. This is used to determine the minimum date when filtering items to be indexed.

    • setEndDate

      public void setEndDate(Instant endDate)
      A date used to filter the reindex of items. This is used to determine the maximum date when filtering items to be indexed.

    • setUseAllTenants

      public void setUseAllTenants(boolean useAllTenants)
      A toggle used to filter the reindex of items. This is used to determine if the current Tenant should be used to limit the items indexed. True if the tenant is not taken into account, false otherwise.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object