@Generated(value="OracleSDKGenerator", comments="API Version: 20180401") public final class AlarmSummary extends Object
A summary of properties for the specified alarm. For information about alarms, see Alarms Overview.
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see [Getting Started with Policies](https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).
For information about endpoints and signing API requests, see
[About the API](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm). For information about available SDKs and tools, see
[SDKS and Other Tools](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/sdks.htm).
Note: Objects should always be created or deserialized using the AlarmSummary.Builder. This model distinguishes fields
that are null because they are unset from fields that are explicitly set to null. This is done in
the setter methods of the AlarmSummary.Builder, which maintain a set of all explicitly set fields called
__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take
__explicitlySet__ into account. The constructor, on the other hand, does not set __explicitlySet__
(since the constructor cannot distinguish explicit null from unset null).
| Modifier and Type | Class and Description |
|---|---|
static class |
AlarmSummary.Builder |
static class |
AlarmSummary.Severity
The perceived severity of the alarm with regard to the affected system.
|
| Constructor and Description |
|---|
AlarmSummary(String id,
String displayName,
String compartmentId,
String metricCompartmentId,
String namespace,
String query,
AlarmSummary.Severity severity,
List<String> destinations,
Suppression suppression,
Boolean isEnabled,
Map<String,String> freeformTags,
Map<String,Map<String,Object>> definedTags,
Alarm.LifecycleState lifecycleState)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static AlarmSummary.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
Set<String> |
get__explicitlySet__() |
String |
getCompartmentId()
The OCID of the compartment containing the alarm.
|
Map<String,Map<String,Object>> |
getDefinedTags()
Usage of predefined tag keys.
|
List<String> |
getDestinations()
A list of destinations to which the notifications for this alarm will be delivered.
|
String |
getDisplayName()
A user-friendly name for the alarm.
|
Map<String,String> |
getFreeformTags()
Simple key-value pair that is applied without any predefined name, type or scope.
|
String |
getId()
The OCID of the alarm.
|
Boolean |
getIsEnabled()
Whether the alarm is enabled.
|
Alarm.LifecycleState |
getLifecycleState()
The current lifecycle state of the alarm.
|
String |
getMetricCompartmentId()
The OCID of the compartment containing the metric
being evaluated by the alarm.
|
String |
getNamespace()
The source service or application emitting the metric that is evaluated by the alarm.
|
String |
getQuery()
The Monitoring Query Language (MQL) expression to evaluate for the alarm.
|
AlarmSummary.Severity |
getSeverity()
The perceived severity of the alarm with regard to the affected system.
|
Suppression |
getSuppression()
The configuration details for suppressing an alarm.
|
int |
hashCode() |
AlarmSummary.Builder |
toBuilder() |
String |
toString() |
@ConstructorProperties(value={"id","displayName","compartmentId","metricCompartmentId","namespace","query","severity","destinations","suppression","isEnabled","freeformTags","definedTags","lifecycleState"}) @Deprecated public AlarmSummary(String id, String displayName, String compartmentId, String metricCompartmentId, String namespace, String query, AlarmSummary.Severity severity, List<String> destinations, Suppression suppression, Boolean isEnabled, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, Alarm.LifecycleState lifecycleState)
public static AlarmSummary.Builder builder()
Create a new builder.
public AlarmSummary.Builder toBuilder()
public String getDisplayName()
A user-friendly name for the alarm. It does not have to be unique, and it’s changeable. Avoid entering confidential information.
This name is sent as the title for notifications related to this alarm.
Example: `High CPU Utilization`
public String getMetricCompartmentId()
The OCID of the compartment containing the metric being evaluated by the alarm.
public String getNamespace()
The source service or application emitting the metric that is evaluated by the alarm.
Example: `oci_computeagent`
public String getQuery()
The Monitoring Query Language (MQL) expression to evaluate for the alarm. The Alarms feature of
the Monitoring service interprets results for each returned time series as Boolean values,
where zero represents false and a non-zero value represents true. A true value means that the trigger
rule condition has been met. The query must specify a metric, statistic, interval, and trigger
rule (threshold or absence). Supported values for interval: 1m-60m (also 1h). You can optionally
specify dimensions and grouping functions. Supported grouping functions: grouping(), groupBy().
For details about Monitoring Query Language (MQL), see Monitoring Query Language (MQL) Reference.
For available dimensions, review the metric definition for the supported service.
See Supported Services.
Example of threshold alarm:
-----
CpuUtilization[1m]{availabilityDomain=\"cumS:PHX-AD-1\"}.groupBy(availabilityDomain).percentile(0.9) > 85
-----
Example of absence alarm:
-----
CpuUtilization[1m]{availabilityDomain=\"cumS:PHX-AD-1\"}.absent()
-----
public AlarmSummary.Severity getSeverity()
The perceived severity of the alarm with regard to the affected system.
Example: `CRITICAL`
public List<String> getDestinations()
A list of destinations to which the notifications for this alarm will be delivered. Each destination is represented by an OCID related to the supported destination service. For example, a destination using the Notifications service is represented by a topic OCID. Supported destination services: Notifications Service. Limit: One destination per supported destination service.
public Suppression getSuppression()
The configuration details for suppressing an alarm.
public Boolean getIsEnabled()
Whether the alarm is enabled.
Example: `true`
public Map<String,String> getFreeformTags()
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: {\"Department\": \"Finance\"}
public Map<String,Map<String,Object>> getDefinedTags()
Usage of predefined tag keys. These predefined keys are scoped to namespaces.
Example: {\"Operations\": {\"CostCenter\": \"42\"}}
public Alarm.LifecycleState getLifecycleState()
The current lifecycle state of the alarm.
Example: `DELETED`
Copyright © 2016–2021. All rights reserved.