Class ListFindingAnalyticsRequest
Implements
Inherited Members
Namespace: Oci.DatasafeService.Requests
Assembly: OCI.DotNetSDK.Datasafe.dll
Syntax
public class ListFindingAnalyticsRequest : IOciRequest
Examples
Click here to see an example of how to use ListFindingAnalytics request.
Properties
AccessLevel
Declaration
[HttpConverter(TargetEnum.Query, "accessLevel")]
public ListFindingAnalyticsRequest.AccessLevelEnum? AccessLevel { get; set; }
Property Value
Type | Description |
---|---|
ListFindingAnalyticsRequest.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. |
FindingKey
Declaration
[HttpConverter(TargetEnum.Query, "findingKey")]
public string FindingKey { get; set; }
Property Value
Type | Description |
---|---|
string | The unique key that identifies the finding. It is a string and unique within a security assessment. |
GroupBy
Declaration
[HttpConverter(TargetEnum.Query, "groupBy")]
public ListFindingAnalyticsRequest.GroupByEnum? GroupBy { get; set; }
Property Value
Type | Description |
---|---|
ListFindingAnalyticsRequest.GroupByEnum? | Attribute by which the finding analytics data should be grouped. |
IsTopFinding
Declaration
[HttpConverter(TargetEnum.Query, "isTopFinding")]
public bool? IsTopFinding { get; set; }
Property Value
Type | Description |
---|---|
bool? | A filter to return only the findings that are marked as top findings. |
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. |
Severity
Declaration
[HttpConverter(TargetEnum.Query, "severity")]
public ListFindingAnalyticsRequest.SeverityEnum? Severity { get; set; }
Property Value
Type | Description |
---|---|
ListFindingAnalyticsRequest.SeverityEnum? | A filter to return only findings of a particular risk level. |
TopFindingStatus
Declaration
[HttpConverter(TargetEnum.Query, "topFindingStatus")]
public FindingAnalyticsDimensions.TopFindingStatusEnum? TopFindingStatus { get; set; }
Property Value
Type | Description |
---|---|
FindingAnalyticsDimensions.TopFindingStatusEnum? | An optional filter to return only the top finding that match the specified status. |