Class ListAlertsRequest

Inheritance

object

ListAlertsRequest

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

Examples

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

Properties

AccessLevel

Declaration

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

Property Value

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

Field

Declaration

[HttpConverter(TargetEnum.Query, "field", CollectionFormatType.Multi)]
public List<ListAlertsRequest.FieldEnum> Field { get; set; }

Property Value

Type	Description
List<ListAlertsRequest.FieldEnum>	Specifies a subset of fields to be returned in the response.

Id

Declaration

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

Property Value

Type	Description
string	A filter to return alert by it's OCID.

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.

ScimQuery

Declaration

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

Property Value

Type

Description

string

The scimQuery query parameter accepts filter expressions that use the syntax described in Section 3.2.2.2 of the System for Cross-Domain Identity Management (SCIM) specification, which is available at RFC3339. In SCIM filtering expressions, text, date, and time values must be enclosed in quotation marks, with date and time values using ISO-8601 format. (Numeric and boolean values should not be quoted.) Example: ** |query=(timeCreated ge '2021-06-04T01-00-26') and (targetNames eq 'target_1')query=(featureDetails.userName eq "user") and (targetNames eq "target_1")Supported fields:severitystatusalertTypetargetIdstargetNamesoperationTimelifecycleStatedisplayNametimeCreatedtimeUpdatedfeatureDetails. ( can be any field in nestedStrMap in Feature Attributes in Alert Summary. For example - userName,object,clientHostname,osUserName,clientIPs,clientId,commandText,commandParam,clientProgram,objectType,targetOwner)

SortBy

Declaration

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

Property Value

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

Property Value

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

Implements

IOciRequest