Package com.oracle.bmc.budget.model

Class AlertRule

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.budget.model.AlertRule

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20190111")
public final class AlertRule
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

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 AlertRule.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AlertRule.Builder

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor	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.

Method Summary

Modifier and Type	Method	Description
static AlertRule.Builder	builder()	Create a new builder.
boolean	equals(Object o)
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()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AlertRule

@Deprecated
@ConstructorProperties({"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)

Deprecated.

Method Detail

builder

public static AlertRule.Builder builder()

Create a new builder.

toBuilder

public AlertRule.Builder toBuilder()

getId

public String getId()

The OCID of the alert rule.

Returns:

the value

getBudgetId

public String getBudgetId()

The OCID of the budget.

Returns:

the value

getDisplayName

public String getDisplayName()

The name of the alert rule.

Avoid entering confidential information.

Returns:

the value

getType

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).

Returns:

the value

getThreshold

public BigDecimal getThreshold()

The threshold for triggering the alert.

If the thresholdType is PERCENTAGE, the maximum value is 10000.

Returns:

the value

getThresholdType

public ThresholdType getThresholdType()

The type of threshold.

Returns:

the value

getLifecycleState

public LifecycleState getLifecycleState()

The current state of the alert rule.

Returns:

the value

getMessage

public String getMessage()

Custom message sent when an alert is triggered.

Returns:

the value

getDescription

public String getDescription()

The description of the alert rule.

Returns:

the value

getVersion

public Integer getVersion()

The version of the alert rule.

Starts from 1 and increments by 1.

Returns:

the value

getRecipients

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.

Returns:

the value

getTimeCreated

public Date getTimeCreated()

The time the budget was created.

Returns:

the value

getTimeUpdated

public Date getTimeUpdated()

The time the budget was updated.

Returns:

the value

getFreeformTags

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"}

Returns:

the value

getDefinedTags

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"}}

Returns:

the value

toString

public String toString()

Overrides:

toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel