OccMetricAlarmSummary

class oci.demand_signal.models.OccMetricAlarmSummary(**kwargs)

Bases: object

Summary of OccMetricAlarm.

Attributes:

THRESHOLD_TYPE_PERCENTAGE

A constant which can be used with the threshold_type property of a OccMetricAlarmSummary.

THRESHOLD_TYPE_UNITS

A constant which can be used with the threshold_type property of a OccMetricAlarmSummary.

compartment_id

[Required] Gets the compartment_id of this OccMetricAlarmSummary.

defined_tags

Gets the defined_tags of this OccMetricAlarmSummary.

description

Gets the description of this OccMetricAlarmSummary.

display_name

[Required] Gets the display_name of this OccMetricAlarmSummary.

freeform_tags

Gets the freeform_tags of this OccMetricAlarmSummary.

frequency

[Required] Gets the frequency of this OccMetricAlarmSummary.

id

[Required] Gets the id of this OccMetricAlarmSummary.

is_active

[Required] Gets the is_active of this OccMetricAlarmSummary.

lifecycle_state

[Required] Gets the lifecycle_state of this OccMetricAlarmSummary.

resource_configuration

[Required] Gets the resource_configuration of this OccMetricAlarmSummary.

subscribers

[Required] Gets the subscribers of this OccMetricAlarmSummary.

system_tags

Gets the system_tags of this OccMetricAlarmSummary.

threshold

[Required] Gets the threshold of this OccMetricAlarmSummary.

threshold_type

Gets the threshold_type of this OccMetricAlarmSummary.

time_created

[Required] Gets the time_created of this OccMetricAlarmSummary.

time_updated

[Required] Gets the time_updated of this OccMetricAlarmSummary.

Methods:

__init__(**kwargs)

Initializes a new OccMetricAlarmSummary object with values from keyword arguments.

THRESHOLD_TYPE_PERCENTAGE = 'PERCENTAGE'

A constant which can be used with the threshold_type property of a OccMetricAlarmSummary. This constant has a value of “PERCENTAGE”

THRESHOLD_TYPE_UNITS = 'UNITS'

A constant which can be used with the threshold_type property of a OccMetricAlarmSummary. This constant has a value of “UNITS”

__init__(**kwargs)

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

Parameters
  • id (str) – The value to assign to the id property of this OccMetricAlarmSummary.

  • display_name (str) – The value to assign to the display_name property of this OccMetricAlarmSummary.

  • description (str) – The value to assign to the description property of this OccMetricAlarmSummary.

  • time_created (datetime) – The value to assign to the time_created property of this OccMetricAlarmSummary.

  • time_updated (datetime) – The value to assign to the time_updated property of this OccMetricAlarmSummary.

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this OccMetricAlarmSummary.

  • compartment_id (str) – The value to assign to the compartment_id property of this OccMetricAlarmSummary.

  • is_active (bool) – The value to assign to the is_active property of this OccMetricAlarmSummary.

  • subscribers (list[str]) – The value to assign to the subscribers property of this OccMetricAlarmSummary.

  • frequency (str) – The value to assign to the frequency property of this OccMetricAlarmSummary.

  • threshold (int) – The value to assign to the threshold property of this OccMetricAlarmSummary.

  • threshold_type (str) – The value to assign to the threshold_type property of this OccMetricAlarmSummary. Allowed values for this property are: “PERCENTAGE”, “UNITS”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • resource_configuration (oci.demand_signal.models.BaseResourceConfiguration) – The value to assign to the resource_configuration property of this OccMetricAlarmSummary.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this OccMetricAlarmSummary.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this OccMetricAlarmSummary.

  • system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this OccMetricAlarmSummary.

property compartment_id

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

Returns

The compartment_id of this OccMetricAlarmSummary.

Return type

str

property defined_tags

Gets the defined_tags of this OccMetricAlarmSummary. 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 OccMetricAlarmSummary.

Return type

dict(str, dict(str, object))

property description

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

Returns

The description of this OccMetricAlarmSummary.

Return type

str

property display_name

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

Returns

The display_name of this OccMetricAlarmSummary.

Return type

str

property freeform_tags

Gets the freeform_tags of this OccMetricAlarmSummary. 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 OccMetricAlarmSummary.

Return type

dict(str, str)

property frequency

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

Returns

The frequency of this OccMetricAlarmSummary.

Return type

str

property id

[Required] Gets the id of this OccMetricAlarmSummary. Unique OCID for this alarm configuration.

Returns

The id of this OccMetricAlarmSummary.

Return type

str

property is_active

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

Returns

The is_active of this OccMetricAlarmSummary.

Return type

bool

property lifecycle_state

[Required] Gets the lifecycle_state of this OccMetricAlarmSummary. The current lifecycle state of the resource.

Returns

The lifecycle_state of this OccMetricAlarmSummary.

Return type

str

property resource_configuration

[Required] Gets the resource_configuration of this OccMetricAlarmSummary.

Returns

The resource_configuration of this OccMetricAlarmSummary.

Return type

oci.demand_signal.models.BaseResourceConfiguration

property subscribers

[Required] Gets the subscribers of this OccMetricAlarmSummary. List of topic OCIDs for notifications.

Returns

The subscribers of this OccMetricAlarmSummary.

Return type

list[str]

property system_tags

Gets the system_tags of this OccMetricAlarmSummary. System tags for this resource. Each key is predefined and scoped to a namespace.

Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns

The system_tags of this OccMetricAlarmSummary.

Return type

dict(str, dict(str, object))

property threshold

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

Returns

The threshold of this OccMetricAlarmSummary.

Return type

int

property threshold_type

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

Allowed values for this property are: “PERCENTAGE”, “UNITS”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The threshold_type of this OccMetricAlarmSummary.

Return type

str

property time_created

[Required] Gets the time_created of this OccMetricAlarmSummary. Creation timestamp (RFC 3339).

Returns

The time_created of this OccMetricAlarmSummary.

Return type

datetime

property time_updated

[Required] Gets the time_updated of this OccMetricAlarmSummary. Last update timestamp (RFC 3339).

Returns

The time_updated of this OccMetricAlarmSummary.

Return type

datetime