Essentials Class
- java.
lang. Object - com.
azure. resourcemanager. alertsmanagement. models. Essentials
- com.
Implements
public final class Essentials
implements JsonSerializable<Essentials>
This object contains consistent fields across different monitor services.
Constructor Summary
| Constructor | Description |
|---|---|
| Essentials() |
Creates an instance of Essentials class. |
Method Summary
| Modifier and Type | Method and Description |
|---|---|
|
Action |
actionStatus()
Get the action |
| String |
alertRule()
Get the alert |
|
Alert |
alertState()
Get the alert |
| String |
description()
Get the description property: Alert description. |
| static Essentials |
fromJson(JsonReader jsonReader)
Reads an instance of Essentials from the Json |
|
Offset |
lastModifiedDateTime()
Get the last |
| String |
lastModifiedUsername()
Get the last |
|
Monitor |
monitorCondition()
Get the monitor |
|
Offset |
monitorConditionResolvedDateTime()
Get the monitor |
|
Monitor |
monitorService()
Get the monitor |
| Severity |
severity()
Get the severity property: Severity of alert Sev0 being highest and Sev4 being lowest. |
|
Signal |
signalType()
Get the signal |
| String |
smartGroupId()
Get the smart |
| String |
smartGroupingReason()
Get the smart |
| String |
sourceCreatedId()
Get the source |
|
Offset |
startDateTime()
Get the start |
| String |
targetResource()
Get the target |
| String |
targetResourceGroup()
Get the target |
| String |
targetResourceName()
Get the target |
| String |
targetResourceType()
Get the target |
|
Json |
toJson(JsonWriter jsonWriter) |
| void |
validate()
Validates the instance. |
| Essentials |
withActionStatus(ActionStatus actionStatus)
Set the action |
| Essentials |
withDescription(String description)
Set the description property: Alert description. |
| Essentials |
withTargetResource(String targetResource)
Set the target |
| Essentials |
withTargetResourceGroup(String targetResourceGroup)
Set the target |
| Essentials |
withTargetResourceName(String targetResourceName)
Set the target |
| Essentials |
withTargetResourceType(String targetResourceType)
Set the target |
Methods inherited from java.lang.Object
Constructor Details
Essentials
public Essentials()
Creates an instance of Essentials class.
Method Details
actionStatus
public ActionStatus actionStatus()
Get the actionStatus property: Action status.
Returns:
alertRule
public String alertRule()
Get the alertRule property: Rule(monitor) which fired alert instance. Depending on the monitor service, this would be ARM id or name of the rule.
Returns:
alertState
public AlertState alertState()
Get the alertState property: Alert object state, which can be modified by the user.
Returns:
description
public String description()
Get the description property: Alert description.
Returns:
fromJson
public static Essentials fromJson(JsonReader jsonReader)
Reads an instance of Essentials from the JsonReader.
Parameters:
Returns:
Throws:
lastModifiedDateTime
public OffsetDateTime lastModifiedDateTime()
Get the lastModifiedDateTime property: Last modification time(ISO-8601 format) of alert instance.
Returns:
lastModifiedUsername
public String lastModifiedUsername()
Get the lastModifiedUsername property: User who last modified the alert, in case of monitor service updates user would be 'system', otherwise name of the user.
Returns:
monitorCondition
public MonitorCondition monitorCondition()
Get the monitorCondition property: Condition of the rule at the monitor service. It represents whether the underlying conditions have crossed the defined alert rule thresholds.
Returns:
monitorConditionResolvedDateTime
public OffsetDateTime monitorConditionResolvedDateTime()
Get the monitorConditionResolvedDateTime property: Resolved time(ISO-8601 format) of alert instance. This will be updated when monitor service resolves the alert instance because the rule condition is no longer met.
Returns:
monitorService
public MonitorService monitorService()
Get the monitorService property: Monitor service on which the rule(monitor) is set.
Returns:
severity
public Severity severity()
Get the severity property: Severity of alert Sev0 being highest and Sev4 being lowest.
Returns:
signalType
public SignalType signalType()
Get the signalType property: The type of signal the alert is based on, which could be metrics, logs or activity logs.
Returns:
smartGroupId
public String smartGroupId()
Get the smartGroupId property: Unique Id of the smart group.
Returns:
smartGroupingReason
public String smartGroupingReason()
Get the smartGroupingReason property: Verbose reason describing the reason why this alert instance is added to a smart group.
Returns:
sourceCreatedId
public String sourceCreatedId()
Get the sourceCreatedId property: Unique Id created by monitor service for each alert instance. This could be used to track the issue at the monitor service, in case of Nagios, Zabbix, SCOM etc.
Returns:
startDateTime
public OffsetDateTime startDateTime()
Get the startDateTime property: Creation time(ISO-8601 format) of alert instance.
Returns:
targetResource
public String targetResource()
Get the targetResource property: Target ARM resource, on which alert got created.
Returns:
targetResourceGroup
public String targetResourceGroup()
Get the targetResourceGroup property: Resource group of target ARM resource, on which alert got created.
Returns:
targetResourceName
public String targetResourceName()
Get the targetResourceName property: Name of the target ARM resource name, on which alert got created.
Returns:
targetResourceType
public String targetResourceType()
Get the targetResourceType property: Resource type of target ARM resource, on which alert got created.
Returns:
toJson
validate
public void validate()
Validates the instance.
withActionStatus
public Essentials withActionStatus(ActionStatus actionStatus)
Set the actionStatus property: Action status.
Parameters:
Returns:
withDescription
public Essentials withDescription(String description)
Set the description property: Alert description.
Parameters:
Returns:
withTargetResource
public Essentials withTargetResource(String targetResource)
Set the targetResource property: Target ARM resource, on which alert got created.
Parameters:
Returns:
withTargetResourceGroup
public Essentials withTargetResourceGroup(String targetResourceGroup)
Set the targetResourceGroup property: Resource group of target ARM resource, on which alert got created.
Parameters:
Returns:
withTargetResourceName
public Essentials withTargetResourceName(String targetResourceName)
Set the targetResourceName property: Name of the target ARM resource name, on which alert got created.
Parameters:
Returns:
withTargetResourceType
public Essentials withTargetResourceType(String targetResourceType)
Set the targetResourceType property: Resource type of target ARM resource, on which alert got created.
Parameters:
Returns: