Pipeline step that re-indexes one or more configured search indexers for the pipeline's organisation. The indexers to run are identified by indexerIds. When async is false the reindex runs inline as part of the pipeline execution; when true it is handed off to the AsynchProcessor queue as a background job and the pipeline continues without waiting for it to complete. Configured in pipeline XML as Reindex.
Implements: PipelineStep
Properties
| Property | Returns | Description |
|---|---|---|
| async | boolean | Whether this step queues the reindex as a background job (true) rather than running it inline as part of pipeline execution (false). |
| description | String | Short, human-readable description of this step shown to administrators managing a pipeline. |
| formPath | String | Path to the velocity template that renders this step's management UI form. |
| indexerIds | List<String> | IDs of the app search indexers this step re-indexes when it runs. |
Methods
getFormPath()
Returns: String
Path to the velocity template that renders this step's management UI form.
getDescription()
Returns: String
Short, human-readable description of this step shown to administrators managing a pipeline.
getIndexerIds()
Returns: List<String>
IDs of the app search indexers this step re-indexes when it runs.
isAsync()
Returns: boolean
Whether this step queues the reindex as a background job (true) rather than running it inline as part of pipeline execution (false).