Class ListAuditProfilesRequest

Inheritance

object

ListAuditProfilesRequest

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 ListAuditProfilesRequest : IOciRequest

Examples

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

Properties

AccessLevel

Declaration

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

Property Value

Type	Description
ListAuditProfilesRequest.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.

AuditCollectedVolumeGreaterThanOrEqualTo

Declaration

[HttpConverter(TargetEnum.Query, "auditCollectedVolumeGreaterThanOrEqualTo")]
public long? AuditCollectedVolumeGreaterThanOrEqualTo { get; set; }

Property Value

Type	Description
long?	A filter to return only items that have count of audit records collected greater than or equal to the specified value.

AuditProfileId

Declaration

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

Property Value

Type	Description
string	A optional filter to return only resources that match the specified id.

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.

IsOverrideGlobalRetentionSetting

Declaration

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

Property Value

Type	Description
bool?	A optional filter to return only resources that match the specified retention configured value.

IsPaidUsageEnabled

Declaration

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

Property Value

Type	Description
bool?	Indicates if you want to continue audit record collection beyond the free limit of one million audit records per month per target database, incurring additional charges. The default value is inherited from the global settings. You can change at the global level or at the target level.

LifecycleState

Declaration

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

Property Value

Type	Description
AuditProfileLifecycleState?	A optional filter to return only resources that match 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 ListAuditProfilesRequest.SortByEnum? SortBy { get; set; }

Property Value

Type	Description
ListAuditProfilesRequest.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 ListAuditProfilesRequest.SortOrderEnum? SortOrder { get; set; }

Property Value

Type	Description
ListAuditProfilesRequest.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	A filter to return only items related to a specific target OCID.

Implements

IOciRequest