new Reindex()
Reindex REST resource for starting/stopping/querying indexing.
Properties:
Name | Type | Description |
---|---|---|
connector |
IConnector | the jira connector instance |
- Source:
Methods
getReindexInfo(options, callbackopt) → {Promise.<any>}
Returns information on the system reindexes. If a reindex is currently taking place then information about this reindex is returned. If there is no active index task, then returns information about the latest reindex task run, otherwise returns a 404 indicating that no reindex has taken place.the id of an indexing task you wish to obtain details on. If omitted, then defaults to the standard behaviour and returns information on the active reindex task, or the last task to run if no reindex is taking place. . If there is no reindexing task with that id then a 404 is returned.
Parameters:
Name | Type | Attributes | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object | An object containing options to pass to the Jira API. Properties
|
||||||||||
callback |
<optional> |
if supplied, called with result of api call |
- Source:
Returns:
result of api call
- Type
- Promise.<any>
getReindexProgress(options, callbackopt) → {Promise.<any>}
Returns information on the system reindexes. If a reindex is currently taking place then information about this reindex is returned. If there is no active index task, then returns information about the latest reindex task run, otherwise returns a 404 indicating that no reindex has taken place.the id of an indexing task you wish to obtain details on. If omitted, then defaults to the standard behaviour and returns information on the active reindex task, or the last task to run if no reindex is taking place. . If there is no reindexing task with that id then a 404 is returned.
Parameters:
Name | Type | Attributes | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object | An object containing options to pass to the Jira API. Properties
|
||||||||||
callback |
<optional> |
if supplied, called with result of api call |
- Source:
Returns:
result of api call
- Type
- Promise.<any>
reindex(options, callbackopt) → {Promise.<any>}
Kicks off a reindex. Need Admin permissions to perform this reindex.Case insensitive String indicating type of reindex. If omitted, then defaults to BACKGROUND_PREFERRED.Default: falseIndicates that comments should also be reindexed. Not relevant for foreground reindex, where comments are always reindexed.Default: falseIndicates that changeHistory should also be reindexed. Not relevant for foreground reindex, where changeHistory is always reindexed.Default: falseIndicates that changeHistory should also be reindexed. Not relevant for foreground reindex, where changeHistory is always reindexed.
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object | An object containing options to pass to the Jira API. Properties
|
|||||||||||||||||||
callback |
<optional> |
if supplied, called with result of api call |
- Source:
Returns:
result of api call
- Type
- Promise.<any>
reindexIssues(options, callbackopt) → {Promise.<any>}
Reindexes one or more individual issues. Indexing is performed synchronously - the call returns when indexing of the issues has completed or a failure occurs.
Use either explicitly specified issue IDs or a JQL query to select issues to reindex.the IDs or keys of one or more issues to reindex.Default: falseIndicates that comments should also be reindexed.Default: falseIndicates that changeHistory should also be reindexed.Default: falseIndicates that changeHistory should also be reindexed.
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object | An object containing options to pass to the Jira API. Properties
|
|||||||||||||||||||
callback |
<optional> |
if supplied, called with result of api call |
- Source:
Returns:
result of api call
- Type
- Promise.<any>