/** * * * OpenAPI spec version: 20181201 * * * NOTE: This class is auto generated by OracleSDKGenerator. * Do not edit the class manually. * * Copyright (c) 2020, 2026, Oracle and/or its affiliates. All rights reserved. * This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. */ import common = require("oci-common"); /** * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/datasafe/ListAlerts.ts.html |here} to see how to use ListAlertsRequest. */ export interface ListAlertsRequest extends common.BaseRequest { /** * A filter to return only resources that match the specified compartment OCID. */ "compartmentId": string; /** * A filter to return alert by it's OCID. */ "id"?: string; /** * 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. * */ "compartmentIdInSubtree"?: boolean; /** * 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](https://docs.oracle.com/iaas/en-us/iaas/Content/API/Concepts/usingapi.htm#nine). */ "limit"?: number; /** * 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](https://docs.oracle.com/iaas/en-us/iaas/Content/API/Concepts/usingapi.htm#nine). */ "page"?: string; /** * Unique identifier for the request. */ "opcRequestId"?: string; /** * 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. * */ "accessLevel"?: ListAlertsRequest.AccessLevel; /** * The sort order to use, either ascending (ASC) or descending (DESC). */ "sortOrder"?: ListAlertsRequest.SortOrder; /** * 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. * */ "sortBy"?: ListAlertsRequest.SortBy; /** * 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](https://tools.ietf.org/html/draft-ietf-scim-api-12). 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.000Z\") and (targetNames eq \"target_1\") * query=(featureDetails.userName eq \"user\") and (targetNames eq \"target_1\") * Supported fields: * severity * status * alertType * targetIds * targetNames * operationTime * lifecycleState * displayName * timeCreated * timeUpdated * featureDetails.* (* 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) * */ "scimQuery"?: string; /** * Specifies a subset of fields to be returned in the response. */ "field"?: Array; } export declare namespace ListAlertsRequest { enum AccessLevel { Restricted = "RESTRICTED", Accessible = "ACCESSIBLE" } enum SortOrder { Asc = "ASC", Desc = "DESC" } enum SortBy { DisplayName = "displayName", TimeCreated = "timeCreated" } enum Field { Id = "id", DisplayName = "displayName", AlertType = "alertType", TargetIds = "targetIds", TargetNames = "targetNames", Severity = "severity", Status = "status", OperationTime = "operationTime", Operation = "operation", OperationStatus = "operationStatus", TimeCreated = "timeCreated", TimeUpdated = "timeUpdated", PolicyId = "policyId", LifecycleState = "lifecycleState" } }