CreateOccMetricAlarmDetails¶

class oci.demand_signal.models.CreateOccMetricAlarmDetails(**kwargs)¶

Bases: object

Payload for creating an OccMetricAlarm.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a CreateOccMetricAlarmDetails.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a CreateOccMetricAlarmDetails.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a CreateOccMetricAlarmDetails.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a CreateOccMetricAlarmDetails.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a CreateOccMetricAlarmDetails.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a CreateOccMetricAlarmDetails.
`THRESHOLD_TYPE_PERCENTAGE`	A constant which can be used with the threshold_type property of a CreateOccMetricAlarmDetails.
`THRESHOLD_TYPE_UNITS`	A constant which can be used with the threshold_type property of a CreateOccMetricAlarmDetails.
`compartment_id`	[Required] Gets the compartment_id of this CreateOccMetricAlarmDetails.
`defined_tags`	Gets the defined_tags of this CreateOccMetricAlarmDetails.
`description`	Gets the description of this CreateOccMetricAlarmDetails.
`display_name`	[Required] Gets the display_name of this CreateOccMetricAlarmDetails.
`freeform_tags`	Gets the freeform_tags of this CreateOccMetricAlarmDetails.
`frequency`	[Required] Gets the frequency of this CreateOccMetricAlarmDetails.
`is_active`	[Required] Gets the is_active of this CreateOccMetricAlarmDetails.
`lifecycle_state`	Gets the lifecycle_state of this CreateOccMetricAlarmDetails.
`resource_configuration`	[Required] Gets the resource_configuration of this CreateOccMetricAlarmDetails.
`subscribers`	Gets the subscribers of this CreateOccMetricAlarmDetails.
`threshold`	[Required] Gets the threshold of this CreateOccMetricAlarmDetails.
`threshold_type`	Gets the threshold_type of this CreateOccMetricAlarmDetails.

Methods

__init__(**kwargs) Initializes a new CreateOccMetricAlarmDetails object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a CreateOccMetricAlarmDetails. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a CreateOccMetricAlarmDetails. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a CreateOccMetricAlarmDetails. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a CreateOccMetricAlarmDetails. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a CreateOccMetricAlarmDetails. This constant has a value of “FAILED”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a CreateOccMetricAlarmDetails. This constant has a value of “UPDATING”

THRESHOLD_TYPE_PERCENTAGE = 'PERCENTAGE'¶: A constant which can be used with the threshold_type property of a CreateOccMetricAlarmDetails. This constant has a value of “PERCENTAGE”

THRESHOLD_TYPE_UNITS = 'UNITS'¶: A constant which can be used with the threshold_type property of a CreateOccMetricAlarmDetails. This constant has a value of “UNITS”

__init__(**kwargs)¶

Initializes a new CreateOccMetricAlarmDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

display_name (str) – The value to assign to the display_name property of this CreateOccMetricAlarmDetails.
description (str) – The value to assign to the description property of this CreateOccMetricAlarmDetails.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this CreateOccMetricAlarmDetails. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”
compartment_id (str) – The value to assign to the compartment_id property of this CreateOccMetricAlarmDetails.
is_active (bool) – The value to assign to the is_active property of this CreateOccMetricAlarmDetails.
subscribers (list[str]) – The value to assign to the subscribers property of this CreateOccMetricAlarmDetails.
frequency (str) – The value to assign to the frequency property of this CreateOccMetricAlarmDetails.
threshold (int) – The value to assign to the threshold property of this CreateOccMetricAlarmDetails.
threshold_type (str) – The value to assign to the threshold_type property of this CreateOccMetricAlarmDetails. Allowed values for this property are: “PERCENTAGE”, “UNITS”
resource_configuration (oci.demand_signal.models.BaseResourceConfiguration) – The value to assign to the resource_configuration property of this CreateOccMetricAlarmDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateOccMetricAlarmDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateOccMetricAlarmDetails.

compartment_id¶

[Required] Gets the compartment_id of this CreateOccMetricAlarmDetails. Compartment OCID in which the alarm is created.

Returns:	The compartment_id of this CreateOccMetricAlarmDetails.
Return type:	str

defined_tags¶

Gets the defined_tags of this CreateOccMetricAlarmDetails. 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 defined_tags of this CreateOccMetricAlarmDetails.
Return type:	dict(str, dict(str, object))

description¶

Gets the description of this CreateOccMetricAlarmDetails. Optional description for the alarm.

Returns:	The description of this CreateOccMetricAlarmDetails.
Return type:	str

display_name¶

[Required] Gets the display_name of this CreateOccMetricAlarmDetails. Human-readable name for the alarm.

Returns:	The display_name of this CreateOccMetricAlarmDetails.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this CreateOccMetricAlarmDetails. 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 freeform_tags of this CreateOccMetricAlarmDetails.
Return type:	dict(str, str)

frequency¶

[Required] Gets the frequency of this CreateOccMetricAlarmDetails. Frequency at which notifications should be sent.

Returns:	The frequency of this CreateOccMetricAlarmDetails.
Return type:	str

is_active¶

[Required] Gets the is_active of this CreateOccMetricAlarmDetails. Alarm active status.

Returns:	The is_active of this CreateOccMetricAlarmDetails.
Return type:	bool

lifecycle_state¶

Gets the lifecycle_state of this CreateOccMetricAlarmDetails. The current lifecycle state of the resource.

Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”

Returns:	The lifecycle_state of this CreateOccMetricAlarmDetails.
Return type:	str

resource_configuration¶

[Required] Gets the resource_configuration of this CreateOccMetricAlarmDetails.

Returns:	The resource_configuration of this CreateOccMetricAlarmDetails.
Return type:	oci.demand_signal.models.BaseResourceConfiguration

subscribers¶

Gets the subscribers of this CreateOccMetricAlarmDetails. List of topic OCIDs for notifications.

Returns:	The subscribers of this CreateOccMetricAlarmDetails.
Return type:	list[str]

threshold¶

[Required] Gets the threshold of this CreateOccMetricAlarmDetails. Threshold at which alarm must be triggered.

Returns:	The threshold of this CreateOccMetricAlarmDetails.
Return type:	int

threshold_type¶

Gets the threshold_type of this CreateOccMetricAlarmDetails. Units in which threshold is being stored.

Allowed values for this property are: “PERCENTAGE”, “UNITS”

Returns:	The threshold_type of this CreateOccMetricAlarmDetails.
Return type:	str