MonitoringTemplateSummary¶

class oci.stack_monitoring.models.MonitoringTemplateSummary(**kwargs)¶

Bases: object

Summary information about Monitoring Template.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a MonitoringTemplateSummary.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a MonitoringTemplateSummary.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a MonitoringTemplateSummary.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a MonitoringTemplateSummary.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a MonitoringTemplateSummary.
`STATUS_APPLIED`	A constant which can be used with the status property of a MonitoringTemplateSummary.
`STATUS_NOT_APPLIED`	A constant which can be used with the status property of a MonitoringTemplateSummary.
`STATUS_PARTIAL_APPLIED`	A constant which can be used with the status property of a MonitoringTemplateSummary.
`compartment_id`	[Required] Gets the compartment_id of this MonitoringTemplateSummary.
`defined_tags`	Gets the defined_tags of this MonitoringTemplateSummary.
`description`	Gets the description of this MonitoringTemplateSummary.
`destinations`	[Required] Gets the destinations of this MonitoringTemplateSummary.
`display_name`	[Required] Gets the display_name of this MonitoringTemplateSummary.
`freeform_tags`	Gets the freeform_tags of this MonitoringTemplateSummary.
`id`	[Required] Gets the id of this MonitoringTemplateSummary.
`lifecycle_state`	[Required] Gets the lifecycle_state of this MonitoringTemplateSummary.
`members`	Gets the members of this MonitoringTemplateSummary.
`status`	[Required] Gets the status of this MonitoringTemplateSummary.
`system_tags`	Gets the system_tags of this MonitoringTemplateSummary.
`tenant_id`	[Required] Gets the tenant_id of this MonitoringTemplateSummary.
`time_created`	[Required] Gets the time_created of this MonitoringTemplateSummary.
`time_updated`	[Required] Gets the time_updated of this MonitoringTemplateSummary.
`total_alarm_conditions`	[Required] Gets the total_alarm_conditions of this MonitoringTemplateSummary.
`total_applied_alarm_conditions`	[Required] Gets the total_applied_alarm_conditions of this MonitoringTemplateSummary.

Methods

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

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

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

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

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶: A constant which can be used with the lifecycle_state property of a MonitoringTemplateSummary. This constant has a value of “INACTIVE”

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

STATUS_APPLIED = 'APPLIED'¶: A constant which can be used with the status property of a MonitoringTemplateSummary. This constant has a value of “APPLIED”

STATUS_NOT_APPLIED = 'NOT_APPLIED'¶: A constant which can be used with the status property of a MonitoringTemplateSummary. 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 MonitoringTemplateSummary. This constant has a value of “PARTIAL_APPLIED”

__init__(**kwargs)¶

Initializes a new MonitoringTemplateSummary 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 MonitoringTemplateSummary.
display_name (str) – The value to assign to the display_name property of this MonitoringTemplateSummary.
tenant_id (str) – The value to assign to the tenant_id property of this MonitoringTemplateSummary.
compartment_id (str) – The value to assign to the compartment_id property of this MonitoringTemplateSummary.
description (str) – The value to assign to the description property of this MonitoringTemplateSummary.
status (str) – The value to assign to the status property of this MonitoringTemplateSummary. 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 MonitoringTemplateSummary. 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 MonitoringTemplateSummary.
members (list[oci.stack_monitoring.models.MemberReference]) – The value to assign to the members property of this MonitoringTemplateSummary.
total_alarm_conditions (float) – The value to assign to the total_alarm_conditions property of this MonitoringTemplateSummary.
total_applied_alarm_conditions (float) – The value to assign to the total_applied_alarm_conditions property of this MonitoringTemplateSummary.
time_created (datetime) – The value to assign to the time_created property of this MonitoringTemplateSummary.
time_updated (datetime) – The value to assign to the time_updated property of this MonitoringTemplateSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this MonitoringTemplateSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this MonitoringTemplateSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this MonitoringTemplateSummary.

compartment_id¶

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

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

defined_tags¶

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

description¶

Gets the description of this MonitoringTemplateSummary. A user-friendly description for the monitoring template

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

destinations¶

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

Returns:	The destinations of this MonitoringTemplateSummary.
Return type:	list[str]

display_name¶

[Required] Gets the display_name of this MonitoringTemplateSummary. A user-friendly name for the monitoring template.

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

freeform_tags¶

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

id¶

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

Returns:	The id of this MonitoringTemplateSummary.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this MonitoringTemplateSummary. 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 MonitoringTemplateSummary.
Return type:	str

members¶

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

Returns:	The members of this MonitoringTemplateSummary.
Return type:	list[oci.stack_monitoring.models.MemberReference]

status¶

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

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 MonitoringTemplateSummary.
Return type:	str

system_tags¶

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

tenant_id¶

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

Returns:	The tenant_id of this MonitoringTemplateSummary.
Return type:	str

time_created¶

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

Returns:	The time_created of this MonitoringTemplateSummary.
Return type:	datetime

time_updated¶

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

Returns:	The time_updated of this MonitoringTemplateSummary.
Return type:	datetime

total_alarm_conditions¶

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

Returns:	The total_alarm_conditions of this MonitoringTemplateSummary.
Return type:	float

total_applied_alarm_conditions¶

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

Returns:	The total_applied_alarm_conditions of this MonitoringTemplateSummary.
Return type:	float