/** * * * OpenAPI spec version: 20200630 * * * 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 * as model from "../model"; import common = require("oci-common"); /** * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/apmsynthetics/ListMonitors.ts.html |here} to see how to use ListMonitorsRequest. */ export interface ListMonitorsRequest extends common.BaseRequest { /** * The APM domain ID the request is intended for. * */ "apmDomainId": string; /** * A filter to return only the resources that match the entire display name. */ "displayName"?: string; /** * A filter to return only monitors using scriptId. */ "scriptId"?: string; /** * The name of the public or dedicated vantage point. * */ "vantagePoint"?: string; /** * A filter to return only monitors that match the given monitor type. * Supported values are SCRIPTED_BROWSER, BROWSER, SCRIPTED_REST, REST, NETWORK, DNS, FTP and SQL. * */ "monitorType"?: string; /** * A filter to return only monitors that match the status given. */ "status"?: model.MonitorStatus; /** * The maximum number of items to return. */ "limit"?: number; /** * The maximum number of results per page, or items to return in a paginated * \"List\" call. For information on how pagination works, see * [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). *

Example: {@code 50} * */ "page"?: string; /** * A filter to return the monitors whose maintenance window is currently active. */ "isMaintenanceWindowActive"?: boolean; /** * A filter to return the monitors whose maintenance window is set. */ "isMaintenanceWindowSet"?: boolean; /** * The sort order to use, either ascending ({@code ASC}) or descending ({@code DESC}). Default sort order is ascending. * */ "sortOrder"?: model.SortOrders; /** * The field to sort by. Only one sort order may be provided. * Default order of displayName is ascending. * Default order of timeCreated and timeUpdated is descending. * The displayName sort by is case insensitive. * */ "sortBy"?: ListMonitorsRequest.SortBy; /** * Unique identifier for the request. * If you need to contact Oracle about a particular request, please provide the request ID. * */ "opcRequestId"?: string; } export declare namespace ListMonitorsRequest { enum SortBy { DisplayName = "displayName", TimeCreated = "timeCreated", TimeUpdated = "timeUpdated", Status = "status", MonitorType = "monitorType", MaintenanceWindowTimeStarted = "maintenanceWindowTimeStarted" } }