RulesetRule

data class RulesetRule(val action: String? = null, val actionParameters: RulesetRuleActionParameters? = null, val categories: List<String>? = null, val description: String? = null, val enabled: Boolean? = null, val exposedCredentialCheck: RulesetRuleExposedCredentialCheck? = null, val expression: String? = null, val id: String? = null, val logging: RulesetRuleLogging? = null, val ratelimit: RulesetRuleRatelimit? = null, val ref: String? = null)

Constructors

Link copied to clipboard
constructor(action: String? = null, actionParameters: RulesetRuleActionParameters? = null, categories: List<String>? = null, description: String? = null, enabled: Boolean? = null, exposedCredentialCheck: RulesetRuleExposedCredentialCheck? = null, expression: String? = null, id: String? = null, logging: RulesetRuleLogging? = null, ratelimit: RulesetRuleRatelimit? = null, ref: String? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val action: String? = null

The action to perform when the rule matches. Available values: "block".

Link copied to clipboard

The parameters configuring the rule's action.

Link copied to clipboard
val categories: List<String>? = null

The categories of the rule.

Link copied to clipboard
val description: String? = null

An informative description of the rule.

Link copied to clipboard
val enabled: Boolean? = null

Whether the rule should be executed.

Link copied to clipboard

Configure checks for exposed credentials.

Link copied to clipboard
val expression: String? = null

The expression defining which traffic will match the rule.

Link copied to clipboard
val id: String? = null

The unique ID of the rule.

Link copied to clipboard

An object configuring the rule's logging behavior.

Link copied to clipboard

An object configuring the rule's ratelimit behavior.

Link copied to clipboard
val ref: String? = null

The reference of the rule (the rule ID by default).