Files
elasticsearch-js/docs/reference/api/QueryRulesPutRuleRequest.md
2025-05-28 10:02:30 -05:00

13 lines
1.4 KiB
Markdown

# `QueryRulesPutRuleRequest` [interface-QueryRulesPutRuleRequest]
| Name | Type | Description |
| - | - | - |
| `actions` | [QueryRulesQueryRuleActions](./QueryRulesQueryRuleActions.md) | The actions to take when the rule is matched. The format of this action depends on the rule type. |
| `body` | string | ({ [key: string]: any; } & { ruleset_id?: never; rule_id?: never; type?: never; criteria?: never; actions?: never; priority?: never; }) | All values in `body` will be added to the request body. |
| `criteria` | [QueryRulesQueryRuleCriteria](./QueryRulesQueryRuleCriteria.md) | [QueryRulesQueryRuleCriteria](./QueryRulesQueryRuleCriteria.md)[] | The criteria that must be met for the rule to be applied. If multiple criteria are specified for a rule, all criteria must be met for the rule to be applied. |
| `priority` | [integer](./integer.md) |   |
| `querystring` | { [key: string]: any; } & { ruleset_id?: never; rule_id?: never; type?: never; criteria?: never; actions?: never; priority?: never; } | All values in `querystring` will be added to the request querystring. |
| `rule_id` | [Id](./Id.md) | The unique identifier of the query rule within the specified ruleset to be created or updated. |
| `ruleset_id` | [Id](./Id.md) | The unique identifier of the query ruleset containing the rule to be created or updated. |
| `type` | [QueryRulesQueryRuleType](./QueryRulesQueryRuleType.md) | The type of rule. |