Server IP : 103.119.228.120 / Your IP : 18.225.175.230 Web Server : Apache System : Linux v8.techscape8.com 3.10.0-1160.119.1.el7.tuxcare.els2.x86_64 #1 SMP Mon Jul 15 12:09:18 UTC 2024 x86_64 User : nobody ( 99) PHP Version : 5.6.40 Disable Function : shell_exec,symlink,system,exec,proc_get_status,proc_nice,proc_terminate,define_syslog_variables,syslog,openlog,closelog,escapeshellcmd,passthru,ocinum cols,ini_alter,leak,listen,chgrp,apache_note,apache_setenv,debugger_on,debugger_off,ftp_exec,dl,dll,myshellexec,proc_open,socket_bind,proc_close,escapeshellarg,parse_ini_filepopen,fpassthru,exec,passthru,escapeshellarg,escapeshellcmd,proc_close,proc_open,ini_alter,popen,show_source,proc_nice,proc_terminate,proc_get_status,proc_close,pfsockopen,leak,apache_child_terminate,posix_kill,posix_mkfifo,posix_setpgid,posix_setsid,posix_setuid,dl,symlink,shell_exec,system,dl,passthru,escapeshellarg,escapeshellcmd,myshellexec,c99_buff_prepare,c99_sess_put,fpassthru,getdisfunc,fx29exec,fx29exec2,is_windows,disp_freespace,fx29sh_getupdate,fx29_buff_prepare,fx29_sess_put,fx29shexit,fx29fsearch,fx29ftpbrutecheck,fx29sh_tools,fx29sh_about,milw0rm,imagez,sh_name,myshellexec,checkproxyhost,dosyayicek,c99_buff_prepare,c99_sess_put,c99getsource,c99sh_getupdate,c99fsearch,c99shexit,view_perms,posix_getpwuid,posix_getgrgid,posix_kill,parse_perms,parsesort,view_perms_color,set_encoder_input,ls_setcheckboxall,ls_reverse_all,rsg_read,rsg_glob,selfURL,dispsecinfo,unix2DosTime,addFile,system,get_users,view_size,DirFiles,DirFilesWide,DirPrintHTMLHeaders,GetFilesTotal,GetTitles,GetTimeTotal,GetMatchesCount,GetFileMatchesCount,GetResultFiles,fs_copy_dir,fs_copy_obj,fs_move_dir,fs_move_obj,fs_rmdir,SearchText,getmicrotime MySQL : ON | cURL : ON | WGET : ON | Perl : ON | Python : ON | Sudo : ON | Pkexec : ON Directory : /usr/local/ssl/lib/mysqlsh/lib/python3.9/site-packages/oci/monitoring/models/ |
Upload File : |
# coding: utf-8 # Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved. # This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. # NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20180401 from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 from oci.decorators import init_model_state_from_kwargs @init_model_state_from_kwargs class Alarm(object): """ The properties that define an alarm. For information about alarms, see `Alarms Overview`__. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see `Getting Started with Policies`__. For information about endpoints and signing API requests, see `About the API`__. For information about available SDKs and tools, see `SDKS and Other Tools`__. __ https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#AlarmsOverview __ https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm __ https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm __ https://docs.cloud.oracle.com/iaas/Content/API/Concepts/sdks.htm """ #: A constant which can be used with the severity property of a Alarm. #: This constant has a value of "CRITICAL" SEVERITY_CRITICAL = "CRITICAL" #: A constant which can be used with the severity property of a Alarm. #: This constant has a value of "ERROR" SEVERITY_ERROR = "ERROR" #: A constant which can be used with the severity property of a Alarm. #: This constant has a value of "WARNING" SEVERITY_WARNING = "WARNING" #: A constant which can be used with the severity property of a Alarm. #: This constant has a value of "INFO" SEVERITY_INFO = "INFO" #: A constant which can be used with the message_format property of a Alarm. #: This constant has a value of "RAW" MESSAGE_FORMAT_RAW = "RAW" #: A constant which can be used with the message_format property of a Alarm. #: This constant has a value of "PRETTY_JSON" MESSAGE_FORMAT_PRETTY_JSON = "PRETTY_JSON" #: A constant which can be used with the message_format property of a Alarm. #: This constant has a value of "ONS_OPTIMIZED" MESSAGE_FORMAT_ONS_OPTIMIZED = "ONS_OPTIMIZED" #: A constant which can be used with the lifecycle_state property of a Alarm. #: This constant has a value of "ACTIVE" LIFECYCLE_STATE_ACTIVE = "ACTIVE" #: A constant which can be used with the lifecycle_state property of a Alarm. #: This constant has a value of "DELETING" LIFECYCLE_STATE_DELETING = "DELETING" #: A constant which can be used with the lifecycle_state property of a Alarm. #: This constant has a value of "DELETED" LIFECYCLE_STATE_DELETED = "DELETED" def __init__(self, **kwargs): """ Initializes a new Alarm object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class): :param id: The value to assign to the id property of this Alarm. :type id: str :param display_name: The value to assign to the display_name property of this Alarm. :type display_name: str :param compartment_id: The value to assign to the compartment_id property of this Alarm. :type compartment_id: str :param metric_compartment_id: The value to assign to the metric_compartment_id property of this Alarm. :type metric_compartment_id: str :param metric_compartment_id_in_subtree: The value to assign to the metric_compartment_id_in_subtree property of this Alarm. :type metric_compartment_id_in_subtree: bool :param namespace: The value to assign to the namespace property of this Alarm. :type namespace: str :param resource_group: The value to assign to the resource_group property of this Alarm. :type resource_group: str :param query: The value to assign to the query property of this Alarm. :type query: str :param resolution: The value to assign to the resolution property of this Alarm. :type resolution: str :param pending_duration: The value to assign to the pending_duration property of this Alarm. :type pending_duration: str :param severity: The value to assign to the severity property of this Alarm. Allowed values for this property are: "CRITICAL", "ERROR", "WARNING", "INFO", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type severity: str :param body: The value to assign to the body property of this Alarm. :type body: str :param is_notifications_per_metric_dimension_enabled: The value to assign to the is_notifications_per_metric_dimension_enabled property of this Alarm. :type is_notifications_per_metric_dimension_enabled: bool :param message_format: The value to assign to the message_format property of this Alarm. 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'. :type message_format: str :param destinations: The value to assign to the destinations property of this Alarm. :type destinations: list[str] :param repeat_notification_duration: The value to assign to the repeat_notification_duration property of this Alarm. :type repeat_notification_duration: str :param suppression: The value to assign to the suppression property of this Alarm. :type suppression: oci.monitoring.models.Suppression :param is_enabled: The value to assign to the is_enabled property of this Alarm. :type is_enabled: bool :param freeform_tags: The value to assign to the freeform_tags property of this Alarm. :type freeform_tags: dict(str, str) :param defined_tags: The value to assign to the defined_tags property of this Alarm. :type defined_tags: dict(str, dict(str, object)) :param overrides: The value to assign to the overrides property of this Alarm. :type overrides: list[oci.monitoring.models.AlarmOverride] :param rule_name: The value to assign to the rule_name property of this Alarm. :type rule_name: str :param notification_version: The value to assign to the notification_version property of this Alarm. :type notification_version: str :param notification_title: The value to assign to the notification_title property of this Alarm. :type notification_title: str :param evaluation_slack_duration: The value to assign to the evaluation_slack_duration property of this Alarm. :type evaluation_slack_duration: str :param alarm_summary: The value to assign to the alarm_summary property of this Alarm. :type alarm_summary: str :param lifecycle_state: The value to assign to the lifecycle_state property of this Alarm. Allowed values for this property are: "ACTIVE", "DELETING", "DELETED", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type lifecycle_state: str :param time_created: The value to assign to the time_created property of this Alarm. :type time_created: datetime :param time_updated: The value to assign to the time_updated property of this Alarm. :type time_updated: datetime """ self.swagger_types = { 'id': 'str', 'display_name': 'str', 'compartment_id': 'str', 'metric_compartment_id': 'str', 'metric_compartment_id_in_subtree': 'bool', 'namespace': 'str', 'resource_group': 'str', 'query': 'str', 'resolution': 'str', 'pending_duration': 'str', 'severity': 'str', 'body': 'str', 'is_notifications_per_metric_dimension_enabled': 'bool', 'message_format': 'str', 'destinations': 'list[str]', 'repeat_notification_duration': 'str', 'suppression': 'Suppression', 'is_enabled': 'bool', 'freeform_tags': 'dict(str, str)', 'defined_tags': 'dict(str, dict(str, object))', 'overrides': 'list[AlarmOverride]', 'rule_name': 'str', 'notification_version': 'str', 'notification_title': 'str', 'evaluation_slack_duration': 'str', 'alarm_summary': 'str', 'lifecycle_state': 'str', 'time_created': 'datetime', 'time_updated': 'datetime' } self.attribute_map = { 'id': 'id', 'display_name': 'displayName', 'compartment_id': 'compartmentId', 'metric_compartment_id': 'metricCompartmentId', 'metric_compartment_id_in_subtree': 'metricCompartmentIdInSubtree', 'namespace': 'namespace', 'resource_group': 'resourceGroup', 'query': 'query', 'resolution': 'resolution', 'pending_duration': 'pendingDuration', 'severity': 'severity', 'body': 'body', 'is_notifications_per_metric_dimension_enabled': 'isNotificationsPerMetricDimensionEnabled', 'message_format': 'messageFormat', 'destinations': 'destinations', 'repeat_notification_duration': 'repeatNotificationDuration', 'suppression': 'suppression', 'is_enabled': 'isEnabled', 'freeform_tags': 'freeformTags', 'defined_tags': 'definedTags', 'overrides': 'overrides', 'rule_name': 'ruleName', 'notification_version': 'notificationVersion', 'notification_title': 'notificationTitle', 'evaluation_slack_duration': 'evaluationSlackDuration', 'alarm_summary': 'alarmSummary', 'lifecycle_state': 'lifecycleState', 'time_created': 'timeCreated', 'time_updated': 'timeUpdated' } self._id = None self._display_name = None self._compartment_id = None self._metric_compartment_id = None self._metric_compartment_id_in_subtree = None self._namespace = None self._resource_group = None self._query = None self._resolution = None self._pending_duration = None self._severity = None self._body = None self._is_notifications_per_metric_dimension_enabled = None self._message_format = None self._destinations = None self._repeat_notification_duration = None self._suppression = None self._is_enabled = None self._freeform_tags = None self._defined_tags = None self._overrides = None self._rule_name = None self._notification_version = None self._notification_title = None self._evaluation_slack_duration = None self._alarm_summary = None self._lifecycle_state = None self._time_created = None self._time_updated = None @property def id(self): """ **[Required]** Gets the id of this Alarm. The `OCID`__ of the alarm. __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm :return: The id of this Alarm. :rtype: str """ return self._id @id.setter def id(self, id): """ Sets the id of this Alarm. The `OCID`__ of the alarm. __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm :param id: The id of this Alarm. :type: str """ self._id = id @property def display_name(self): """ **[Required]** Gets the display_name of this Alarm. A user-friendly name for the alarm. It does not have to be unique, and it's changeable. This value determines the title of each alarm notification. Example: `High CPU Utilization` :return: The display_name of this Alarm. :rtype: str """ return self._display_name @display_name.setter def display_name(self, display_name): """ Sets the display_name of this Alarm. A user-friendly name for the alarm. It does not have to be unique, and it's changeable. This value determines the title of each alarm notification. Example: `High CPU Utilization` :param display_name: The display_name of this Alarm. :type: str """ self._display_name = display_name @property def compartment_id(self): """ **[Required]** Gets the compartment_id of this Alarm. The `OCID`__ of the compartment containing the alarm. __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm :return: The compartment_id of this Alarm. :rtype: str """ return self._compartment_id @compartment_id.setter def compartment_id(self, compartment_id): """ Sets the compartment_id of this Alarm. The `OCID`__ of the compartment containing the alarm. __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm :param compartment_id: The compartment_id of this Alarm. :type: str """ self._compartment_id = compartment_id @property def metric_compartment_id(self): """ **[Required]** Gets the metric_compartment_id of this Alarm. The `OCID`__ of the compartment containing the metric being evaluated by the alarm. __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm :return: The metric_compartment_id of this Alarm. :rtype: str """ return self._metric_compartment_id @metric_compartment_id.setter def metric_compartment_id(self, metric_compartment_id): """ Sets the metric_compartment_id of this Alarm. The `OCID`__ of the compartment containing the metric being evaluated by the alarm. __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm :param metric_compartment_id: The metric_compartment_id of this Alarm. :type: str """ self._metric_compartment_id = metric_compartment_id @property def metric_compartment_id_in_subtree(self): """ Gets the metric_compartment_id_in_subtree of this Alarm. When true, the alarm evaluates metrics from all compartments and subcompartments. The parameter can only be set to true when metricCompartmentId is the tenancy OCID (the tenancy is the root compartment). A true value requires the user to have tenancy-level permissions. If this requirement is not met, then the call is rejected. When false, the alarm evaluates metrics from only the compartment specified in metricCompartmentId. Default is false. Example: `true` :return: The metric_compartment_id_in_subtree of this Alarm. :rtype: bool """ return self._metric_compartment_id_in_subtree @metric_compartment_id_in_subtree.setter def metric_compartment_id_in_subtree(self, metric_compartment_id_in_subtree): """ Sets the metric_compartment_id_in_subtree of this Alarm. When true, the alarm evaluates metrics from all compartments and subcompartments. The parameter can only be set to true when metricCompartmentId is the tenancy OCID (the tenancy is the root compartment). A true value requires the user to have tenancy-level permissions. If this requirement is not met, then the call is rejected. When false, the alarm evaluates metrics from only the compartment specified in metricCompartmentId. Default is false. Example: `true` :param metric_compartment_id_in_subtree: The metric_compartment_id_in_subtree of this Alarm. :type: bool """ self._metric_compartment_id_in_subtree = metric_compartment_id_in_subtree @property def namespace(self): """ **[Required]** Gets the namespace of this Alarm. The source service or application emitting the metric that is evaluated by the alarm. Example: `oci_computeagent` :return: The namespace of this Alarm. :rtype: str """ return self._namespace @namespace.setter def namespace(self, namespace): """ Sets the namespace of this Alarm. The source service or application emitting the metric that is evaluated by the alarm. Example: `oci_computeagent` :param namespace: The namespace of this Alarm. :type: str """ self._namespace = namespace @property def resource_group(self): """ Gets the resource_group of this Alarm. Resource group to match for metric data retrieved by the alarm. A resource group is a custom string that you can match when retrieving custom metrics. Only one resource group can be applied per metric. A valid resourceGroup value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($). Example: `frontend-fleet` :return: The resource_group of this Alarm. :rtype: str """ return self._resource_group @resource_group.setter def resource_group(self, resource_group): """ Sets the resource_group of this Alarm. Resource group to match for metric data retrieved by the alarm. A resource group is a custom string that you can match when retrieving custom metrics. Only one resource group can be applied per metric. A valid resourceGroup value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($). Example: `frontend-fleet` :param resource_group: The resource_group of this Alarm. :type: str """ self._resource_group = resource_group @property def query(self): """ **[Required]** Gets the query of this Alarm. The Monitoring Query Language (MQL) expression to evaluate for the alarm. The Alarms feature of the Monitoring service interprets results for each returned time series as Boolean values, where zero represents false and a non-zero value represents true. A true value means that the trigger rule condition has been met. The query must specify a metric, statistic, interval, and trigger rule (threshold or absence). Supported values for interval depend on the specified time range. More interval values are supported for smaller time ranges. You can optionally specify dimensions and grouping functions. Also, you can customize the `absence detection period`__. Supported grouping functions: `grouping()`, `groupBy()`. For information about writing MQL expressions, see `Editing the MQL Expression for a Query`__. For details about MQL, see `Monitoring Query Language (MQL) Reference`__. For available dimensions, review the metric definition for the supported service. See `Supported Services`__. Example of threshold alarm: ----- CpuUtilization[1m]{availabilityDomain=\"cumS:PHX-AD-1\"}.groupBy(availabilityDomain).percentile(0.9) > 85 ----- Example of absence alarm: ----- CpuUtilization[1m]{availabilityDomain=\"cumS:PHX-AD-1\"}.absent() ----- Example of absence alarm with custom absence detection period of 20 hours: ----- CpuUtilization[1m]{availabilityDomain=\"cumS:PHX-AD-1\"}.absent(20h) ----- __ https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/create-edit-alarm-query-absence-detection-period.htm __ https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/query-metric-mql.htm __ https://docs.cloud.oracle.com/iaas/Content/Monitoring/Reference/mql.htm __ https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#SupportedServices :return: The query of this Alarm. :rtype: str """ return self._query @query.setter def query(self, query): """ Sets the query of this Alarm. The Monitoring Query Language (MQL) expression to evaluate for the alarm. The Alarms feature of the Monitoring service interprets results for each returned time series as Boolean values, where zero represents false and a non-zero value represents true. A true value means that the trigger rule condition has been met. The query must specify a metric, statistic, interval, and trigger rule (threshold or absence). Supported values for interval depend on the specified time range. More interval values are supported for smaller time ranges. You can optionally specify dimensions and grouping functions. Also, you can customize the `absence detection period`__. Supported grouping functions: `grouping()`, `groupBy()`. For information about writing MQL expressions, see `Editing the MQL Expression for a Query`__. For details about MQL, see `Monitoring Query Language (MQL) Reference`__. For available dimensions, review the metric definition for the supported service. See `Supported Services`__. Example of threshold alarm: ----- CpuUtilization[1m]{availabilityDomain=\"cumS:PHX-AD-1\"}.groupBy(availabilityDomain).percentile(0.9) > 85 ----- Example of absence alarm: ----- CpuUtilization[1m]{availabilityDomain=\"cumS:PHX-AD-1\"}.absent() ----- Example of absence alarm with custom absence detection period of 20 hours: ----- CpuUtilization[1m]{availabilityDomain=\"cumS:PHX-AD-1\"}.absent(20h) ----- __ https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/create-edit-alarm-query-absence-detection-period.htm __ https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/query-metric-mql.htm __ https://docs.cloud.oracle.com/iaas/Content/Monitoring/Reference/mql.htm __ https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#SupportedServices :param query: The query of this Alarm. :type: str """ self._query = query @property def resolution(self): """ Gets the resolution of this Alarm. The time between calculated aggregation windows for the alarm. Supported value: `1m` :return: The resolution of this Alarm. :rtype: str """ return self._resolution @resolution.setter def resolution(self, resolution): """ Sets the resolution of this Alarm. The time between calculated aggregation windows for the alarm. Supported value: `1m` :param resolution: The resolution of this Alarm. :type: str """ self._resolution = resolution @property def pending_duration(self): """ Gets the pending_duration of this Alarm. The period of time that the condition defined in the alarm must persist before the alarm state changes from \"OK\" to \"FIRING\". For example, a value of 5 minutes means that the alarm must persist in breaching the condition for five minutes before the alarm updates its state to \"FIRING\". The duration is specified as a string in ISO 8601 format (`PT10M` for ten minutes or `PT1H` for one hour). Minimum: PT1M. Maximum: PT1H. Default: PT1M. Under the default value of PT1M, the first evaluation that breaches the alarm updates the state to \"FIRING\". The alarm updates its status to \"OK\" when the breaching condition has been clear for the most recent minute. Example: `PT5M` :return: The pending_duration of this Alarm. :rtype: str """ return self._pending_duration @pending_duration.setter def pending_duration(self, pending_duration): """ Sets the pending_duration of this Alarm. The period of time that the condition defined in the alarm must persist before the alarm state changes from \"OK\" to \"FIRING\". For example, a value of 5 minutes means that the alarm must persist in breaching the condition for five minutes before the alarm updates its state to \"FIRING\". The duration is specified as a string in ISO 8601 format (`PT10M` for ten minutes or `PT1H` for one hour). Minimum: PT1M. Maximum: PT1H. Default: PT1M. Under the default value of PT1M, the first evaluation that breaches the alarm updates the state to \"FIRING\". The alarm updates its status to \"OK\" when the breaching condition has been clear for the most recent minute. Example: `PT5M` :param pending_duration: The pending_duration of this Alarm. :type: str """ self._pending_duration = pending_duration @property def severity(self): """ **[Required]** Gets the severity of this Alarm. The perceived type of response required when the alarm is in the \"FIRING\" state. Example: `CRITICAL` Allowed values for this property are: "CRITICAL", "ERROR", "WARNING", "INFO", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :return: The severity of this Alarm. :rtype: str """ return self._severity @severity.setter def severity(self, severity): """ Sets the severity of this Alarm. The perceived type of response required when the alarm is in the \"FIRING\" state. Example: `CRITICAL` :param severity: The severity of this Alarm. :type: str """ allowed_values = ["CRITICAL", "ERROR", "WARNING", "INFO"] if not value_allowed_none_or_none_sentinel(severity, allowed_values): severity = 'UNKNOWN_ENUM_VALUE' self._severity = severity @property def body(self): """ Gets the body of this Alarm. The human-readable content of the delivered alarm notification. Optionally include `dynamic variables`__. Oracle recommends providing guidance to operators for resolving the alarm condition. Consider adding links to standard runbook practices. Avoid entering confidential information. Example: `High CPU usage alert. Follow runbook instructions for resolution.` __ https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/update-alarm-dynamic-variables.htm :return: The body of this Alarm. :rtype: str """ return self._body @body.setter def body(self, body): """ Sets the body of this Alarm. The human-readable content of the delivered alarm notification. Optionally include `dynamic variables`__. Oracle recommends providing guidance to operators for resolving the alarm condition. Consider adding links to standard runbook practices. Avoid entering confidential information. Example: `High CPU usage alert. Follow runbook instructions for resolution.` __ https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/update-alarm-dynamic-variables.htm :param body: The body of this Alarm. :type: str """ self._body = body @property def is_notifications_per_metric_dimension_enabled(self): """ Gets the is_notifications_per_metric_dimension_enabled of this Alarm. When set to `true`, splits alarm notifications per metric stream. When set to `false`, groups alarm notifications across metric streams. :return: The is_notifications_per_metric_dimension_enabled of this Alarm. :rtype: bool """ return self._is_notifications_per_metric_dimension_enabled @is_notifications_per_metric_dimension_enabled.setter def is_notifications_per_metric_dimension_enabled(self, is_notifications_per_metric_dimension_enabled): """ Sets the is_notifications_per_metric_dimension_enabled of this Alarm. When set to `true`, splits alarm notifications per metric stream. When set to `false`, groups alarm notifications across metric streams. :param is_notifications_per_metric_dimension_enabled: The is_notifications_per_metric_dimension_enabled of this Alarm. :type: bool """ self._is_notifications_per_metric_dimension_enabled = is_notifications_per_metric_dimension_enabled @property def message_format(self): """ Gets the message_format of this Alarm. The format to use for alarm notifications. The formats are: * `RAW` - Raw JSON blob. Default value. When the `destinations` attribute specifies `Streaming`, all alarm notifications use this format. * `PRETTY_JSON`: JSON with new lines and indents. Available when the `destinations` attribute specifies `Notifications` only. * `ONS_OPTIMIZED`: Simplified, user-friendly layout. Available when the `destinations` attribute specifies `Notifications` only. Applies to Email subscription types only. 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'. :return: The message_format of this Alarm. :rtype: str """ return self._message_format @message_format.setter def message_format(self, message_format): """ Sets the message_format of this Alarm. The format to use for alarm notifications. The formats are: * `RAW` - Raw JSON blob. Default value. When the `destinations` attribute specifies `Streaming`, all alarm notifications use this format. * `PRETTY_JSON`: JSON with new lines and indents. Available when the `destinations` attribute specifies `Notifications` only. * `ONS_OPTIMIZED`: Simplified, user-friendly layout. Available when the `destinations` attribute specifies `Notifications` only. Applies to Email subscription types only. :param message_format: The message_format of this Alarm. :type: str """ allowed_values = ["RAW", "PRETTY_JSON", "ONS_OPTIMIZED"] if not value_allowed_none_or_none_sentinel(message_format, allowed_values): message_format = 'UNKNOWN_ENUM_VALUE' self._message_format = message_format @property def destinations(self): """ **[Required]** Gets the destinations of this Alarm. A list of destinations for alarm notifications. Each destination is represented by the `OCID`__ of a related resource, such as a :class:`NotificationTopic`. Supported destination services: Notifications, Streaming. Limit: One destination per supported destination service. __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm :return: The destinations of this Alarm. :rtype: list[str] """ return self._destinations @destinations.setter def destinations(self, destinations): """ Sets the destinations of this Alarm. A list of destinations for alarm notifications. Each destination is represented by the `OCID`__ of a related resource, such as a :class:`NotificationTopic`. Supported destination services: Notifications, Streaming. Limit: One destination per supported destination service. __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm :param destinations: The destinations of this Alarm. :type: list[str] """ self._destinations = destinations @property def repeat_notification_duration(self): """ Gets the repeat_notification_duration of this Alarm. 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. Default value: null (notifications are not re-submitted). Example: `PT2H` :return: The repeat_notification_duration of this Alarm. :rtype: str """ return self._repeat_notification_duration @repeat_notification_duration.setter def repeat_notification_duration(self, repeat_notification_duration): """ Sets the repeat_notification_duration of this Alarm. 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. Default value: null (notifications are not re-submitted). Example: `PT2H` :param repeat_notification_duration: The repeat_notification_duration of this Alarm. :type: str """ self._repeat_notification_duration = repeat_notification_duration @property def suppression(self): """ Gets the suppression of this Alarm. The configuration details for suppressing an alarm. :return: The suppression of this Alarm. :rtype: oci.monitoring.models.Suppression """ return self._suppression @suppression.setter def suppression(self, suppression): """ Sets the suppression of this Alarm. The configuration details for suppressing an alarm. :param suppression: The suppression of this Alarm. :type: oci.monitoring.models.Suppression """ self._suppression = suppression @property def is_enabled(self): """ **[Required]** Gets the is_enabled of this Alarm. Whether the alarm is enabled. Example: `true` :return: The is_enabled of this Alarm. :rtype: bool """ return self._is_enabled @is_enabled.setter def is_enabled(self, is_enabled): """ Sets the is_enabled of this Alarm. Whether the alarm is enabled. Example: `true` :param is_enabled: The is_enabled of this Alarm. :type: bool """ self._is_enabled = is_enabled @property def freeform_tags(self): """ Gets the freeform_tags of this Alarm. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"Department\": \"Finance\"}` :return: The freeform_tags of this Alarm. :rtype: dict(str, str) """ return self._freeform_tags @freeform_tags.setter def freeform_tags(self, freeform_tags): """ Sets the freeform_tags of this Alarm. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"Department\": \"Finance\"}` :param freeform_tags: The freeform_tags of this Alarm. :type: dict(str, str) """ self._freeform_tags = freeform_tags @property def defined_tags(self): """ Gets the defined_tags of this Alarm. Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` :return: The defined_tags of this Alarm. :rtype: dict(str, dict(str, object)) """ return self._defined_tags @defined_tags.setter def defined_tags(self, defined_tags): """ Sets the defined_tags of this Alarm. Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` :param defined_tags: The defined_tags of this Alarm. :type: dict(str, dict(str, object)) """ self._defined_tags = defined_tags @property def overrides(self): """ Gets the overrides of this Alarm. A set of overrides that control evaluations of the alarm. Each override can specify values for query, severity, body, and pending duration. When an alarm contains overrides, the Monitoring service evaluates each override in order, beginning with the first override in the array (index position `0`), and then evaluates the alarm's base values (`ruleName` value of `BASE`). :return: The overrides of this Alarm. :rtype: list[oci.monitoring.models.AlarmOverride] """ return self._overrides @overrides.setter def overrides(self, overrides): """ Sets the overrides of this Alarm. A set of overrides that control evaluations of the alarm. Each override can specify values for query, severity, body, and pending duration. When an alarm contains overrides, the Monitoring service evaluates each override in order, beginning with the first override in the array (index position `0`), and then evaluates the alarm's base values (`ruleName` value of `BASE`). :param overrides: The overrides of this Alarm. :type: list[oci.monitoring.models.AlarmOverride] """ self._overrides = overrides @property def rule_name(self): """ Gets the rule_name of this Alarm. Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides. Default value is `BASE`. For information about alarm overrides, see :func:`alarm_override`. :return: The rule_name of this Alarm. :rtype: str """ return self._rule_name @rule_name.setter def rule_name(self, rule_name): """ Sets the rule_name of this Alarm. Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides. Default value is `BASE`. For information about alarm overrides, see :func:`alarm_override`. :param rule_name: The rule_name of this Alarm. :type: str """ self._rule_name = rule_name @property def notification_version(self): """ Gets the notification_version of this Alarm. The version of the alarm notification to be delivered. Allowed value: `1.X` The value must start with a number (up to four digits), followed by a period and an uppercase X. :return: The notification_version of this Alarm. :rtype: str """ return self._notification_version @notification_version.setter def notification_version(self, notification_version): """ Sets the notification_version of this Alarm. The version of the alarm notification to be delivered. Allowed value: `1.X` The value must start with a number (up to four digits), followed by a period and an uppercase X. :param notification_version: The notification_version of this Alarm. :type: str """ self._notification_version = notification_version @property def notification_title(self): """ Gets the notification_title of this Alarm. Customizable notification title (`title` `alarm message parameter`__). Optionally include `dynamic variables`__. The notification title appears as the subject line in a formatted email message and as the title in a Slack message. __ https://docs.cloud.oracle.com/iaas/Content/Monitoring/alarm-message-format.htm __ https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/update-alarm-dynamic-variables.htm :return: The notification_title of this Alarm. :rtype: str """ return self._notification_title @notification_title.setter def notification_title(self, notification_title): """ Sets the notification_title of this Alarm. Customizable notification title (`title` `alarm message parameter`__). Optionally include `dynamic variables`__. The notification title appears as the subject line in a formatted email message and as the title in a Slack message. __ https://docs.cloud.oracle.com/iaas/Content/Monitoring/alarm-message-format.htm __ https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/update-alarm-dynamic-variables.htm :param notification_title: The notification_title of this Alarm. :type: str """ self._notification_title = notification_title @property def evaluation_slack_duration(self): """ Gets the evaluation_slack_duration of this Alarm. Customizable slack period to wait for metric ingestion before evaluating the alarm. Specify a string in ISO 8601 format (`PT10M` for ten minutes or `PT1H` for one hour). Minimum: PT3M. Maximum: PT2H. Default: PT3M. For more information about the slack period, see `About the Internal Reset Period`__. __ https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#reset :return: The evaluation_slack_duration of this Alarm. :rtype: str """ return self._evaluation_slack_duration @evaluation_slack_duration.setter def evaluation_slack_duration(self, evaluation_slack_duration): """ Sets the evaluation_slack_duration of this Alarm. Customizable slack period to wait for metric ingestion before evaluating the alarm. Specify a string in ISO 8601 format (`PT10M` for ten minutes or `PT1H` for one hour). Minimum: PT3M. Maximum: PT2H. Default: PT3M. For more information about the slack period, see `About the Internal Reset Period`__. __ https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#reset :param evaluation_slack_duration: The evaluation_slack_duration of this Alarm. :type: str """ self._evaluation_slack_duration = evaluation_slack_duration @property def alarm_summary(self): """ Gets the alarm_summary of this Alarm. Customizable alarm summary (`alarmSummary` `alarm message parameter`__). Optionally include `dynamic variables`__. The alarm summary appears within the body of the alarm message and in responses to :func:`list_alarms_status` :func:`get_alarm_history` and :func:`retrieve_dimension_states`. __ https://docs.cloud.oracle.com/iaas/Content/Monitoring/alarm-message-format.htm __ https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/update-alarm-dynamic-variables.htm :return: The alarm_summary of this Alarm. :rtype: str """ return self._alarm_summary @alarm_summary.setter def alarm_summary(self, alarm_summary): """ Sets the alarm_summary of this Alarm. Customizable alarm summary (`alarmSummary` `alarm message parameter`__). Optionally include `dynamic variables`__. The alarm summary appears within the body of the alarm message and in responses to :func:`list_alarms_status` :func:`get_alarm_history` and :func:`retrieve_dimension_states`. __ https://docs.cloud.oracle.com/iaas/Content/Monitoring/alarm-message-format.htm __ https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/update-alarm-dynamic-variables.htm :param alarm_summary: The alarm_summary of this Alarm. :type: str """ self._alarm_summary = alarm_summary @property def lifecycle_state(self): """ **[Required]** Gets the lifecycle_state of this Alarm. The current lifecycle state of the alarm. Example: `DELETED` Allowed values for this property are: "ACTIVE", "DELETING", "DELETED", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :return: The lifecycle_state of this Alarm. :rtype: str """ return self._lifecycle_state @lifecycle_state.setter def lifecycle_state(self, lifecycle_state): """ Sets the lifecycle_state of this Alarm. The current lifecycle state of the alarm. Example: `DELETED` :param lifecycle_state: The lifecycle_state of this Alarm. :type: str """ allowed_values = ["ACTIVE", "DELETING", "DELETED"] if not value_allowed_none_or_none_sentinel(lifecycle_state, allowed_values): lifecycle_state = 'UNKNOWN_ENUM_VALUE' self._lifecycle_state = lifecycle_state @property def time_created(self): """ **[Required]** Gets the time_created of this Alarm. The date and time the alarm was created. Format defined by RFC3339. Example: `2023-02-01T01:02:29.600Z` :return: The time_created of this Alarm. :rtype: datetime """ return self._time_created @time_created.setter def time_created(self, time_created): """ Sets the time_created of this Alarm. The date and time the alarm was created. Format defined by RFC3339. Example: `2023-02-01T01:02:29.600Z` :param time_created: The time_created of this Alarm. :type: datetime """ self._time_created = time_created @property def time_updated(self): """ **[Required]** Gets the time_updated of this Alarm. The date and time the alarm was last updated. Format defined by RFC3339. Example: `2023-02-03T01:02:29.600Z` :return: The time_updated of this Alarm. :rtype: datetime """ return self._time_updated @time_updated.setter def time_updated(self, time_updated): """ Sets the time_updated of this Alarm. The date and time the alarm was last updated. Format defined by RFC3339. Example: `2023-02-03T01:02:29.600Z` :param time_updated: The time_updated of this Alarm. :type: datetime """ self._time_updated = time_updated def __repr__(self): return formatted_flat_dict(self) def __eq__(self, other): if other is None: return False return self.__dict__ == other.__dict__ def __ne__(self, other): return not self == other