MonitoringTemplate

class oci.stack_monitoring.models.MonitoringTemplate(**kwargs)

Bases: object

Detailed information of the Monitoring Template

Attributes:

LIFECYCLE_STATE_ACTIVE

A constant which can be used with the lifecycle_state property of a MonitoringTemplate.

LIFECYCLE_STATE_CREATING

A constant which can be used with the lifecycle_state property of a MonitoringTemplate.

LIFECYCLE_STATE_DELETED

A constant which can be used with the lifecycle_state property of a MonitoringTemplate.

LIFECYCLE_STATE_INACTIVE

A constant which can be used with the lifecycle_state property of a MonitoringTemplate.

LIFECYCLE_STATE_UPDATING

A constant which can be used with the lifecycle_state property of a MonitoringTemplate.

MESSAGE_FORMAT_ONS_OPTIMIZED

A constant which can be used with the message_format property of a MonitoringTemplate.

MESSAGE_FORMAT_PRETTY_JSON

A constant which can be used with the message_format property of a MonitoringTemplate.

MESSAGE_FORMAT_RAW

A constant which can be used with the message_format property of a MonitoringTemplate.

STATUS_APPLIED

A constant which can be used with the status property of a MonitoringTemplate.

STATUS_NOT_APPLIED

A constant which can be used with the status property of a MonitoringTemplate.

STATUS_PARTIAL_APPLIED

A constant which can be used with the status property of a MonitoringTemplate.

compartment_id

[Required] Gets the compartment_id of this MonitoringTemplate.

defined_tags

Gets the defined_tags of this MonitoringTemplate.

description

Gets the description of this MonitoringTemplate.

destinations

[Required] Gets the destinations of this MonitoringTemplate.

display_name

[Required] Gets the display_name of this MonitoringTemplate.

freeform_tags

Gets the freeform_tags of this MonitoringTemplate.

id

[Required] Gets the id of this MonitoringTemplate.

is_alarms_enabled

Gets the is_alarms_enabled of this MonitoringTemplate.

is_split_notification_enabled

Gets the is_split_notification_enabled of this MonitoringTemplate.

lifecycle_state

[Required] Gets the lifecycle_state of this MonitoringTemplate.

members

[Required] Gets the members of this MonitoringTemplate.

message_format

Gets the message_format of this MonitoringTemplate.

repeat_notification_duration

Gets the repeat_notification_duration of this MonitoringTemplate.

status

[Required] Gets the status of this MonitoringTemplate.

system_tags

Gets the system_tags of this MonitoringTemplate.

tenant_id

[Required] Gets the tenant_id of this MonitoringTemplate.

time_created

[Required] Gets the time_created of this MonitoringTemplate.

time_updated

[Required] Gets the time_updated of this MonitoringTemplate.

total_alarm_conditions

[Required] Gets the total_alarm_conditions of this MonitoringTemplate.

total_applied_alarm_conditions

[Required] Gets the total_applied_alarm_conditions of this MonitoringTemplate.

Methods:

__init__(**kwargs)

Initializes a new MonitoringTemplate object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_state property of a MonitoringTemplate. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'

A constant which can be used with the lifecycle_state property of a MonitoringTemplate. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'

A constant which can be used with the lifecycle_state property of a MonitoringTemplate. This constant has a value of “DELETED”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'

A constant which can be used with the lifecycle_state property of a MonitoringTemplate. This constant has a value of “INACTIVE”

LIFECYCLE_STATE_UPDATING = 'UPDATING'

A constant which can be used with the lifecycle_state property of a MonitoringTemplate. This constant has a value of “UPDATING”

MESSAGE_FORMAT_ONS_OPTIMIZED = 'ONS_OPTIMIZED'

A constant which can be used with the message_format property of a MonitoringTemplate. This constant has a value of “ONS_OPTIMIZED”

MESSAGE_FORMAT_PRETTY_JSON = 'PRETTY_JSON'

A constant which can be used with the message_format property of a MonitoringTemplate. This constant has a value of “PRETTY_JSON”

MESSAGE_FORMAT_RAW = 'RAW'

A constant which can be used with the message_format property of a MonitoringTemplate. This constant has a value of “RAW”

STATUS_APPLIED = 'APPLIED'

A constant which can be used with the status property of a MonitoringTemplate. This constant has a value of “APPLIED”

STATUS_NOT_APPLIED = 'NOT_APPLIED'

A constant which can be used with the status property of a MonitoringTemplate. This constant has a value of “NOT_APPLIED”

STATUS_PARTIAL_APPLIED = 'PARTIAL_APPLIED'

A constant which can be used with the status property of a MonitoringTemplate. This constant has a value of “PARTIAL_APPLIED”

__init__(**kwargs)

Initializes a new MonitoringTemplate 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 MonitoringTemplate.

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

  • tenant_id (str) – The value to assign to the tenant_id property of this MonitoringTemplate.

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

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

  • status (str) – The value to assign to the status property of this MonitoringTemplate. Allowed values for this property are: “NOT_APPLIED”, “APPLIED”, “PARTIAL_APPLIED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this MonitoringTemplate. Allowed values for this property are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

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

  • is_alarms_enabled (bool) – The value to assign to the is_alarms_enabled property of this MonitoringTemplate.

  • is_split_notification_enabled (bool) – The value to assign to the is_split_notification_enabled property of this MonitoringTemplate.

  • members (list[oci.stack_monitoring.models.MemberReference]) – The value to assign to the members property of this MonitoringTemplate.

  • repeat_notification_duration (str) – The value to assign to the repeat_notification_duration property of this MonitoringTemplate.

  • message_format (str) – The value to assign to the message_format property of this MonitoringTemplate. Allowed values for this property are: “RAW”, “PRETTY_JSON”, “ONS_OPTIMIZED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • total_alarm_conditions (float) – The value to assign to the total_alarm_conditions property of this MonitoringTemplate.

  • total_applied_alarm_conditions (float) – The value to assign to the total_applied_alarm_conditions property of this MonitoringTemplate.

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

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

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

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

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

property compartment_id

[Required] Gets the compartment_id of this MonitoringTemplate. The OCID of the compartment containing the monitoringTemplate.

Returns

The compartment_id of this MonitoringTemplate.

Return type

str

property defined_tags

Gets the defined_tags of this MonitoringTemplate. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns

The defined_tags of this MonitoringTemplate.

Return type

dict(str, dict(str, object))

property description

Gets the description of this MonitoringTemplate. A user-friendly description for the monitoring template. It does not have to be unique, and it’s changeable. Avoid entering confidential information.

Returns

The description of this MonitoringTemplate.

Return type

str

property destinations

[Required] Gets the destinations of this MonitoringTemplate. A list of destinations for alarm notifications. Each destination is represented by the OCID of a related resource.

Returns

The destinations of this MonitoringTemplate.

Return type

list[str]

property display_name

[Required] Gets the display_name of this MonitoringTemplate. A user-friendly name for the monitoring template. It should be unique, and it’s mutable in nature. Avoid entering confidential information.

Returns

The display_name of this MonitoringTemplate.

Return type

str

property freeform_tags

Gets the freeform_tags of this MonitoringTemplate. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}

Returns

The freeform_tags of this MonitoringTemplate.

Return type

dict(str, str)

property id

[Required] Gets the id of this MonitoringTemplate. The OCID of the monitoringTemplate

Returns

The id of this MonitoringTemplate.

Return type

str

property is_alarms_enabled

Gets the is_alarms_enabled of this MonitoringTemplate. Whether the alarm is enabled or disabled. Default value is enabled.

Returns

The is_alarms_enabled of this MonitoringTemplate.

Return type

bool

property is_split_notification_enabled

Gets the is_split_notification_enabled of this MonitoringTemplate. Whether the alarm notification is enabled or disabled, it will be Enabled by default.

Returns

The is_split_notification_enabled of this MonitoringTemplate.

Return type

bool

property lifecycle_state

[Required] Gets the lifecycle_state of this MonitoringTemplate. The current lifecycle state of the monitoring template.

Allowed values for this property are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The lifecycle_state of this MonitoringTemplate.

Return type

str

property members

[Required] Gets the members of this MonitoringTemplate. List of members of this monitoring template.

Returns

The members of this MonitoringTemplate.

Return type

list[oci.stack_monitoring.models.MemberReference]

property message_format

Gets the message_format of this MonitoringTemplate. The format to use for alarm notifications.

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

Returns

The message_format of this MonitoringTemplate.

Return type

str

property repeat_notification_duration

Gets the repeat_notification_duration of this MonitoringTemplate. The frequency for re-submitting alarm notifications, if the alarm keeps firing without interruption. Format defined by ISO 8601. For example, PT4H indicates four hours. Minimum- PT1M. Maximum - P30D.

Returns

The repeat_notification_duration of this MonitoringTemplate.

Return type

str

property status

[Required] Gets the status of this MonitoringTemplate. The current status of the monitoring template i.e. whether it is Applied or NotApplied.

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

Returns

The status of this MonitoringTemplate.

Return type

str

property system_tags

Gets the system_tags of this MonitoringTemplate. Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns

The system_tags of this MonitoringTemplate.

Return type

dict(str, dict(str, object))

property tenant_id

[Required] Gets the tenant_id of this MonitoringTemplate. Tenant Identifier OCID

Returns

The tenant_id of this MonitoringTemplate.

Return type

str

property time_created

[Required] Gets the time_created of this MonitoringTemplate. The date and time the monitoringTemplate was created. Format defined by RFC3339.

Returns

The time_created of this MonitoringTemplate.

Return type

datetime

property time_updated

[Required] Gets the time_updated of this MonitoringTemplate. The date and time the monitoringTemplate was last updated. Format defined by RFC3339.

Returns

The time_updated of this MonitoringTemplate.

Return type

datetime

property total_alarm_conditions

[Required] Gets the total_alarm_conditions of this MonitoringTemplate. Total Alarm Conditions

Returns

The total_alarm_conditions of this MonitoringTemplate.

Return type

float

property total_applied_alarm_conditions

[Required] Gets the total_applied_alarm_conditions of this MonitoringTemplate. Total Applied Alarm Conditions

Returns

The total_applied_alarm_conditions of this MonitoringTemplate.

Return type

float