UpdateMonitoringTemplateDetails

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

Bases: object

The information about updating a monitoring template. The monitoring template displayName should be unique in a compartment.

Attributes:

MESSAGE_FORMAT_ONS_OPTIMIZED

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

MESSAGE_FORMAT_PRETTY_JSON

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

MESSAGE_FORMAT_RAW

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

defined_tags

Gets the defined_tags of this UpdateMonitoringTemplateDetails.

description

Gets the description of this UpdateMonitoringTemplateDetails.

destinations

Gets the destinations of this UpdateMonitoringTemplateDetails.

display_name

Gets the display_name of this UpdateMonitoringTemplateDetails.

freeform_tags

Gets the freeform_tags of this UpdateMonitoringTemplateDetails.

is_alarms_enabled

Gets the is_alarms_enabled of this UpdateMonitoringTemplateDetails.

is_split_notification_enabled

Gets the is_split_notification_enabled of this UpdateMonitoringTemplateDetails.

members

Gets the members of this UpdateMonitoringTemplateDetails.

message_format

Gets the message_format of this UpdateMonitoringTemplateDetails.

repeat_notification_duration

Gets the repeat_notification_duration of this UpdateMonitoringTemplateDetails.

Methods:

__init__(**kwargs)

Initializes a new UpdateMonitoringTemplateDetails object with values from keyword arguments.

MESSAGE_FORMAT_ONS_OPTIMIZED = 'ONS_OPTIMIZED'

A constant which can be used with the message_format property of a UpdateMonitoringTemplateDetails. 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 UpdateMonitoringTemplateDetails. 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 UpdateMonitoringTemplateDetails. This constant has a value of “RAW”

__init__(**kwargs)

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

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

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

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

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

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

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

  • message_format (str) – The value to assign to the message_format property of this UpdateMonitoringTemplateDetails. Allowed values for this property are: “RAW”, “PRETTY_JSON”, “ONS_OPTIMIZED”

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

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

property defined_tags

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

Return type

dict(str, dict(str, object))

property description

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

Returns

The description of this UpdateMonitoringTemplateDetails.

Return type

str

property destinations

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

Returns

The destinations of this UpdateMonitoringTemplateDetails.

Return type

list[str]

property display_name

Gets the display_name of this UpdateMonitoringTemplateDetails. A user-friendly name for the monitoring template. It is unique and mutable in nature.

Returns

The display_name of this UpdateMonitoringTemplateDetails.

Return type

str

property freeform_tags

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

Return type

dict(str, str)

property is_alarms_enabled

Gets the is_alarms_enabled of this UpdateMonitoringTemplateDetails. User can create the out of box alarm only for multiple resourceTypes not for individual resource instances and groups for specified compartment.

Returns

The is_alarms_enabled of this UpdateMonitoringTemplateDetails.

Return type

bool

property is_split_notification_enabled

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

Returns

The is_split_notification_enabled of this UpdateMonitoringTemplateDetails.

Return type

bool

property members

Gets the members of this UpdateMonitoringTemplateDetails. List of members of this monitoring template.

Returns

The members of this UpdateMonitoringTemplateDetails.

Return type

list[oci.stack_monitoring.models.MemberReference]

property message_format

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

Allowed values for this property are: “RAW”, “PRETTY_JSON”, “ONS_OPTIMIZED”

Returns

The message_format of this UpdateMonitoringTemplateDetails.

Return type

str

property repeat_notification_duration

Gets the repeat_notification_duration of this UpdateMonitoringTemplateDetails. 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 UpdateMonitoringTemplateDetails.

Return type

str