Saved search query contributed by an app, registered with addQuery from a JSON file in the app repository. Holds the query definition as raw JSON together with the search indexes it may be run against and the roles a user must hold to run it. The file name of the path becomes the query's name when it is offered in the query picker.
Group: App Definitions
Implements: Serializable
Properties
| Property | Returns | Description |
|---|---|---|
| indexNames | List<String> | Search indexes this query may be run against. |
| json | String | Raw JSON query definition, read from the repository file when the app was initialised. |
| path | Path | Repository path of the JSON file the query was loaded from. Its file name is used as the query's name. |
| roleNames | List<String> | Roles a user must hold to run this query. |
Methods
getIndexNames()
Returns: List<String>
Search indexes this query may be run against.
getPath()
Returns: Path
Repository path of the JSON file the query was loaded from. Its file name is used as the query's name.
getRoleNames()
Returns: List<String>
Roles a user must hold to run this query.
getJson()
Returns: String
Raw JSON query definition, read from the repository file when the app was initialised.