Show / Hide Table of Contents

Class OccMetricAlarm

OccMetricAlarm represents an alarm configuration for OCI Control Center metric.

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

Properties

CompartmentId

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

Compartment OCID in which the alarm is created.

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

Optional description for the alarm.

DisplayName

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

Human-readable name for the alarm.

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

Frequency

Declaration
[Required(ErrorMessage = "Frequency is required.")]
[JsonProperty(PropertyName = "frequency")]
[JsonConverter(typeof(ResponseEnumConverter))]
public OccMetricAlarm.FrequencyEnum? Frequency { get; set; }
Property Value
Type Description
OccMetricAlarm.FrequencyEnum?

Frequency at which notifications should be sent.

Remarks

Required

Id

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

Unique OCID for this alarm configuration.

Remarks

Required

IsActive

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

Alarm active status.

Remarks

Required

LifecycleState

Declaration
[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public OccMetricAlarm.LifecycleStateEnum? LifecycleState { get; set; }
Property Value
Type Description
OccMetricAlarm.LifecycleStateEnum?

The current lifecycle state of the resource.

Remarks

Required

ResourceConfiguration

Declaration
[Required(ErrorMessage = "ResourceConfiguration is required.")]
[JsonProperty(PropertyName = "resourceConfiguration")]
public BaseResourceConfiguration ResourceConfiguration { get; set; }
Property Value
Type Description
BaseResourceConfiguration
Remarks

Required

Subscribers

Declaration
[Required(ErrorMessage = "Subscribers is required.")]
[JsonProperty(PropertyName = "subscribers")]
public List<string> Subscribers { get; set; }
Property Value
Type Description
List<string>

List of topic OCIDs for notifications.

Remarks

Required

SystemTags

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

System tags for this resource. Each key is predefined and scoped to a namespace.
Example: {"orcl-cloud": {"free-tier-retained": "true"}}

Threshold

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

Threshold at which alarm must be triggered.

Remarks

Required

ThresholdType

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

Units in which threshold is being stored.

Remarks

Required

TimeCreated

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

Creation timestamp (RFC 3339).

Remarks

Required

TimeUpdated

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

Last update timestamp (RFC 3339).

Remarks

Required

In this article
Back to top