Show / Hide Table of Contents

Class CreateAlertRuleDetails

The create alert rule details. This is a batch-create.

Inheritance
object
CreateAlertRuleDetails
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Oci.BudgetService.Models
Assembly: OCI.DotNetSDK.Budget.dll
Syntax
public class CreateAlertRuleDetails

Properties

DefinedTags

Declaration
[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }
Property Value
Type Description
Dictionary<string, Dictionary<string, object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
Example: {"Operations": {"CostCenter": "42"}}

Description

Declaration
[JsonProperty(PropertyName = "description")]
public string Description { get; set; }
Property Value
Type Description
string

The description of the alert rule.

DisplayName

Declaration
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }
Property Value
Type Description
string

The name of the alert rule. Avoid entering confidential information.

FreeformTags

Declaration
[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }
Property Value
Type Description
Dictionary<string, string>

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

Message

Declaration
[JsonProperty(PropertyName = "message")]
public string Message { get; set; }
Property Value
Type Description
string

The message to be sent to the recipients when the alert rule is triggered.

Recipients

Declaration
[JsonProperty(PropertyName = "recipients")]
public string Recipients { get; set; }
Property Value
Type Description
string

The audience that receives the alert when it triggers. An empty string is interpreted as null.

Threshold

Declaration
[Required(ErrorMessage = "Threshold is required.")]
[JsonProperty(PropertyName = "threshold")]
public decimal? Threshold { get; set; }
Property Value
Type Description
decimal?

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.

Remarks

Required

ThresholdType

Declaration
[Required(ErrorMessage = "ThresholdType is required.")]
[JsonProperty(PropertyName = "thresholdType")]
[JsonConverter(typeof(StringEnumConverter))]
public ThresholdType? ThresholdType { get; set; }
Property Value
Type Description
ThresholdType?

The type of threshold.

Remarks

Required

Type

Declaration
[Required(ErrorMessage = "Type is required.")]
[JsonProperty(PropertyName = "type")]
[JsonConverter(typeof(StringEnumConverter))]
public AlertType? Type { get; set; }
Property Value
Type Description
AlertType?

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

Remarks

Required

In this article
Back to top