AuditTrailSummary¶
- class oci.data_safe.models.AuditTrailSummary(**kwargs)¶
Bases:
objectSummary of an audit trail.
Attributes:
A constant which can be used with the lifecycle_state property of a AuditTrailSummary.
A constant which can be used with the lifecycle_state property of a AuditTrailSummary.
A constant which can be used with the lifecycle_state property of a AuditTrailSummary.
A constant which can be used with the lifecycle_state property of a AuditTrailSummary.
A constant which can be used with the lifecycle_state property of a AuditTrailSummary.
A constant which can be used with the lifecycle_state property of a AuditTrailSummary.
A constant which can be used with the status property of a AuditTrailSummary.
A constant which can be used with the status property of a AuditTrailSummary.
A constant which can be used with the status property of a AuditTrailSummary.
A constant which can be used with the status property of a AuditTrailSummary.
A constant which can be used with the status property of a AuditTrailSummary.
A constant which can be used with the status property of a AuditTrailSummary.
A constant which can be used with the status property of a AuditTrailSummary.
A constant which can be used with the status property of a AuditTrailSummary.
A constant which can be used with the status property of a AuditTrailSummary.
A constant which can be used with the status property of a AuditTrailSummary.
A constant which can be used with the status property of a AuditTrailSummary.
Gets the audit_collection_start_time of this AuditTrailSummary.
[Required] Gets the audit_profile_id of this AuditTrailSummary.
[Required] Gets the compartment_id of this AuditTrailSummary.
Gets the defined_tags of this AuditTrailSummary.
Gets the description of this AuditTrailSummary.
[Required] Gets the display_name of this AuditTrailSummary.
Gets the freeform_tags of this AuditTrailSummary.
[Required] Gets the id of this AuditTrailSummary.
Gets the is_auto_purge_enabled of this AuditTrailSummary.
Gets the lifecycle_details of this AuditTrailSummary.
[Required] Gets the lifecycle_state of this AuditTrailSummary.
Gets the peer_target_database_key of this AuditTrailSummary.
[Required] Gets the status of this AuditTrailSummary.
[Required] Gets the target_id of this AuditTrailSummary.
[Required] Gets the time_created of this AuditTrailSummary.
[Required] Gets the time_updated of this AuditTrailSummary.
Gets the trail_location of this AuditTrailSummary.
Methods:
__init__(**kwargs)Initializes a new AuditTrailSummary object with values from keyword arguments.
- LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶
A constant which can be used with the lifecycle_state property of a AuditTrailSummary. This constant has a value of “ACTIVE”
- LIFECYCLE_STATE_DELETING = 'DELETING'¶
A constant which can be used with the lifecycle_state property of a AuditTrailSummary. This constant has a value of “DELETING”
- LIFECYCLE_STATE_FAILED = 'FAILED'¶
A constant which can be used with the lifecycle_state property of a AuditTrailSummary. This constant has a value of “FAILED”
- LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶
A constant which can be used with the lifecycle_state property of a AuditTrailSummary. This constant has a value of “INACTIVE”
- LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'¶
A constant which can be used with the lifecycle_state property of a AuditTrailSummary. This constant has a value of “NEEDS_ATTENTION”
- LIFECYCLE_STATE_UPDATING = 'UPDATING'¶
A constant which can be used with the lifecycle_state property of a AuditTrailSummary. This constant has a value of “UPDATING”
- STATUS_COLLECTING = 'COLLECTING'¶
A constant which can be used with the status property of a AuditTrailSummary. This constant has a value of “COLLECTING”
- STATUS_IDLE = 'IDLE'¶
A constant which can be used with the status property of a AuditTrailSummary. This constant has a value of “IDLE”
- STATUS_NOT_STARTED = 'NOT_STARTED'¶
A constant which can be used with the status property of a AuditTrailSummary. This constant has a value of “NOT_STARTED”
- STATUS_RECOVERING = 'RECOVERING'¶
A constant which can be used with the status property of a AuditTrailSummary. This constant has a value of “RECOVERING”
- STATUS_RESUMING = 'RESUMING'¶
A constant which can be used with the status property of a AuditTrailSummary. This constant has a value of “RESUMING”
- STATUS_RETRYING = 'RETRYING'¶
A constant which can be used with the status property of a AuditTrailSummary. This constant has a value of “RETRYING”
- STATUS_STARTING = 'STARTING'¶
A constant which can be used with the status property of a AuditTrailSummary. This constant has a value of “STARTING”
- STATUS_STOPPED = 'STOPPED'¶
A constant which can be used with the status property of a AuditTrailSummary. This constant has a value of “STOPPED”
- STATUS_STOPPED_FAILED = 'STOPPED_FAILED'¶
A constant which can be used with the status property of a AuditTrailSummary. This constant has a value of “STOPPED_FAILED”
- STATUS_STOPPED_NEEDS_ATTN = 'STOPPED_NEEDS_ATTN'¶
A constant which can be used with the status property of a AuditTrailSummary. This constant has a value of “STOPPED_NEEDS_ATTN”
- STATUS_STOPPING = 'STOPPING'¶
A constant which can be used with the status property of a AuditTrailSummary. This constant has a value of “STOPPING”
- __init__(**kwargs)¶
Initializes a new AuditTrailSummary 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 AuditTrailSummary.
audit_profile_id (str) – The value to assign to the audit_profile_id property of this AuditTrailSummary.
display_name (str) – The value to assign to the display_name property of this AuditTrailSummary.
time_created (datetime) – The value to assign to the time_created property of this AuditTrailSummary.
time_updated (datetime) – The value to assign to the time_updated property of this AuditTrailSummary.
status (str) – The value to assign to the status property of this AuditTrailSummary. Allowed values for this property are: “STARTING”, “COLLECTING”, “RECOVERING”, “IDLE”, “STOPPING”, “STOPPED”, “RESUMING”, “RETRYING”, “NOT_STARTED”, “STOPPED_NEEDS_ATTN”, “STOPPED_FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
description (str) – The value to assign to the description property of this AuditTrailSummary.
trail_location (str) – The value to assign to the trail_location property of this AuditTrailSummary.
compartment_id (str) – The value to assign to the compartment_id property of this AuditTrailSummary.
target_id (str) – The value to assign to the target_id property of this AuditTrailSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this AuditTrailSummary. Allowed values for this property are: “INACTIVE”, “UPDATING”, “ACTIVE”, “DELETING”, “FAILED”, “NEEDS_ATTENTION”, ‘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 AuditTrailSummary.
is_auto_purge_enabled (bool) – The value to assign to the is_auto_purge_enabled property of this AuditTrailSummary.
audit_collection_start_time (datetime) – The value to assign to the audit_collection_start_time property of this AuditTrailSummary.
peer_target_database_key (int) – The value to assign to the peer_target_database_key property of this AuditTrailSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this AuditTrailSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this AuditTrailSummary.
- property audit_collection_start_time¶
Gets the audit_collection_start_time of this AuditTrailSummary. The date from which the audit trail must start collecting data, in the format defined by RFC3339.
- Returns
The audit_collection_start_time of this AuditTrailSummary.
- Return type
datetime
- property audit_profile_id¶
[Required] Gets the audit_profile_id of this AuditTrailSummary. The OCID of the parent audit.
- Returns
The audit_profile_id of this AuditTrailSummary.
- Return type
str
- property compartment_id¶
[Required] Gets the compartment_id of this AuditTrailSummary. The OCID of the compartment that contains the audit.
- Returns
The compartment_id of this AuditTrailSummary.
- Return type
str
- property defined_tags¶
Gets the defined_tags of this AuditTrailSummary. 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 AuditTrailSummary.
- Return type
dict(str, dict(str, object))
- property description¶
Gets the description of this AuditTrailSummary. The description of audit trail.
- Returns
The description of this AuditTrailSummary.
- Return type
str
- property display_name¶
[Required] Gets the display_name of this AuditTrailSummary. The display name of the audit trail.
- Returns
The display_name of this AuditTrailSummary.
- Return type
str
- property freeform_tags¶
Gets the freeform_tags of this AuditTrailSummary. 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 AuditTrailSummary.
- Return type
dict(str, str)
- property id¶
[Required] Gets the id of this AuditTrailSummary. The OCID of the audit trail.
- Returns
The id of this AuditTrailSummary.
- Return type
str
- property is_auto_purge_enabled¶
Gets the is_auto_purge_enabled of this AuditTrailSummary. Indicates if auto purge is enabled on the target database, which helps delete audit data in the target database every seven days so that the database’s audit trail does not become too large.
- Returns
The is_auto_purge_enabled of this AuditTrailSummary.
- Return type
bool
- property lifecycle_details¶
Gets the lifecycle_details of this AuditTrailSummary. Details about the current state of the audit trail in Data Safe. This attribute will be deprecated, but will still be available in GET audit trail response.
- Returns
The lifecycle_details of this AuditTrailSummary.
- Return type
str
- property lifecycle_state¶
[Required] Gets the lifecycle_state of this AuditTrailSummary. The current state of the audit trail.
Allowed values for this property are: “INACTIVE”, “UPDATING”, “ACTIVE”, “DELETING”, “FAILED”, “NEEDS_ATTENTION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The lifecycle_state of this AuditTrailSummary.
- Return type
str
- property peer_target_database_key¶
Gets the peer_target_database_key of this AuditTrailSummary. The secondary id assigned for the peer database registered with Data Safe.
- Returns
The peer_target_database_key of this AuditTrailSummary.
- Return type
int
- property status¶
[Required] Gets the status of this AuditTrailSummary. The current sub-state of the audit trail.
Allowed values for this property are: “STARTING”, “COLLECTING”, “RECOVERING”, “IDLE”, “STOPPING”, “STOPPED”, “RESUMING”, “RETRYING”, “NOT_STARTED”, “STOPPED_NEEDS_ATTN”, “STOPPED_FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The status of this AuditTrailSummary.
- Return type
str
- property target_id¶
[Required] Gets the target_id of this AuditTrailSummary. The OCID of the Data Safe target for which the audit trail is created.
- Returns
The target_id of this AuditTrailSummary.
- Return type
str
- property time_created¶
[Required] Gets the time_created of this AuditTrailSummary. The date and time the audit trail was created, in the format defined by RFC3339.
- Returns
The time_created of this AuditTrailSummary.
- Return type
datetime
- property time_updated¶
[Required] Gets the time_updated of this AuditTrailSummary. The date and time the audit trail was updated, in the format defined by RFC3339.
- Returns
The time_updated of this AuditTrailSummary.
- Return type
datetime
- property trail_location¶
Gets the trail_location of this AuditTrailSummary. An audit trail location represents the source of audit records that provides documentary evidence of the sequence of activities in the target database.
- Returns
The trail_location of this AuditTrailSummary.
- Return type
str