Class AlertRuleSummary

The alert rule.

Inheritance

object

AlertRuleSummary

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 AlertRuleSummary

Properties

BudgetId

Declaration

[Required(ErrorMessage = "BudgetId is required.")]
[JsonProperty(PropertyName = "budgetId")]
public string BudgetId { get; set; }

Property Value

Type	Description
string	The OCID of the budget.

Remarks

Required

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

[Required(ErrorMessage = "DisplayName is required.")]
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }

Property Value

Type	Description
string	The name of the alert rule. Avoid entering confidential information.

Remarks

Required

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

Id

Declaration

[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }

Property Value

Type	Description
string	The OCID of the alert rule.

Remarks

Required

LifecycleState

Declaration

[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public LifecycleState? LifecycleState { get; set; }

Property Value

Type	Description
LifecycleState?	The current state of the alert rule.

Remarks

Required

Message

Declaration

[JsonProperty(PropertyName = "message")]
public string Message { get; set; }

Property Value

Type	Description
string	The custom message that will be sent when the alert is triggered.

Recipients

Declaration

[Required(ErrorMessage = "Recipients is required.")]
[JsonProperty(PropertyName = "recipients")]
public string Recipients { get; set; }

Property Value

Type	Description
string	The audience that receives the alert when it triggers.

Remarks

Required

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. If the thresholdType is PERCENTAGE, the maximum value is 10000.

Remarks

Required

ThresholdType

Declaration

[Required(ErrorMessage = "ThresholdType is required.")]
[JsonProperty(PropertyName = "thresholdType")]
[JsonConverter(typeof(ResponseEnumConverter))]
public ThresholdType? ThresholdType { get; set; }

Property Value

Type	Description
ThresholdType?	The type of threshold.

Remarks

Required

TimeCreated

Declaration

[Required(ErrorMessage = "TimeCreated is required.")]
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }

Property Value

Type	Description
DateTime?	The time when the budget was created.

Remarks

Required

TimeUpdated

Declaration

[Required(ErrorMessage = "TimeUpdated is required.")]
[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }

Property Value

Type	Description
DateTime?	The time when the budget was updated.

Remarks

Required

Type

Declaration

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

Property Value

Type	Description
AlertType?	ACTUAL means the alert triggers based on actual usage. FORECAST means the alert triggers based on predicted usage.

Remarks

Required

Version

Declaration

[JsonProperty(PropertyName = "version")]
public int? Version { get; set; }

Property Value

Type	Description
int?	The version of the alert rule. Starts from 1 and increments by 1.