@Generated(value="OracleSDKGenerator", comments="API Version: 20180401") public final class UpdateAlarmDetails extends Object
The configuration details for updating an alarm.
Warning:* Oracle recommends that you avoid using any confidential information when you supply string values using the API.
Note: Objects should always be created or deserialized using the UpdateAlarmDetails.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 UpdateAlarmDetails.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 |
UpdateAlarmDetails.Builder |
Constructor and Description |
---|
UpdateAlarmDetails(String displayName,
String compartmentId,
String metricCompartmentId,
Boolean metricCompartmentIdInSubtree,
String namespace,
String query,
String resolution,
String pendingDuration,
Alarm.Severity severity,
String body,
List<String> destinations,
String repeatNotificationDuration,
Suppression suppression,
Boolean isEnabled,
Map<String,String> freeformTags,
Map<String,Map<String,Object>> definedTags)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
static UpdateAlarmDetails.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
Set<String> |
get__explicitlySet__() |
String |
getBody()
The human-readable content of the notification delivered.
|
String |
getCompartmentId()
The OCID of the compartment containing the alarm.
|
Map<String,Map<String,Object>> |
getDefinedTags()
Usage of predefined tag keys.
|
List<String> |
getDestinations()
An array of OCIDs 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.
|
Boolean |
getIsEnabled()
Whether the alarm is enabled.
|
String |
getMetricCompartmentId()
The OCID of the compartment containing the metric being evaluated by the alarm.
|
Boolean |
getMetricCompartmentIdInSubtree()
When true, the alarm evaluates metrics from all compartments and subcompartments.
|
String |
getNamespace()
The source service or application emitting the metric that is evaluated by the alarm.
|
String |
getPendingDuration()
The period of time that the condition defined in the alarm must persist before the alarm state changes from "OK" to "FIRING" or vice versa.
|
String |
getQuery()
The Monitoring Query Language (MQL) expression to evaluate for the alarm.
|
String |
getRepeatNotificationDuration()
The frequency at which notifications are re-submitted, if the alarm keeps firing without interruption.
|
String |
getResolution()
The time between calculated aggregation windows for the alarm.
|
Alarm.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() |
String |
toString() |
@ConstructorProperties(value={"displayName","compartmentId","metricCompartmentId","metricCompartmentIdInSubtree","namespace","query","resolution","pendingDuration","severity","body","destinations","repeatNotificationDuration","suppression","isEnabled","freeformTags","definedTags"}) @Deprecated public UpdateAlarmDetails(String displayName, String compartmentId, String metricCompartmentId, Boolean metricCompartmentIdInSubtree, String namespace, String query, String resolution, String pendingDuration, Alarm.Severity severity, String body, List<String> destinations, String repeatNotificationDuration, Suppression suppression, Boolean isEnabled, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags)
public static UpdateAlarmDetails.Builder builder()
Create a new builder.
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 Boolean getMetricCompartmentIdInSubtree()
When true, the alarm evaluates metrics from all compartments and subcompartments. The parameter can only be set to true when metricCompartmentId is the tenancy OCID (the tenancy is the root compartment). A true value requires the user to have tenancy-level permissions. If this requirement is not met, then the call is rejected. When false, the alarm evaluates metrics from only the compartment specified in metricCompartmentId. Default is false.
Example: true
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 String getResolution()
The time between calculated aggregation windows for the alarm. Supported value: 1m
public String getPendingDuration()
The period of time that the condition defined in the alarm must persist before the alarm state changes from "OK" to "FIRING" or vice versa. For example, a value of 5 minutes means that the alarm must persist in breaching the condition for five minutes before the alarm updates its state to "FIRING"; likewise, the alarm must persist in not breaching the condition for five minutes before the alarm updates its state to "OK."
The duration is specified as a string in ISO 8601 format (PT10M
for ten minutes or PT1H
for one hour). Minimum: PT1M. Maximum: PT1H. Default: PT1M.
Under the default value of PT1M, the first evaluation that breaches the alarm updates the state to "FIRING" and the first evaluation that does not breach the alarm updates the state to "OK".
Example: PT5M
public Alarm.Severity getSeverity()
The perceived severity of the alarm with regard to the affected system.
Example: CRITICAL
public String getBody()
The human-readable content of the notification delivered. Oracle recommends providing guidance to operators for resolving the alarm condition. Consider adding links to standard runbook practices. Avoid entering confidential information.
Example: High CPU usage alert. Follow runbook instructions for resolution.
public List<String> getDestinations()
An array of OCIDs to which the notifications for this alarm will be delivered. An example destination is an OCID for a topic managed by the Oracle Cloud Infrastructure Notification service.
public String getRepeatNotificationDuration()
The frequency at which notifications are re-submitted, if the alarm keeps firing without interruption. Format defined by ISO 8601. For example, PT4H
indicates four hours. Minimum: PT1M. Maximum: P30D.
Default value: null (notifications are not re-submitted).
Example: PT2H
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\"}}
Copyright © 2016–2019. All rights reserved.