Class ListAuditArchiveRetrievalsRequest

Inheritance

object

ListAuditArchiveRetrievalsRequest

Implements

IOciRequest

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.DatasafeService.Requests

Assembly: OCI.DotNetSDK.Datasafe.dll

Syntax

public class ListAuditArchiveRetrievalsRequest : IOciRequest

Examples

Click here to see an example of how to use ListAuditArchiveRetrievals request.

Properties

AccessLevel

Declaration

[HttpConverter(TargetEnum.Query, "accessLevel")]
public ListAuditArchiveRetrievalsRequest.AccessLevelEnum? AccessLevel { get; set; }

Property Value

Type	Description
ListAuditArchiveRetrievalsRequest.AccessLevelEnum?	Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.

AuditArchiveRetrievalId

Declaration

[HttpConverter(TargetEnum.Query, "auditArchiveRetrievalId")]
public string AuditArchiveRetrievalId { get; set; }

Property Value

Type	Description
string	OCID of the archive retrieval.

CompartmentId

Declaration

[Required(ErrorMessage = "CompartmentId is required.")]
[HttpConverter(TargetEnum.Query, "compartmentId")]
public string CompartmentId { get; set; }

Property Value

Type	Description
string	A filter to return only resources that match the specified compartment OCID.

Remarks

Required

CompartmentIdInSubtree

Declaration

[HttpConverter(TargetEnum.Query, "compartmentIdInSubtree")]
public bool? CompartmentIdInSubtree { get; set; }

Property Value

Type	Description
bool?	Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.

DisplayName

Declaration

[HttpConverter(TargetEnum.Query, "displayName")]
public string DisplayName { get; set; }

Property Value

Type	Description
string	A filter to return only resources that match the specified display name.

LifecycleState

Declaration

[HttpConverter(TargetEnum.Query, "lifecycleState")]
public AuditArchiveRetrievalLifecycleState? LifecycleState { get; set; }

Property Value

Type	Description
AuditArchiveRetrievalLifecycleState?	A filter to return only resources that matches the specified lifecycle state.

Limit

Declaration

[HttpConverter(TargetEnum.Query, "limit")]
public int? Limit { get; set; }

Property Value

Type	Description
int?	For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

OpcRequestId

Declaration

[HttpConverter(TargetEnum.Header, "opc-request-id")]
public string OpcRequestId { get; set; }

Property Value

Type	Description
string	Unique identifier for the request.

Page

Declaration

[HttpConverter(TargetEnum.Query, "page")]
public string Page { get; set; }

Property Value

Type	Description
string	For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

SortBy

Declaration

[HttpConverter(TargetEnum.Query, "sortBy")]
public ListAuditArchiveRetrievalsRequest.SortByEnum? SortBy { get; set; }

Property Value

Type	Description
ListAuditArchiveRetrievalsRequest.SortByEnum?	The field used for sorting. Only one sorting order (sortOrder) can be specified. The default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

SortOrder

Declaration

[HttpConverter(TargetEnum.Query, "sortOrder")]
public ListAuditArchiveRetrievalsRequest.SortOrderEnum? SortOrder { get; set; }

Property Value

Type	Description
ListAuditArchiveRetrievalsRequest.SortOrderEnum?	The sort order to use, either ascending (ASC) or descending (DESC).

TargetId

Declaration

[HttpConverter(TargetEnum.Query, "targetId")]
public string TargetId { get; set; }

Property Value

Type	Description
string	The OCID of the target associated with the archive retrieval.

TimeOfExpiry

Declaration

[HttpConverter(TargetEnum.Query, "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.

Implements

IOciRequest