MetricAlert.UpdateStages.WithMetricUpdate Interface

public static interface MetricAlert.UpdateStages.WithMetricUpdate

The stage of a metric alerts update allowing to modify settings.

Method Summary

Modifier and Type Method and Description
abstract MetricName<Update> defineAlertCriteria(String name)

Starts definition of the metric alert condition.

abstract MetricName<Update> defineDynamicAlertCriteria(String name)

Starts definition of the metric dynamic alert condition.

abstract UpdateStages updateAlertCriteria(String name)

Starts update of the previously defined metric alert condition.

abstract UpdateStages updateDynamicAlertCriteria(String name)

Starts update of the previously defined metric dynamic alert condition.

abstract Update withActionGroups(String[] actionGroupId)

Sets the actions that will activate when the condition is met.

abstract Update withAutoMitigation()

Sets the flag that indicates the alert should be auto resolved.

abstract Update withDescription(String description)

Sets description for metric alert.

abstract Update withFrequency(Duration frequency)

Sets how often the metric alert is evaluated represented in ISO 8601 duration format.

abstract Update withPeriod(Duration size)

Sets the period of time (in ISO 8601 duration format) that is used to monitor alert activity based on the threshold.

abstract Update withRuleDisabled()

Sets metric alert as disabled.

abstract Update withRuleEnabled()

Sets metric alert as enabled.

abstract Update withSeverity(int severity)

Sets alert severity {0, 1, 2, 3, 4}.

abstract Update withoutActionGroup(String actionGroupId)

Removes the specified action group from the actions list.

abstract Update withoutAlertCriteria(String name)

Removes a condition from the previously defined metric alert conditions.

abstract Update withoutAutoMitigation()

Sets the flag that indicates the alert should not be auto resolved.

Method Details

defineAlertCriteria

public abstract MetricAlertCondition.UpdateDefinitionStages.Blank.MetricName defineAlertCriteria(String name)

Starts definition of the metric alert condition.

Parameters:

name - sets the name of the condition.

Returns:

the next stage of the metric alert update.

defineDynamicAlertCriteria

public abstract MetricDynamicAlertCondition.UpdateDefinitionStages.Blank.MetricName defineDynamicAlertCriteria(String name)

Starts definition of the metric dynamic alert condition.

Parameters:

name - sets the name of the condition.

Returns:

the next stage of the metric alert update.

updateAlertCriteria

public abstract MetricAlertCondition.UpdateStages updateAlertCriteria(String name)

Starts update of the previously defined metric alert condition.

Parameters:

name - name of the condition that should be updated.

Returns:

the next stage of the metric alert update.

updateDynamicAlertCriteria

public abstract MetricDynamicAlertCondition.UpdateStages updateDynamicAlertCriteria(String name)

Starts update of the previously defined metric dynamic alert condition.

Parameters:

name - name of the condition that should be updated.

Returns:

the next stage of the metric alert update.

withActionGroups

public abstract MetricAlert.Update withActionGroups(String[] actionGroupId)

Sets the actions that will activate when the condition is met.

Parameters:

actionGroupId - resource Ids of the ActionGroup.

Returns:

the next stage of the metric alert update.

withAutoMitigation

public abstract MetricAlert.Update withAutoMitigation()

Sets the flag that indicates the alert should be auto resolved.

Returns:

the next stage of the metric alert update.

withDescription

public abstract MetricAlert.Update withDescription(String description)

Sets description for metric alert.

Parameters:

description - Human readable text description of the metric alert.

Returns:

the next stage of the metric alert update.

withFrequency

public abstract MetricAlert.Update withFrequency(Duration frequency)

Sets how often the metric alert is evaluated represented in ISO 8601 duration format.

Parameters:

frequency - the evaluationFrequency value to set.

Returns:

the next stage of the metric alert update.

withPeriod

public abstract MetricAlert.Update withPeriod(Duration size)

Sets the period of time (in ISO 8601 duration format) that is used to monitor alert activity based on the threshold.

Parameters:

size - the windowSize value to set

Returns:

the next stage of the metric alert update.

withRuleDisabled

public abstract MetricAlert.Update withRuleDisabled()

Sets metric alert as disabled.

Returns:

the next stage of the metric alert update.

withRuleEnabled

public abstract MetricAlert.Update withRuleEnabled()

Sets metric alert as enabled.

Returns:

the next stage of the metric alert update.

withSeverity

public abstract MetricAlert.Update withSeverity(int severity)

Sets alert severity {0, 1, 2, 3, 4}.

Parameters:

severity - the severity value to set

Returns:

the next stage of the metric alert update.

withoutActionGroup

public abstract MetricAlert.Update withoutActionGroup(String actionGroupId)

Removes the specified action group from the actions list.

Parameters:

actionGroupId - resource Id of the ActionGroup to remove.

Returns:

the next stage of the metric alert update.

withoutAlertCriteria

public abstract MetricAlert.Update withoutAlertCriteria(String name)

Removes a condition from the previously defined metric alert conditions.

Parameters:

name - name of the condition that should be removed.

Returns:

the next stage of the metric alert update.

withoutAutoMitigation

public abstract MetricAlert.Update withoutAutoMitigation()

Sets the flag that indicates the alert should not be auto resolved.

Returns:

the next stage of the metric alert update.

Applies to