Alert

class oci.data_safe.models.Alert(**kwargs)

Bases: object

The details of a Data Safe Alert, that shows alerts generated by a Data Safe feature.

Attributes:

ALERT_TYPE_AUDITING

A constant which can be used with the alert_type property of a Alert.

ALERT_TYPE_SECURITY_ASSESSMENT

A constant which can be used with the alert_type property of a Alert.

ALERT_TYPE_USER_ASSESSMENT

A constant which can be used with the alert_type property of a Alert.

LIFECYCLE_STATE_FAILED

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

LIFECYCLE_STATE_SUCCEEDED

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

LIFECYCLE_STATE_UPDATING

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

OPERATION_STATUS_FAILED

A constant which can be used with the operation_status property of a Alert.

OPERATION_STATUS_SUCCEEDED

A constant which can be used with the operation_status property of a Alert.

SEVERITY_CRITICAL

A constant which can be used with the severity property of a Alert.

SEVERITY_EVALUATE

A constant which can be used with the severity property of a Alert.

SEVERITY_HIGH

A constant which can be used with the severity property of a Alert.

SEVERITY_LOW

A constant which can be used with the severity property of a Alert.

SEVERITY_MEDIUM

A constant which can be used with the severity property of a Alert.

STATUS_CLOSED

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

STATUS_OPEN

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

alert_policy_rule_key

Gets the alert_policy_rule_key of this Alert.

alert_policy_rule_name

Gets the alert_policy_rule_name of this Alert.

alert_type

Gets the alert_type of this Alert.

comment

Gets the comment of this Alert.

compartment_id

[Required] Gets the compartment_id of this Alert.

defined_tags

Gets the defined_tags of this Alert.

description

Gets the description of this Alert.

display_name

[Required] Gets the display_name of this Alert.

feature_details

Gets the feature_details of this Alert. Map that contains maps of values. Example: {"Operations": {"CostCenter": "42"}}.

freeform_tags

Gets the freeform_tags of this Alert.

id

[Required] Gets the id of this Alert.

lifecycle_state

[Required] Gets the lifecycle_state of this Alert.

operation

Gets the operation of this Alert.

operation_status

Gets the operation_status of this Alert.

operation_time

Gets the operation_time of this Alert.

policy_id

Gets the policy_id of this Alert.

resource_name

Gets the resource_name of this Alert.

severity

Gets the severity of this Alert.

status

Gets the status of this Alert.

system_tags

Gets the system_tags of this Alert.

target_ids

Gets the target_ids of this Alert.

target_names

Gets the target_names of this Alert.

time_created

[Required] Gets the time_created of this Alert.

time_updated

[Required] Gets the time_updated of this Alert.

Methods:

__init__(**kwargs)

Initializes a new Alert object with values from keyword arguments.

ALERT_TYPE_AUDITING = 'AUDITING'

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

LIFECYCLE_STATE_SUCCEEDED = 'SUCCEEDED'

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

LIFECYCLE_STATE_UPDATING = 'UPDATING'

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

OPERATION_STATUS_FAILED = 'FAILED'

A constant which can be used with the operation_status property of a Alert. This constant has a value of “FAILED”

OPERATION_STATUS_SUCCEEDED = 'SUCCEEDED'

A constant which can be used with the operation_status property of a Alert. This constant has a value of “SUCCEEDED”

SEVERITY_CRITICAL = 'CRITICAL'

A constant which can be used with the severity property of a Alert. This constant has a value of “CRITICAL”

SEVERITY_EVALUATE = 'EVALUATE'

A constant which can be used with the severity property of a Alert. This constant has a value of “EVALUATE”

SEVERITY_HIGH = 'HIGH'

A constant which can be used with the severity property of a Alert. This constant has a value of “HIGH”

SEVERITY_LOW = 'LOW'

A constant which can be used with the severity property of a Alert. This constant has a value of “LOW”

SEVERITY_MEDIUM = 'MEDIUM'

A constant which can be used with the severity property of a Alert. This constant has a value of “MEDIUM”

STATUS_CLOSED = 'CLOSED'

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

STATUS_OPEN = 'OPEN'

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

__init__(**kwargs)

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

  • status (str) – The value to assign to the status property of this 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’.

  • severity (str) – The value to assign to the severity property of this 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’.

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

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

  • operation_time (datetime) – The value to assign to the operation_time property of this Alert.

  • operation (str) – The value to assign to the operation property of this Alert.

  • operation_status (str) – The value to assign to the operation_status property of this 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’.

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

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

  • policy_id (str) – The value to assign to the policy_id property of this Alert.

  • alert_type (str) – The value to assign to the alert_type property of this 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’.

  • resource_name (str) – The value to assign to the resource_name property of this Alert.

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

  • comment (str) – The value to assign to the comment property of this Alert.

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

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this 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’.

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

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

  • alert_policy_rule_key (str) – The value to assign to the alert_policy_rule_key property of this Alert.

  • alert_policy_rule_name (str) – The value to assign to the alert_policy_rule_name property of this Alert.

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

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

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

property alert_policy_rule_key

Gets the alert_policy_rule_key of this Alert. The key of the rule of alert policy that triggered alert.

Returns

The alert_policy_rule_key of this Alert.

Return type

str

property alert_policy_rule_name

Gets the alert_policy_rule_name of this Alert. The display name of the rule of alert policy that triggered alert.

Returns

The alert_policy_rule_name of this Alert.

Return type

str

property alert_type

Gets the alert_type of this Alert. 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 Alert.

Return type

str

property comment

Gets the comment of this Alert. A comment for the alert. Entered by the user.

Returns

The comment of this Alert.

Return type

str

property compartment_id

[Required] Gets the compartment_id of this Alert. The OCID of the compartment that contains the alert.

Returns

The compartment_id of this Alert.

Return type

str

property defined_tags

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

Return type

dict(str, dict(str, object))

property description

Gets the description of this Alert. The description of the alert.

Returns

The description of this Alert.

Return type

str

property display_name

[Required] Gets the display_name of this Alert. The display name of the alert.

Returns

The display_name of this Alert.

Return type

str

property feature_details

Gets the feature_details of this Alert. Map that contains maps of values.

Example: {“Operations”: {“CostCenter”: “42”}}

Returns

The feature_details of this Alert.

Return type

dict(str, dict(str, object))

property freeform_tags

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

Return type

dict(str, str)

property id

[Required] Gets the id of this Alert. The OCID of the alert.

Returns

The id of this Alert.

Return type

str

property lifecycle_state

[Required] Gets the lifecycle_state of this Alert. 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 Alert.

Return type

str

property operation

Gets the operation of this Alert. The operation (event) that triggered alert.

Returns

The operation of this Alert.

Return type

str

property operation_status

Gets the operation_status of this Alert. 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 Alert.

Return type

str

property operation_time

Gets the operation_time of this Alert. Creation date and time of the operation that triggered alert, in the format defined by RFC3339.

Returns

The operation_time of this Alert.

Return type

datetime

property policy_id

Gets the policy_id of this Alert. The OCID of the policy that triggered alert.

Returns

The policy_id of this Alert.

Return type

str

property resource_name

Gets the resource_name of this Alert. The resource endpoint that triggered the alert.

Returns

The resource_name of this Alert.

Return type

str

property severity

Gets the severity of this Alert. 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 Alert.

Return type

str

property status

Gets the status of this Alert. 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 Alert.

Return type

str

property system_tags

Gets the system_tags of this Alert. System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns

The system_tags of this Alert.

Return type

dict(str, dict(str, object))

property target_ids

Gets the target_ids of this Alert. Array of OCIDs of the target database which are associated with the alert.

Returns

The target_ids of this Alert.

Return type

list[str]

property target_names

Gets the target_names of this Alert. Array of names of the target database.

Returns

The target_names of this Alert.

Return type

list[str]

property time_created

[Required] Gets the time_created of this Alert. Creation date and time of the alert, in the format defined by RFC3339.

Returns

The time_created of this Alert.

Return type

datetime

property time_updated

[Required] Gets the time_updated of this Alert. Last date and time the alert was updated, in the format defined by RFC3339.

Returns

The time_updated of this Alert.

Return type

datetime