AuditArchiveRetrievalSummary

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

Bases: object

Summary details of an archive retrieval.

Attributes

LIFECYCLE_STATE_ACTIVE A constant which can be used with the lifecycle_state property of a AuditArchiveRetrievalSummary.
LIFECYCLE_STATE_CREATING A constant which can be used with the lifecycle_state property of a AuditArchiveRetrievalSummary.
LIFECYCLE_STATE_DELETED A constant which can be used with the lifecycle_state property of a AuditArchiveRetrievalSummary.
LIFECYCLE_STATE_DELETING A constant which can be used with the lifecycle_state property of a AuditArchiveRetrievalSummary.
LIFECYCLE_STATE_FAILED A constant which can be used with the lifecycle_state property of a AuditArchiveRetrievalSummary.
LIFECYCLE_STATE_NEEDS_ATTENTION A constant which can be used with the lifecycle_state property of a AuditArchiveRetrievalSummary.
audit_event_count Gets the audit_event_count of this AuditArchiveRetrievalSummary.
compartment_id [Required] Gets the compartment_id of this AuditArchiveRetrievalSummary.
defined_tags Gets the defined_tags of this AuditArchiveRetrievalSummary.
description Gets the description of this AuditArchiveRetrievalSummary.
display_name [Required] Gets the display_name of this AuditArchiveRetrievalSummary.
end_date [Required] Gets the end_date of this AuditArchiveRetrievalSummary.
error_info Gets the error_info of this AuditArchiveRetrievalSummary.
freeform_tags Gets the freeform_tags of this AuditArchiveRetrievalSummary.
id [Required] Gets the id of this AuditArchiveRetrievalSummary.
lifecycle_details Gets the lifecycle_details of this AuditArchiveRetrievalSummary.
lifecycle_state [Required] Gets the lifecycle_state of this AuditArchiveRetrievalSummary.
start_date [Required] Gets the start_date of this AuditArchiveRetrievalSummary.
target_id [Required] Gets the target_id of this AuditArchiveRetrievalSummary.
time_completed Gets the time_completed of this AuditArchiveRetrievalSummary.
time_of_expiry Gets the time_of_expiry of this AuditArchiveRetrievalSummary.
time_requested Gets the time_requested of this AuditArchiveRetrievalSummary.

Methods

__init__(**kwargs) Initializes a new AuditArchiveRetrievalSummary object with values from keyword arguments.
LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

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

LIFECYCLE_STATE_CREATING = 'CREATING'

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

LIFECYCLE_STATE_DELETED = 'DELETED'

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

LIFECYCLE_STATE_DELETING = 'DELETING'

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

LIFECYCLE_STATE_FAILED = 'FAILED'

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

__init__(**kwargs)

Initializes a new AuditArchiveRetrievalSummary 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 AuditArchiveRetrievalSummary.
  • compartment_id (str) – The value to assign to the compartment_id property of this AuditArchiveRetrievalSummary.
  • display_name (str) – The value to assign to the display_name property of this AuditArchiveRetrievalSummary.
  • description (str) – The value to assign to the description property of this AuditArchiveRetrievalSummary.
  • start_date (datetime) – The value to assign to the start_date property of this AuditArchiveRetrievalSummary.
  • end_date (datetime) – The value to assign to the end_date property of this AuditArchiveRetrievalSummary.
  • target_id (str) – The value to assign to the target_id property of this AuditArchiveRetrievalSummary.
  • time_requested (datetime) – The value to assign to the time_requested property of this AuditArchiveRetrievalSummary.
  • time_completed (datetime) – The value to assign to the time_completed property of this AuditArchiveRetrievalSummary.
  • time_of_expiry (datetime) – The value to assign to the time_of_expiry property of this AuditArchiveRetrievalSummary.
  • audit_event_count (int) – The value to assign to the audit_event_count property of this AuditArchiveRetrievalSummary.
  • error_info (str) – The value to assign to the error_info property of this AuditArchiveRetrievalSummary.
  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this AuditArchiveRetrievalSummary. Allowed values for this property are: “CREATING”, “ACTIVE”, “NEEDS_ATTENTION”, “FAILED”, “DELETING”, “DELETED”, ‘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 AuditArchiveRetrievalSummary.
  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this AuditArchiveRetrievalSummary.
  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this AuditArchiveRetrievalSummary.
audit_event_count

Gets the audit_event_count of this AuditArchiveRetrievalSummary. Total retrieved archive records audit event count.

Returns:The audit_event_count of this AuditArchiveRetrievalSummary.
Return type:int
compartment_id

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

Returns:The compartment_id of this AuditArchiveRetrievalSummary.
Return type:str
defined_tags

Gets the defined_tags of this AuditArchiveRetrievalSummary. 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 AuditArchiveRetrievalSummary.
Return type:dict(str, dict(str, object))
description

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

Returns:The description of this AuditArchiveRetrievalSummary.
Return type:str
display_name

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

Returns:The display_name of this AuditArchiveRetrievalSummary.
Return type:str
end_date

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

Returns:The end_date of this AuditArchiveRetrievalSummary.
Return type:datetime
error_info

Gets the error_info of this AuditArchiveRetrievalSummary. Error details of failed archive retrieval.

Returns:The error_info of this AuditArchiveRetrievalSummary.
Return type:str
freeform_tags

Gets the freeform_tags of this AuditArchiveRetrievalSummary. 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 AuditArchiveRetrievalSummary.
Return type:dict(str, str)
id

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

Returns:The id of this AuditArchiveRetrievalSummary.
Return type:str
lifecycle_details

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

Returns:The lifecycle_details of this AuditArchiveRetrievalSummary.
Return type:str
lifecycle_state

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

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

Returns:The lifecycle_state of this AuditArchiveRetrievalSummary.
Return type:str
start_date

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

Returns:The start_date of this AuditArchiveRetrievalSummary.
Return type:datetime
target_id

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

Returns:The target_id of this AuditArchiveRetrievalSummary.
Return type:str
time_completed

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

Returns:The time_completed of this AuditArchiveRetrievalSummary.
Return type:datetime
time_of_expiry

Gets the time_of_expiry of this AuditArchiveRetrievalSummary. 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 AuditArchiveRetrievalSummary.
Return type:datetime
time_requested

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

Returns:The time_requested of this AuditArchiveRetrievalSummary.
Return type:datetime