Class ListResourcesRequest

Inheritance

object

ListResourcesRequest

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.CloudguardService.Requests

Assembly: OCI.DotNetSDK.Cloudguard.dll

Syntax

public class ListResourcesRequest : IOciRequest

Examples

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

Properties

AccessLevel

Declaration

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

Property Value

Type	Description
ListResourcesRequest.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	The OCID of the compartment in which to list resources.

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 depending on the setting of accessLevel.

CveId

Declaration

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

Property Value

Type	Description
string	CVE ID associated with the resource.

CvssScore

Declaration

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

Property Value

Type	Description
int?	Cvss score associated with the resource.

CvssScoreGreaterThan

Declaration

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

Property Value

Type	Description
int?	Cvss score greater than associated with the resource.

CvssScoreLessThan

Declaration

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

Property Value

Type	Description
int?	Cvss score less than associated with the resource.

DetectorRuleIdList

Declaration

[HttpConverter(TargetEnum.Query, "detectorRuleIdList", CollectionFormatType.Multi)]
public List<string> DetectorRuleIdList { get; set; }

Property Value

Type	Description
List<string>	Comma seperated list of detector rule IDs to be passed in to match against Problems.

DetectorType

Declaration

[HttpConverter(TargetEnum.Query, "detectorType")]
public DetectorEnum? DetectorType { get; set; }

Property Value

Type	Description
DetectorEnum?	The field to list the problems by detector type.

Limit

Declaration

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

Property Value

Type	Description
int?	The maximum number of items to return

OpcRequestId

Declaration

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

Property Value

Type	Description
string	The client request ID for tracing.

Page

Declaration

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

Property Value

Type	Description
string	The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

Region

Declaration

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

Property Value

Type	Description
string	OCI monitoring region.

RiskLevel

Declaration

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

Property Value

Type	Description
string	Risk level of the problem.

RiskLevelGreaterThan

Declaration

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

Property Value

Type	Description
string	To filter risk level greater than the one mentioned in query param

RiskLevelLessThan

Declaration

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

Property Value

Type	Description
string	To filter risk level less than the one mentioned in query param

SortBy

Declaration

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

Property Value

Type	Description
ListResourcesRequest.SortByEnum?	The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.

SortOrder

Declaration

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

Property Value

Type	Description
SortOrders?	The sort order to use

TargetId

Declaration

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

Property Value

Type	Description
string	The ID of the target in which to list resources.

Implements

IOciRequest