Class ListUnifiedAuditPolicyDefinitionsRequest

Inheritance

object

ListUnifiedAuditPolicyDefinitionsRequest

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

Examples

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

Properties

AccessLevel

Declaration

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

Property Value

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

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.

IsSeeded

Declaration

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

Property Value

Type	Description
bool?	A boolean flag indicating to list seeded unified audit policy definitions. Set this parameter to get list of seeded unified audit policy definitions.

LifecycleState

Declaration

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

Property Value

Type	Description
UnifiedAuditPolicyDefinitionLifecycleState?	The current state of the unified audit policy definition.

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 ListUnifiedAuditPolicyDefinitionsRequest.SortByEnum? SortBy { get; set; }

Property Value

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

Property Value

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

UnifiedAuditPolicyCategory

Declaration

[HttpConverter(TargetEnum.Query, "unifiedAuditPolicyCategory")]
public UnifiedAuditPolicyDefinition.AuditPolicyCategoryEnum? UnifiedAuditPolicyCategory { get; set; }

Property Value

Type	Description
UnifiedAuditPolicyDefinition.AuditPolicyCategoryEnum?	The category to which the unified audit policy definition belongs to.

UnifiedAuditPolicyDefinitionId

Declaration

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

Property Value

Type	Description
string	An optional filter to return only resources that match the specified OCID of the unified audit policy definition resource.

UnifiedAuditPolicyName

Declaration

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

Property Value

Type	Description
string	The name of the unified audit policy.

Implements

IOciRequest