Show / Hide Table of Contents

Class ListSightingsRequest

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

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

Properties

AccessLevel

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

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.

ProblemId

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

OCID of the problem.

ResourceProfileId

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

OCID of the resource profile.

SortBy

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

The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. 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

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