AlertSummary¶
- class oci.data_safe.models.AlertSummary(**kwargs)¶
Bases:
objectSummary of a Data Safe Alert.
Attributes:
A constant which can be used with the alert_type property of a AlertSummary.
A constant which can be used with the alert_type property of a AlertSummary.
A constant which can be used with the alert_type property of a AlertSummary.
A constant which can be used with the lifecycle_state property of a AlertSummary.
A constant which can be used with the lifecycle_state property of a AlertSummary.
A constant which can be used with the lifecycle_state property of a AlertSummary.
A constant which can be used with the operation_status property of a AlertSummary.
A constant which can be used with the operation_status property of a AlertSummary.
A constant which can be used with the severity property of a AlertSummary.
A constant which can be used with the severity property of a AlertSummary.
A constant which can be used with the severity property of a AlertSummary.
A constant which can be used with the severity property of a AlertSummary.
A constant which can be used with the severity property of a AlertSummary.
A constant which can be used with the status property of a AlertSummary.
A constant which can be used with the status property of a AlertSummary.
Gets the alert_policy_rule_key of this AlertSummary.
Gets the alert_policy_rule_name of this AlertSummary.
Gets the alert_type of this AlertSummary.
[Required] Gets the compartment_id of this AlertSummary.
Gets the defined_tags of this AlertSummary.
Gets the description of this AlertSummary.
[Required] Gets the display_name of this AlertSummary.
Gets the feature_details of this AlertSummary. Map that contains maps of values. Example: {"Operations": {"CostCenter": "42"}}.
Gets the freeform_tags of this AlertSummary.
[Required] Gets the id of this AlertSummary.
[Required] Gets the lifecycle_state of this AlertSummary.
Gets the operation of this AlertSummary.
Gets the operation_status of this AlertSummary.
Gets the operation_time of this AlertSummary.
Gets the policy_id of this AlertSummary.
[Required] Gets the severity of this AlertSummary.
[Required] Gets the status of this AlertSummary.
Gets the target_ids of this AlertSummary.
Gets the target_names of this AlertSummary.
[Required] Gets the time_created of this AlertSummary.
[Required] Gets the time_updated of this AlertSummary.
Methods:
__init__(**kwargs)Initializes a new AlertSummary object with values from keyword arguments.
- ALERT_TYPE_AUDITING = 'AUDITING'¶
A constant which can be used with the alert_type property of a AlertSummary. This constant has a value of “AUDITING”
- ALERT_TYPE_SECURITY_ASSESSMENT = 'SECURITY_ASSESSMENT'¶
A constant which can be used with the alert_type property of a AlertSummary. This constant has a value of “SECURITY_ASSESSMENT”
- ALERT_TYPE_USER_ASSESSMENT = 'USER_ASSESSMENT'¶
A constant which can be used with the alert_type property of a AlertSummary. This constant has a value of “USER_ASSESSMENT”
- LIFECYCLE_STATE_FAILED = 'FAILED'¶
A constant which can be used with the lifecycle_state property of a AlertSummary. This constant has a value of “FAILED”
- LIFECYCLE_STATE_SUCCEEDED = 'SUCCEEDED'¶
A constant which can be used with the lifecycle_state property of a AlertSummary. This constant has a value of “SUCCEEDED”
- LIFECYCLE_STATE_UPDATING = 'UPDATING'¶
A constant which can be used with the lifecycle_state property of a AlertSummary. This constant has a value of “UPDATING”
- OPERATION_STATUS_FAILED = 'FAILED'¶
A constant which can be used with the operation_status property of a AlertSummary. This constant has a value of “FAILED”
- OPERATION_STATUS_SUCCEEDED = 'SUCCEEDED'¶
A constant which can be used with the operation_status property of a AlertSummary. This constant has a value of “SUCCEEDED”
- SEVERITY_CRITICAL = 'CRITICAL'¶
A constant which can be used with the severity property of a AlertSummary. This constant has a value of “CRITICAL”
- SEVERITY_EVALUATE = 'EVALUATE'¶
A constant which can be used with the severity property of a AlertSummary. This constant has a value of “EVALUATE”
- SEVERITY_HIGH = 'HIGH'¶
A constant which can be used with the severity property of a AlertSummary. This constant has a value of “HIGH”
- SEVERITY_LOW = 'LOW'¶
A constant which can be used with the severity property of a AlertSummary. This constant has a value of “LOW”
- SEVERITY_MEDIUM = 'MEDIUM'¶
A constant which can be used with the severity property of a AlertSummary. This constant has a value of “MEDIUM”
- STATUS_CLOSED = 'CLOSED'¶
A constant which can be used with the status property of a AlertSummary. This constant has a value of “CLOSED”
- STATUS_OPEN = 'OPEN'¶
A constant which can be used with the status property of a AlertSummary. This constant has a value of “OPEN”
- __init__(**kwargs)¶
Initializes a new AlertSummary 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 AlertSummary.
status (str) – The value to assign to the status property of this AlertSummary. Allowed values for this property are: “OPEN”, “CLOSED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
display_name (str) – The value to assign to the display_name property of this AlertSummary.
description (str) – The value to assign to the description property of this AlertSummary.
severity (str) – The value to assign to the severity property of this AlertSummary. Allowed values for this property are: “CRITICAL”, “HIGH”, “MEDIUM”, “LOW”, “EVALUATE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
operation_time (datetime) – The value to assign to the operation_time property of this AlertSummary.
operation (str) – The value to assign to the operation property of this AlertSummary.
operation_status (str) – The value to assign to the operation_status property of this AlertSummary. Allowed values for this property are: “SUCCEEDED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
target_ids (list[str]) – The value to assign to the target_ids property of this AlertSummary.
target_names (list[str]) – The value to assign to the target_names property of this AlertSummary.
policy_id (str) – The value to assign to the policy_id property of this AlertSummary.
alert_type (str) – The value to assign to the alert_type property of this AlertSummary. Allowed values for this property are: “AUDITING”, “SECURITY_ASSESSMENT”, “USER_ASSESSMENT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
compartment_id (str) – The value to assign to the compartment_id property of this AlertSummary.
time_created (datetime) – The value to assign to the time_created property of this AlertSummary.
time_updated (datetime) – The value to assign to the time_updated property of this AlertSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this AlertSummary. Allowed values for this property are: “UPDATING”, “SUCCEEDED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
alert_policy_rule_key (str) – The value to assign to the alert_policy_rule_key property of this AlertSummary.
alert_policy_rule_name (str) – The value to assign to the alert_policy_rule_name property of this AlertSummary.
feature_details (dict(str, dict(str, object))) – The value to assign to the feature_details property of this AlertSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this AlertSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this AlertSummary.
- property alert_policy_rule_key¶
Gets the alert_policy_rule_key of this AlertSummary. The key of the rule of alert policy that triggered alert.
- Returns
The alert_policy_rule_key of this AlertSummary.
- Return type
str
- property alert_policy_rule_name¶
Gets the alert_policy_rule_name of this AlertSummary. The display name of the rule of alert policy that triggered alert.
- Returns
The alert_policy_rule_name of this AlertSummary.
- Return type
str
- property alert_type¶
Gets the alert_type of this AlertSummary. Type of the alert. Indicates the Data Safe feature triggering the alert.
Allowed values for this property are: “AUDITING”, “SECURITY_ASSESSMENT”, “USER_ASSESSMENT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The alert_type of this AlertSummary.
- Return type
str
- property compartment_id¶
[Required] Gets the compartment_id of this AlertSummary. The OCID of the compartment that contains the alert.
- Returns
The compartment_id of this AlertSummary.
- Return type
str
- property defined_tags¶
Gets the defined_tags of this AlertSummary. 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 AlertSummary.
- Return type
dict(str, dict(str, object))
- property description¶
Gets the description of this AlertSummary. The details of the alert.
- Returns
The description of this AlertSummary.
- Return type
str
- property display_name¶
[Required] Gets the display_name of this AlertSummary. The display name of the alert.
- Returns
The display_name of this AlertSummary.
- Return type
str
- property feature_details¶
Gets the feature_details of this AlertSummary. Map that contains maps of values.
Example: {“Operations”: {“CostCenter”: “42”}}
- Returns
The feature_details of this AlertSummary.
- Return type
dict(str, dict(str, object))
- property freeform_tags¶
Gets the freeform_tags of this AlertSummary. 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 AlertSummary.
- Return type
dict(str, str)
- property id¶
[Required] Gets the id of this AlertSummary. The OCID of the alert.
- Returns
The id of this AlertSummary.
- Return type
str
- property lifecycle_state¶
[Required] Gets the lifecycle_state of this AlertSummary. The current state of the alert.
Allowed values for this property are: “UPDATING”, “SUCCEEDED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The lifecycle_state of this AlertSummary.
- Return type
str
- property operation¶
Gets the operation of this AlertSummary. The operation that triggered alert.
- Returns
The operation of this AlertSummary.
- Return type
str
- property operation_status¶
Gets the operation_status of this AlertSummary. The result of the operation (event) that triggered alert.
Allowed values for this property are: “SUCCEEDED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The operation_status of this AlertSummary.
- Return type
str
- property operation_time¶
Gets the operation_time of this AlertSummary. Creation date and time of the operation that triggered alert, in the format defined by RFC3339.
- Returns
The operation_time of this AlertSummary.
- Return type
datetime
- property policy_id¶
Gets the policy_id of this AlertSummary. The OCID of the policy that triggered alert.
- Returns
The policy_id of this AlertSummary.
- Return type
str
- property severity¶
[Required] Gets the severity of this AlertSummary. Severity level of the alert.
Allowed values for this property are: “CRITICAL”, “HIGH”, “MEDIUM”, “LOW”, “EVALUATE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The severity of this AlertSummary.
- Return type
str
- property status¶
[Required] Gets the status of this AlertSummary. The status of the alert.
Allowed values for this property are: “OPEN”, “CLOSED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The status of this AlertSummary.
- Return type
str
- property target_ids¶
Gets the target_ids of this AlertSummary. Array of OCIDs of the target database.
- Returns
The target_ids of this AlertSummary.
- Return type
list[str]
- property target_names¶
Gets the target_names of this AlertSummary. Array of names of the target database.
- Returns
The target_names of this AlertSummary.
- Return type
list[str]