Show / Hide Table of Contents

Class AuditArchiveRetrieval

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.

Inheritance
object
AuditArchiveRetrieval
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Oci.DatasafeService.Models
Assembly: OCI.DotNetSDK.Datasafe.dll
Syntax
public class AuditArchiveRetrieval

Properties

AuditEventCount

Declaration
[JsonProperty(PropertyName = "auditEventCount")]
public long? AuditEventCount { get; set; }
Property Value
Type Description
long?

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

CompartmentId

Declaration
[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type Description
string

The OCID of the compartment that contains archive retrieval.

Remarks

Required

DefinedTags

Declaration
[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }
Property Value
Type Description
Dictionary<string, Dictionary<string, object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations": {"CostCenter": "42"}}

Description

Declaration
[JsonProperty(PropertyName = "description")]
public string Description { get; set; }
Property Value
Type Description
string

Description of the archive retrieval.

DisplayName

Declaration
[Required(ErrorMessage = "DisplayName is required.")]
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }
Property Value
Type Description
string

The display name of the archive retrieval. The name does not have to be unique, and is changeable.

Remarks

Required

EndDate

Declaration
[Required(ErrorMessage = "EndDate is required.")]
[JsonProperty(PropertyName = "endDate")]
public DateTime? EndDate { get; set; }
Property Value
Type Description
DateTime?

End month of the archive retrieval, in the format defined by RFC3339.

Remarks

Required

ErrorInfo

Declaration
[JsonProperty(PropertyName = "errorInfo")]
public string ErrorInfo { get; set; }
Property Value
Type Description
string

The Error details of a failed archive retrieval.

FreeformTags

Declaration
[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }
Property Value
Type Description
Dictionary<string, string>

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"}

Id

Declaration
[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }
Property Value
Type Description
string

The OCID of the archive retrieval.

Remarks

Required

LifecycleDetails

Declaration
[JsonProperty(PropertyName = "lifecycleDetails")]
public string LifecycleDetails { get; set; }
Property Value
Type Description
string

Details about the current state of the archive retrieval.

LifecycleState

Declaration
[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public AuditArchiveRetrievalLifecycleState? LifecycleState { get; set; }
Property Value
Type Description
AuditArchiveRetrievalLifecycleState?

The current state of the archive retrieval.

Remarks

Required

StartDate

Declaration
[Required(ErrorMessage = "StartDate is required.")]
[JsonProperty(PropertyName = "startDate")]
public DateTime? StartDate { get; set; }
Property Value
Type Description
DateTime?

Start month of the archive retrieval, in the format defined by RFC3339.

Remarks

Required

SystemTags

Declaration
[JsonProperty(PropertyName = "systemTags")]
public Dictionary<string, Dictionary<string, object>> SystemTags { get; set; }
Property Value
Type Description
Dictionary<string, Dictionary<string, object>>

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"}}

TargetId

Declaration
[Required(ErrorMessage = "TargetId is required.")]
[JsonProperty(PropertyName = "targetId")]
public string TargetId { get; set; }
Property Value
Type Description
string

The OCID of the target associated with the archive retrieval.

Remarks

Required

TimeCompleted

Declaration
[JsonProperty(PropertyName = "timeCompleted")]
public DateTime? TimeCompleted { get; set; }
Property Value
Type Description
DateTime?

The date time when archive retrieval request was fulfilled, in the format defined by RFC3339.

TimeOfExpiry

Declaration
[JsonProperty(PropertyName = "timeOfExpiry")]
public DateTime? TimeOfExpiry { get; set; }
Property Value
Type Description
DateTime?

The date time when retrieved archive data will be deleted from Data Safe and unloaded back into archival.

TimeRequested

Declaration
[JsonProperty(PropertyName = "timeRequested")]
public DateTime? TimeRequested { get; set; }
Property Value
Type Description
DateTime?

The date time when archive retrieval was requested, in the format defined by RFC3339.

In this article
Back to top