@Generated(value="OracleSDKGenerator", comments="API Version: 20190111") public final class AlertRule extends Object
The alert rule.
Note: Objects should always be created or deserialized using the AlertRule.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 AlertRule.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 |
AlertRule.Builder |
Constructor and Description |
---|
AlertRule(String id,
String budgetId,
String displayName,
AlertType type,
BigDecimal threshold,
ThresholdType thresholdType,
LifecycleState lifecycleState,
String message,
String description,
Integer version,
String recipients,
Date timeCreated,
Date timeUpdated,
Map<String,String> freeformTags,
Map<String,Map<String,Object>> definedTags)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
static AlertRule.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
Set<String> |
get__explicitlySet__() |
String |
getBudgetId()
The OCID of the budget.
|
Map<String,Map<String,Object>> |
getDefinedTags()
Defined tags for this resource.
|
String |
getDescription()
The description of the alert rule.
|
String |
getDisplayName()
The name of the alert rule.
|
Map<String,String> |
getFreeformTags()
Free-form tags for this resource.
|
String |
getId()
The OCID of the alert rule.
|
LifecycleState |
getLifecycleState()
The current state of the alert rule.
|
String |
getMessage()
Custom message sent when an alert is triggered.
|
String |
getRecipients()
The delimited list of email addresses to receive the alert when it triggers.
|
BigDecimal |
getThreshold()
The threshold for triggering the alert.
|
ThresholdType |
getThresholdType()
The type of threshold.
|
Date |
getTimeCreated()
The time the budget was created.
|
Date |
getTimeUpdated()
The time the budget was updated.
|
AlertType |
getType()
The type of the alert.
|
Integer |
getVersion()
The version of the alert rule.
|
int |
hashCode() |
AlertRule.Builder |
toBuilder() |
String |
toString() |
@Deprecated @ConstructorProperties(value={"id","budgetId","displayName","type","threshold","thresholdType","lifecycleState","message","description","version","recipients","timeCreated","timeUpdated","freeformTags","definedTags"}) public AlertRule(String id, String budgetId, String displayName, AlertType type, BigDecimal threshold, ThresholdType thresholdType, LifecycleState lifecycleState, String message, String description, Integer version, String recipients, Date timeCreated, Date timeUpdated, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags)
public static AlertRule.Builder builder()
Create a new builder.
public AlertRule.Builder toBuilder()
public String getId()
The OCID of the alert rule.
public String getBudgetId()
The OCID of the budget.
public String getDisplayName()
The name of the alert rule. Avoid entering confidential information.
public AlertType getType()
The type of the alert. Valid values are ACTUAL (the alert triggers based on actual usage), or FORECAST (the alert triggers based on predicted usage).
public BigDecimal getThreshold()
The threshold for triggering the alert. If the thresholdType is PERCENTAGE, the maximum value is 10000.
public ThresholdType getThresholdType()
The type of threshold.
public LifecycleState getLifecycleState()
The current state of the alert rule.
public String getMessage()
Custom message sent when an alert is triggered.
public String getDescription()
The description of the alert rule.
public Integer getVersion()
The version of the alert rule. Starts from 1 and increments by 1.
public String getRecipients()
The delimited list of email addresses to receive the alert when it triggers. Delimiter characters can be a comma, space, TAB, or semicolon.
public Date getTimeCreated()
The time the budget was created.
public Date getTimeUpdated()
The time the budget was updated.
public Map<String,String> getFreeformTags()
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.
Example: {"Department": "Finance"}
public Map<String,Map<String,Object>> getDefinedTags()
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
Example: {"Operations": {"CostCenter": "42"}}
Copyright © 2016–2022. All rights reserved.