Show / Hide Table of Contents

Class ListProblemsRequest

Inheritance
object
ListProblemsRequest
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 ListProblemsRequest : IOciRequest
Examples

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

Properties

AccessLevel

Declaration
[HttpConverter(TargetEnum.Query, "accessLevel")]
public ListProblemsRequest.AccessLevelEnum? AccessLevel { get; set; }
Property Value
Type Description
ListProblemsRequest.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.

City

Declaration
[HttpConverter(TargetEnum.Query, "city")]
public string City { get; set; }
Property Value
Type Description
string

City of the problem.

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.

Country

Declaration
[HttpConverter(TargetEnum.Query, "country")]
public string Country { get; set; }
Property Value
Type Description
string

Country of the problem.

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.

Label

Declaration
[HttpConverter(TargetEnum.Query, "label")]
public string Label { get; set; }
Property Value
Type Description
string

User-defined label associated with the problem.

LifecycleDetail

Declaration
[HttpConverter(TargetEnum.Query, "lifecycleDetail")]
public ProblemLifecycleDetail? LifecycleDetail { get; set; }
Property Value
Type Description
ProblemLifecycleDetail?

The field life cycle state. Only one state can be provided. Default value for state is active.

LifecycleState

Declaration
[HttpConverter(TargetEnum.Query, "lifecycleState")]
public ProblemLifecycleState? LifecycleState { get; set; }
Property Value
Type Description
ProblemLifecycleState?

The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.

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.

ProblemCategory

Declaration
[HttpConverter(TargetEnum.Query, "problemCategory")]
public ProblemCategoryEnum? ProblemCategory { get; set; }
Property Value
Type Description
ProblemCategoryEnum?

Setting this to SECURITY_ZONE returns only security zone-related violations.

Region

Declaration
[HttpConverter(TargetEnum.Query, "region")]
public string Region { get; set; }
Property Value
Type Description
string

OCI monitoring region.

ResourceId

Declaration
[HttpConverter(TargetEnum.Query, "resourceId")]
public string ResourceId { get; set; }
Property Value
Type Description
string

The ID of the resource associated with the problem.

ResourceType

Declaration
[HttpConverter(TargetEnum.Query, "resourceType")]
public string ResourceType { get; set; }
Property Value
Type Description
string

Resource type associated with the resource.

RiskLevel

Declaration
[HttpConverter(TargetEnum.Query, "riskLevel")]
public string RiskLevel { get; set; }
Property Value
Type Description
string

Risk level of the problem.

SortBy

Declaration
[HttpConverter(TargetEnum.Query, "sortBy")]
public ListProblemsRequest.SortByEnum? SortBy { get; set; }
Property Value
Type Description
ListProblemsRequest.SortByEnum?

The field to sort by. Only one sort order may be provided. Default order for riskLevel, timeLastDetected and resourceName is descending. Default order for riskLevel and resourceName is ascending. If no value is specified timeLastDetected is default.

SortOrder

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

The sort order to use

State

Declaration
[HttpConverter(TargetEnum.Query, "state")]
public string State { get; set; }
Property Value
Type Description
string

State or province of the problem.

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.

TimeFirstDetectedGreaterThanOrEqualTo

Declaration
[HttpConverter(TargetEnum.Query, "timeFirstDetectedGreaterThanOrEqualTo")]
public DateTime? TimeFirstDetectedGreaterThanOrEqualTo { get; set; }
Property Value
Type Description
DateTime?

Start time for a filter. If start time is not specified, start time will be set to current time - 30 days.

TimeFirstDetectedLessThanOrEqualTo

Declaration
[HttpConverter(TargetEnum.Query, "timeFirstDetectedLessThanOrEqualTo")]
public DateTime? TimeFirstDetectedLessThanOrEqualTo { get; set; }
Property Value
Type Description
DateTime?

End time for a filter. If end time is not specified, end time will be set to current time.

TimeLastDetectedGreaterThanOrEqualTo

Declaration
[HttpConverter(TargetEnum.Query, "timeLastDetectedGreaterThanOrEqualTo")]
public DateTime? TimeLastDetectedGreaterThanOrEqualTo { get; set; }
Property Value
Type Description
DateTime?

Start time for a filter. If start time is not specified, start time will be set to current time - 30 days.

TimeLastDetectedLessThanOrEqualTo

Declaration
[HttpConverter(TargetEnum.Query, "timeLastDetectedLessThanOrEqualTo")]
public DateTime? TimeLastDetectedLessThanOrEqualTo { get; set; }
Property Value
Type Description
DateTime?

End time for a filter. If end time is not specified, end time will be set to current time.

Implements

IOciRequest
In this article
Back to top