AlertPolicySummary

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

Bases: object

Summary of a Data Safe alert policy.

Attributes:

ALERT_POLICY_TYPE_AUDITING

A constant which can be used with the alert_policy_type property of a AlertPolicySummary.

ALERT_POLICY_TYPE_SECURITY_ASSESSMENT

A constant which can be used with the alert_policy_type property of a AlertPolicySummary.

ALERT_POLICY_TYPE_USER_ASSESSMENT

A constant which can be used with the alert_policy_type property of a AlertPolicySummary.

LIFECYCLE_STATE_ACTIVE

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

LIFECYCLE_STATE_CREATING

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

LIFECYCLE_STATE_DELETED

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

LIFECYCLE_STATE_DELETING

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

LIFECYCLE_STATE_FAILED

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

LIFECYCLE_STATE_UPDATING

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

SEVERITY_CRITICAL

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

SEVERITY_EVALUATE

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

SEVERITY_HIGH

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

SEVERITY_LOW

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

SEVERITY_MEDIUM

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

alert_policy_type

[Required] Gets the alert_policy_type of this AlertPolicySummary.

compartment_id

[Required] Gets the compartment_id of this AlertPolicySummary.

defined_tags

Gets the defined_tags of this AlertPolicySummary.

description

Gets the description of this AlertPolicySummary.

display_name

[Required] Gets the display_name of this AlertPolicySummary.

freeform_tags

Gets the freeform_tags of this AlertPolicySummary.

id

[Required] Gets the id of this AlertPolicySummary.

is_user_defined

Gets the is_user_defined of this AlertPolicySummary.

lifecycle_details

Gets the lifecycle_details of this AlertPolicySummary.

lifecycle_state

[Required] Gets the lifecycle_state of this AlertPolicySummary.

severity

Gets the severity of this AlertPolicySummary.

time_created

[Required] Gets the time_created of this AlertPolicySummary.

time_updated

[Required] Gets the time_updated of this AlertPolicySummary.

Methods:

__init__(**kwargs)

Initializes a new AlertPolicySummary object with values from keyword arguments.

ALERT_POLICY_TYPE_AUDITING = 'AUDITING'

A constant which can be used with the alert_policy_type property of a AlertPolicySummary. This constant has a value of “AUDITING”

ALERT_POLICY_TYPE_SECURITY_ASSESSMENT = 'SECURITY_ASSESSMENT'

A constant which can be used with the alert_policy_type property of a AlertPolicySummary. This constant has a value of “SECURITY_ASSESSMENT”

ALERT_POLICY_TYPE_USER_ASSESSMENT = 'USER_ASSESSMENT'

A constant which can be used with the alert_policy_type property of a AlertPolicySummary. This constant has a value of “USER_ASSESSMENT”

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

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

LIFECYCLE_STATE_CREATING = 'CREATING'

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

LIFECYCLE_STATE_DELETED = 'DELETED'

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

LIFECYCLE_STATE_DELETING = 'DELETING'

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

LIFECYCLE_STATE_FAILED = 'FAILED'

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

LIFECYCLE_STATE_UPDATING = 'UPDATING'

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

SEVERITY_CRITICAL = 'CRITICAL'

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

SEVERITY_EVALUATE = 'EVALUATE'

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

SEVERITY_HIGH = 'HIGH'

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

SEVERITY_LOW = 'LOW'

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

SEVERITY_MEDIUM = 'MEDIUM'

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

__init__(**kwargs)

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

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

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

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

  • is_user_defined (bool) – The value to assign to the is_user_defined property of this AlertPolicySummary.

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

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

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

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

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this AlertPolicySummary. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • lifecycle_details (str) – The value to assign to the lifecycle_details property of this AlertPolicySummary.

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

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

property alert_policy_type

[Required] Gets the alert_policy_type of this AlertPolicySummary. Indicates the Data Safe feature that the alert policy belongs to.

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_policy_type of this AlertPolicySummary.

Return type

str

property compartment_id

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

Returns

The compartment_id of this AlertPolicySummary.

Return type

str

property defined_tags

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

Return type

dict(str, dict(str, object))

property description

Gets the description of this AlertPolicySummary. The details of the alert policy.

Returns

The description of this AlertPolicySummary.

Return type

str

property display_name

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

Returns

The display_name of this AlertPolicySummary.

Return type

str

property freeform_tags

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

Return type

dict(str, str)

property id

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

Returns

The id of this AlertPolicySummary.

Return type

str

property is_user_defined

Gets the is_user_defined of this AlertPolicySummary. Indicates if the alert policy is user-defined (true) or pre-defined (false).

Returns

The is_user_defined of this AlertPolicySummary.

Return type

bool

property lifecycle_details

Gets the lifecycle_details of this AlertPolicySummary. Details about the current state of the alert policy.

Returns

The lifecycle_details of this AlertPolicySummary.

Return type

str

property lifecycle_state

[Required] Gets the lifecycle_state of this AlertPolicySummary. The current state of the alert policy.

Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The lifecycle_state of this AlertPolicySummary.

Return type

str

property severity

Gets the severity of this AlertPolicySummary. Severity level of the alert raised by this policy.

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 AlertPolicySummary.

Return type

str

property time_created

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

Returns

The time_created of this AlertPolicySummary.

Return type

datetime

property time_updated

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

Returns

The time_updated of this AlertPolicySummary.

Return type

datetime