Package com.oracle.bmc.budget.model

Class CreateAlertRuleDetails

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20190111")
public final class CreateAlertRuleDetails
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    The create alert rule details.

    This is a batch-create.
    Note: Objects should always be created or deserialized using the CreateAlertRuleDetails.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 CreateAlertRuleDetails.Builder, which maintain a set of all explicitly set fields called CreateAlertRuleDetails.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).

    • Method Detail

      • getDisplayName

        public String getDisplayName()
        The name of the alert rule.

        Avoid entering confidential information.

        Returns:
        the value

      • getDescription

        public String getDescription()
        The description of the alert rule.
        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, expressed as a whole number or decimal value.

        If the thresholdType is ABSOLUTE, the threshold can have at most 12 digits before the decimal point, and up to two digits after the decimal point. If the thresholdType is PERCENTAGE, the maximum value is 10000 and can have up to two digits after the decimal point.

        Returns:
        the value

      • getThresholdType

        public ThresholdType getThresholdType()
        The type of threshold.
        Returns:
        the value

      • getRecipients

        public String getRecipients()
        The audience that receives the alert when it triggers.

        An empty string is interpreted as null.

        Returns:
        the value

      • getMessage

        public String getMessage()
        The message to be sent to the recipients when the alert rule is triggered.
        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