MetricAlertResourceInner Class

Package:

com.azure.resourcemanager.monitor.fluent.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-monitor:2.44.0

• java.lang.Object
• • com.azure.core.management.ProxyResource
  • • com.azure.core.management.Resource
    • • com.azure.resourcemanager.monitor.fluent.models.MetricAlertResourceInner

public final class MetricAlertResourceInner
extends Resource

The metric alert resource.

Constructor Summary

Constructor	Description
MetricAlertResourceInner()	Creates an instance of MetricAlertResourceInner class.

Method Summary

Modifier and Type	Method and Description
List<MetricAlertAction>	actions() Get the actions property: the array of actions that are performed when the alert rule becomes active, and when an alert condition is resolved.
Boolean	autoMitigate() Get the autoMitigate property: the flag that indicates whether the alert should be auto resolved or not.
MetricAlertCriteria	criteria() Get the criteria property: defines the specific alert criteria information.
String	description() Get the description property: the description of the metric alert that will be included in the alert email.
boolean	enabled() Get the enabled property: the flag that indicates whether the metric alert is enabled.
Duration	evaluationFrequency() Get the evaluationFrequency property: how often the metric alert is evaluated represented in ISO 8601 duration format.
static MetricAlertResourceInner	fromJson(JsonReader jsonReader) Reads an instance of MetricAlertResourceInner from the JsonReader.
String	id() Get the id property: Fully qualified resource Id for the resource.
Boolean	isMigrated() Get the isMigrated property: the value indicating whether this alert rule is migrated.
OffsetDateTime	lastUpdatedTime() Get the lastUpdatedTime property: Last time the rule was updated in ISO8601 format.
String	name() Get the name property: The name of the resource.
List<String>	scopes() Get the scopes property: the list of resource id's that this metric alert is scoped to.
int	severity() Get the severity property: Alert severity {0, 1, 2, 3, 4}.
String	targetResourceRegion() Get the targetResourceRegion property: the region of the target resource(s) on which the alert is created/updated.
String	targetResourceType() Get the targetResourceType property: the resource type of the target resource(s) on which the alert is created/updated.
JsonWriter	toJson(JsonWriter jsonWriter)
String	type() Get the type property: The type of the resource.
void	validate() Validates the instance.
Duration	windowSize() Get the windowSize property: the period of time (in ISO 8601 duration format) that is used to monitor alert activity based on the threshold.
MetricAlertResourceInner	withActions(List<MetricAlertAction> actions) Set the actions property: the array of actions that are performed when the alert rule becomes active, and when an alert condition is resolved.
MetricAlertResourceInner	withAutoMitigate(Boolean autoMitigate) Set the autoMitigate property: the flag that indicates whether the alert should be auto resolved or not.
MetricAlertResourceInner	withCriteria(MetricAlertCriteria criteria) Set the criteria property: defines the specific alert criteria information.
MetricAlertResourceInner	withDescription(String description) Set the description property: the description of the metric alert that will be included in the alert email.
MetricAlertResourceInner	withEnabled(boolean enabled) Set the enabled property: the flag that indicates whether the metric alert is enabled.
MetricAlertResourceInner	withEvaluationFrequency(Duration evaluationFrequency) Set the evaluationFrequency property: how often the metric alert is evaluated represented in ISO 8601 duration format.
MetricAlertResourceInner	withLocation(String location)
MetricAlertResourceInner	withScopes(List<String> scopes) Set the scopes property: the list of resource id's that this metric alert is scoped to.
MetricAlertResourceInner	withSeverity(int severity) Set the severity property: Alert severity {0, 1, 2, 3, 4}.
MetricAlertResourceInner	withTags(Map<String,String> tags)
MetricAlertResourceInner	withTargetResourceRegion(String targetResourceRegion) Set the targetResourceRegion property: the region of the target resource(s) on which the alert is created/updated.
MetricAlertResourceInner	withTargetResourceType(String targetResourceType) Set the targetResourceType property: the resource type of the target resource(s) on which the alert is created/updated.
MetricAlertResourceInner	withWindowSize(Duration windowSize) Set the windowSize property: the period of time (in ISO 8601 duration format) that is used to monitor alert activity based on the threshold.

Methods inherited from ProxyResource

id name type

Methods inherited from Resource

fromJson location tags toJson withLocation withTags

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

MetricAlertResourceInner

public MetricAlertResourceInner()

Creates an instance of MetricAlertResourceInner class.

Method Details

actions

public List actions()

Get the actions property: the array of actions that are performed when the alert rule becomes active, and when an alert condition is resolved.

Returns:

the actions value.

autoMitigate

public Boolean autoMitigate()

Get the autoMitigate property: the flag that indicates whether the alert should be auto resolved or not. The default is true.

Returns:

the autoMitigate value.

criteria

public MetricAlertCriteria criteria()

Get the criteria property: defines the specific alert criteria information.

Returns:

the criteria value.

description

public String description()

Get the description property: the description of the metric alert that will be included in the alert email.

Returns:

the description value.

enabled

public boolean enabled()

Get the enabled property: the flag that indicates whether the metric alert is enabled.

Returns:

the enabled value.

evaluationFrequency

public Duration evaluationFrequency()

Get the evaluationFrequency property: how often the metric alert is evaluated represented in ISO 8601 duration format.

Returns:

the evaluationFrequency value.

fromJson

public static MetricAlertResourceInner fromJson(JsonReader jsonReader)

Reads an instance of MetricAlertResourceInner from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of MetricAlertResourceInner if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If the deserialized JSON object was missing any required properties.

id

public String id()

Get the id property: Fully qualified resource Id for the resource.

Overrides:

MetricAlertResourceInner.id()

Returns:

the id value.

isMigrated

public Boolean isMigrated()

Get the isMigrated property: the value indicating whether this alert rule is migrated.

Returns:

the isMigrated value.

lastUpdatedTime

public OffsetDateTime lastUpdatedTime()

Get the lastUpdatedTime property: Last time the rule was updated in ISO8601 format.

Returns:

the lastUpdatedTime value.

name

public String name()

Get the name property: The name of the resource.

Overrides:

MetricAlertResourceInner.name()

Returns:

the name value.

scopes

public List scopes()

Get the scopes property: the list of resource id's that this metric alert is scoped to.

Returns:

the scopes value.

severity

public int severity()

Get the severity property: Alert severity {0, 1, 2, 3, 4}.

Returns:

the severity value.

targetResourceRegion

public String targetResourceRegion()

Get the targetResourceRegion property: the region of the target resource(s) on which the alert is created/updated. Mandatory if the scope contains a subscription, resource group, or more than one resource.

Returns:

the targetResourceRegion value.

targetResourceType

public String targetResourceType()

Get the targetResourceType property: the resource type of the target resource(s) on which the alert is created/updated. Mandatory if the scope contains a subscription, resource group, or more than one resource.

Returns:

the targetResourceType value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

MetricAlertResourceInner.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

type

public String type()

Get the type property: The type of the resource.

Overrides:

MetricAlertResourceInner.type()

Returns:

the type value.

validate

public void validate()

Validates the instance.

windowSize

public Duration windowSize()

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

Returns:

the windowSize value.

withActions

public MetricAlertResourceInner withActions(List actions)

Set the actions property: the array of actions that are performed when the alert rule becomes active, and when an alert condition is resolved.

Parameters:

actions - the actions value to set.

Returns:

the MetricAlertResourceInner object itself.

withAutoMitigate

public MetricAlertResourceInner withAutoMitigate(Boolean autoMitigate)

Set the autoMitigate property: the flag that indicates whether the alert should be auto resolved or not. The default is true.

Parameters:

autoMitigate - the autoMitigate value to set.

Returns:

the MetricAlertResourceInner object itself.

withCriteria

public MetricAlertResourceInner withCriteria(MetricAlertCriteria criteria)

Set the criteria property: defines the specific alert criteria information.

Parameters:

criteria - the criteria value to set.

Returns:

the MetricAlertResourceInner object itself.

withDescription

public MetricAlertResourceInner withDescription(String description)

Set the description property: the description of the metric alert that will be included in the alert email.

Parameters:

description - the description value to set.

Returns:

the MetricAlertResourceInner object itself.

withEnabled

public MetricAlertResourceInner withEnabled(boolean enabled)

Set the enabled property: the flag that indicates whether the metric alert is enabled.

Parameters:

enabled - the enabled value to set.

Returns:

the MetricAlertResourceInner object itself.

withEvaluationFrequency

public MetricAlertResourceInner withEvaluationFrequency(Duration evaluationFrequency)

Set the evaluationFrequency property: how often the metric alert is evaluated represented in ISO 8601 duration format.

Parameters:

evaluationFrequency - the evaluationFrequency value to set.

Returns:

the MetricAlertResourceInner object itself.

withLocation

public MetricAlertResourceInner withLocation(String location)

Overrides:

MetricAlertResourceInner.withLocation(String location)

Parameters:

location

withScopes

public MetricAlertResourceInner withScopes(List scopes)

Set the scopes property: the list of resource id's that this metric alert is scoped to.

Parameters:

scopes - the scopes value to set.

Returns:

the MetricAlertResourceInner object itself.

withSeverity

public MetricAlertResourceInner withSeverity(int severity)

Set the severity property: Alert severity {0, 1, 2, 3, 4}.

Parameters:

severity - the severity value to set.

Returns:

the MetricAlertResourceInner object itself.

withTags

public MetricAlertResourceInner withTags(Map tags)

Overrides:

MetricAlertResourceInner.withTags(Map<String,String> tags)

Parameters:

tags

withTargetResourceRegion

public MetricAlertResourceInner withTargetResourceRegion(String targetResourceRegion)

Set the targetResourceRegion property: the region of the target resource(s) on which the alert is created/updated. Mandatory if the scope contains a subscription, resource group, or more than one resource.

Parameters:

targetResourceRegion - the targetResourceRegion value to set.

Returns:

the MetricAlertResourceInner object itself.

withTargetResourceType

public MetricAlertResourceInner withTargetResourceType(String targetResourceType)

Set the targetResourceType property: the resource type of the target resource(s) on which the alert is created/updated. Mandatory if the scope contains a subscription, resource group, or more than one resource.

Parameters:

targetResourceType - the targetResourceType value to set.

Returns:

the MetricAlertResourceInner object itself.

withWindowSize

public MetricAlertResourceInner withWindowSize(Duration windowSize)

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

Parameters:

windowSize - the windowSize value to set.

Returns:

the MetricAlertResourceInner object itself.