rule

Subpackages

• data

Index

• fn withAnnotations(value)
• fn withAnnotationsMixin(value)
• fn withCondition(value)
• fn withData(value)
• fn withDataMixin(value)
• fn withExecErrState(value)
• fn withFolderUID(value)
• fn withFor(value)
• fn withIsPaused(value=true)
• fn withLabels(value)
• fn withLabelsMixin(value)
• fn withName(value)
• fn withNoDataState(value)
• fn withOrgID(value)
• fn withRuleGroup(value)

Fields

fn withAnnotations

withAnnotations(value)

PARAMETERS:

• value (object)

fn withAnnotationsMixin

withAnnotationsMixin(value)

PARAMETERS:

• value (object)

fn withCondition

withCondition(value)

PARAMETERS:

• value (string)

fn withData

withData(value)

PARAMETERS:

• value (array)

fn withDataMixin

withDataMixin(value)

PARAMETERS:

• value (array)

fn withExecErrState

withExecErrState(value)

PARAMETERS:

• value (string)
  • valid values: "OK", "Alerting", "Error"

fn withFolderUID

withFolderUID(value)

PARAMETERS:

• value (string)

fn withFor

withFor(value)

PARAMETERS:

• value (string)

The amount of time, in seconds, for which the rule must be breached for the rule to be considered to be Firing. Before this time has elapsed, the rule is only considered to be Pending.

fn withIsPaused

withIsPaused(value=true)

PARAMETERS:

• value (boolean)
  • default value: true

fn withLabels

withLabels(value)

PARAMETERS:

• value (object)

fn withLabelsMixin

withLabelsMixin(value)

PARAMETERS:

• value (object)

fn withName

withName(value)

PARAMETERS:

• value (string)

fn withNoDataState

withNoDataState(value)

PARAMETERS:

• value (string)
  • valid values: "Alerting", "NoData", "OK"

fn withOrgID

withOrgID(value)

PARAMETERS:

• value (integer)

fn withRuleGroup

withRuleGroup(value)

PARAMETERS:

• value (string)