AuditArchiveRetrieval

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

Bases: object

Represents the archive retrieve request for the audit data. You can retrieve audit data for a target database from the archive and store it online. For more information, see Retrieve Audit Data for a Target Database from the Archive.

Attributes:

LIFECYCLE_STATE_ACTIVE

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

LIFECYCLE_STATE_CREATING

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

LIFECYCLE_STATE_DELETED

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

LIFECYCLE_STATE_DELETING

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

LIFECYCLE_STATE_FAILED

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

LIFECYCLE_STATE_NEEDS_ATTENTION

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

LIFECYCLE_STATE_UPDATING

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

audit_event_count

Gets the audit_event_count of this AuditArchiveRetrieval.

compartment_id

[Required] Gets the compartment_id of this AuditArchiveRetrieval.

defined_tags

Gets the defined_tags of this AuditArchiveRetrieval.

description

Gets the description of this AuditArchiveRetrieval.

display_name

[Required] Gets the display_name of this AuditArchiveRetrieval.

end_date

[Required] Gets the end_date of this AuditArchiveRetrieval.

error_info

Gets the error_info of this AuditArchiveRetrieval.

freeform_tags

Gets the freeform_tags of this AuditArchiveRetrieval.

id

[Required] Gets the id of this AuditArchiveRetrieval.

lifecycle_details

Gets the lifecycle_details of this AuditArchiveRetrieval.

lifecycle_state

[Required] Gets the lifecycle_state of this AuditArchiveRetrieval.

start_date

[Required] Gets the start_date of this AuditArchiveRetrieval.

system_tags

Gets the system_tags of this AuditArchiveRetrieval.

target_id

[Required] Gets the target_id of this AuditArchiveRetrieval.

time_completed

Gets the time_completed of this AuditArchiveRetrieval.

time_of_expiry

Gets the time_of_expiry of this AuditArchiveRetrieval.

time_requested

Gets the time_requested of this AuditArchiveRetrieval.

Methods:

__init__(**kwargs)

Initializes a new AuditArchiveRetrieval object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

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

LIFECYCLE_STATE_CREATING = 'CREATING'

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

LIFECYCLE_STATE_DELETED = 'DELETED'

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

LIFECYCLE_STATE_DELETING = 'DELETING'

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

LIFECYCLE_STATE_FAILED = 'FAILED'

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

LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'

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

__init__(**kwargs)

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

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

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

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

  • start_date (datetime) – The value to assign to the start_date property of this AuditArchiveRetrieval.

  • end_date (datetime) – The value to assign to the end_date property of this AuditArchiveRetrieval.

  • target_id (str) – The value to assign to the target_id property of this AuditArchiveRetrieval.

  • time_requested (datetime) – The value to assign to the time_requested property of this AuditArchiveRetrieval.

  • time_completed (datetime) – The value to assign to the time_completed property of this AuditArchiveRetrieval.

  • time_of_expiry (datetime) – The value to assign to the time_of_expiry property of this AuditArchiveRetrieval.

  • audit_event_count (int) – The value to assign to the audit_event_count property of this AuditArchiveRetrieval.

  • error_info (str) – The value to assign to the error_info property of this AuditArchiveRetrieval.

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this AuditArchiveRetrieval. Allowed values for this property are: “CREATING”, “ACTIVE”, “NEEDS_ATTENTION”, “FAILED”, “DELETING”, “DELETED”, “UPDATING”, ‘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 AuditArchiveRetrieval.

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

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

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

property audit_event_count

Gets the audit_event_count of this AuditArchiveRetrieval. Total count of audit events to be retrieved from the archive for the specified date range.

Returns

The audit_event_count of this AuditArchiveRetrieval.

Return type

int

property compartment_id

[Required] Gets the compartment_id of this AuditArchiveRetrieval. The OCID of the compartment that contains archive retrieval.

Returns

The compartment_id of this AuditArchiveRetrieval.

Return type

str

property defined_tags

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

Return type

dict(str, dict(str, object))

property description

Gets the description of this AuditArchiveRetrieval. Description of the archive retrieval.

Returns

The description of this AuditArchiveRetrieval.

Return type

str

property display_name

[Required] Gets the display_name of this AuditArchiveRetrieval. The display name of the archive retrieval. The name does not have to be unique, and is changeable.

Returns

The display_name of this AuditArchiveRetrieval.

Return type

str

property end_date

[Required] Gets the end_date of this AuditArchiveRetrieval. End month of the archive retrieval, in the format defined by RFC3339.

Returns

The end_date of this AuditArchiveRetrieval.

Return type

datetime

property error_info

Gets the error_info of this AuditArchiveRetrieval. The Error details of a failed archive retrieval.

Returns

The error_info of this AuditArchiveRetrieval.

Return type

str

property freeform_tags

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

Return type

dict(str, str)

property id

[Required] Gets the id of this AuditArchiveRetrieval. The OCID of the archive retrieval.

Returns

The id of this AuditArchiveRetrieval.

Return type

str

property lifecycle_details

Gets the lifecycle_details of this AuditArchiveRetrieval. Details about the current state of the archive retrieval.

Returns

The lifecycle_details of this AuditArchiveRetrieval.

Return type

str

property lifecycle_state

[Required] Gets the lifecycle_state of this AuditArchiveRetrieval. The current state of the archive retrieval.

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

Returns

The lifecycle_state of this AuditArchiveRetrieval.

Return type

str

property start_date

[Required] Gets the start_date of this AuditArchiveRetrieval. Start month of the archive retrieval, in the format defined by RFC3339.

Returns

The start_date of this AuditArchiveRetrieval.

Return type

datetime

property system_tags

Gets the system_tags of this AuditArchiveRetrieval. 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 AuditArchiveRetrieval.

Return type

dict(str, dict(str, object))

property target_id

[Required] Gets the target_id of this AuditArchiveRetrieval. The OCID of the target associated with the archive retrieval.

Returns

The target_id of this AuditArchiveRetrieval.

Return type

str

property time_completed

Gets the time_completed of this AuditArchiveRetrieval. The date time when archive retrieval request was fulfilled, in the format defined by RFC3339.

Returns

The time_completed of this AuditArchiveRetrieval.

Return type

datetime

property time_of_expiry

Gets the time_of_expiry of this AuditArchiveRetrieval. The date time when retrieved archive data will be deleted from Data Safe and unloaded back into archival.

Returns

The time_of_expiry of this AuditArchiveRetrieval.

Return type

datetime

property time_requested

Gets the time_requested of this AuditArchiveRetrieval. The date time when archive retrieval was requested, in the format defined by RFC3339.

Returns

The time_requested of this AuditArchiveRetrieval.

Return type

datetime