Class ReindexJob.ReindexJobBuilder
- java.lang.Object
-
- com.broadleafcommerce.search.index.core.domain.ReindexJob.ReindexJobBuilder
-
- Enclosing class:
- ReindexJob
public static class ReindexJob.ReindexJobBuilder extends Object
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ReindexJob.ReindexJobBuilder
author(String author)
The user that initiated this reindex process.ReindexJob
build()
ReindexJob.ReindexJobBuilder
endTime(Instant endTime)
The completion time of the processReindexJob.ReindexJobBuilder
errors(List<ReindexErrorDetails> errors)
A list of errors that may have occurred during the reindex process.ReindexJob.ReindexJobBuilder
expectedCount(Long expectedCount)
The expected number of items to be processed (May be an estimate, such as with Products)ReindexJob.ReindexJobBuilder
finishedLoadingQueueTime(Instant finishedLoadingQueueTime)
The time taken to load the queue for this job.ReindexJob.ReindexJobBuilder
finishedProcessingQueueTime(Instant finishedProcessingQueueTime)
The instant in time this queue was finished processing.ReindexJob.ReindexJobBuilder
id(String id)
ReindexJob.ReindexJobBuilder
indexableType(String indexableType)
The IndexableType of this job (e.g.ReindexJob.ReindexJobBuilder
lastUpdated(Instant lastUpdated)
The last update time of the processReindexJob.ReindexJobBuilder
name(String name)
The display name which will identify this job to admin users.ReindexJob.ReindexJobBuilder
nodeCount(Integer nodeCount)
The number of nodes involved in the reindex process.ReindexJob.ReindexJobBuilder
processedCount(Long processedCount)
The number of items processed during the full reindex.ReindexJob.ReindexJobBuilder
startTime(Instant startTime)
The start time of the processReindexJob.ReindexJobBuilder
status(ReindexStatus status)
The current status of the reindex process.ReindexJob.ReindexJobBuilder
threadCount(Integer threadCount)
The total number of threads used across all nodes.String
toString()
-
-
-
Method Detail
-
id
public ReindexJob.ReindexJobBuilder id(String id)
- Returns:
this
.
-
indexableType
public ReindexJob.ReindexJobBuilder indexableType(String indexableType)
The IndexableType of this job (e.g. Customer, Product, etc)- Returns:
this
.
-
name
public ReindexJob.ReindexJobBuilder name(String name)
The display name which will identify this job to admin users.- Returns:
this
.
-
author
public ReindexJob.ReindexJobBuilder author(String author)
The user that initiated this reindex process.- Returns:
this
.
-
startTime
public ReindexJob.ReindexJobBuilder startTime(Instant startTime)
The start time of the process- Returns:
this
.
-
endTime
public ReindexJob.ReindexJobBuilder endTime(Instant endTime)
The completion time of the process- Returns:
this
.
-
lastUpdated
public ReindexJob.ReindexJobBuilder lastUpdated(Instant lastUpdated)
The last update time of the process- Returns:
this
.
-
finishedLoadingQueueTime
public ReindexJob.ReindexJobBuilder finishedLoadingQueueTime(Instant finishedLoadingQueueTime)
The time taken to load the queue for this job. This is not set until the queue is completely loaded.- Returns:
this
.
-
finishedProcessingQueueTime
public ReindexJob.ReindexJobBuilder finishedProcessingQueueTime(Instant finishedProcessingQueueTime)
The instant in time this queue was finished processing. This is not set until all items in the queue have been processed.- Returns:
this
.
-
expectedCount
public ReindexJob.ReindexJobBuilder expectedCount(Long expectedCount)
The expected number of items to be processed (May be an estimate, such as with Products)- Returns:
this
.
-
processedCount
public ReindexJob.ReindexJobBuilder processedCount(Long processedCount)
The number of items processed during the full reindex. In the case of a completed process, this is the total number of items processed during the reindex. For in progress reindexing, this is regularly updated.- Returns:
this
.
-
nodeCount
public ReindexJob.ReindexJobBuilder nodeCount(Integer nodeCount)
The number of nodes involved in the reindex process. If this is not a distributed reindex, this will always be 1.- Returns:
this
.
-
threadCount
public ReindexJob.ReindexJobBuilder threadCount(Integer threadCount)
The total number of threads used across all nodes.- Returns:
this
.
-
status
public ReindexJob.ReindexJobBuilder status(ReindexStatus status)
The current status of the reindex process.- Returns:
this
.- See Also:
ReindexStatus
-
errors
public ReindexJob.ReindexJobBuilder errors(List<ReindexErrorDetails> errors)
A list of errors that may have occurred during the reindex process. This will be null if no errors have occurred.- Returns:
this
.
-
build
public ReindexJob build()
-
-