/** * * * OpenAPI spec version: 20160918 * * * 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/core/ListVtaps.ts.html |here} to see how to use ListVtapsRequest. */ export interface ListVtapsRequest extends common.BaseRequest { /** * The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ "compartmentId": string; /** * The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VCN. */ "vcnId"?: string; /** * The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VTAP source. */ "source"?: string; /** * The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VTAP target. */ "targetId"?: string; /** * The IP address of the VTAP target. */ "targetIp"?: string; /** * Indicates whether to list all VTAPs or only running VTAPs. *
* When {@code FALSE}, lists ALL running and stopped VTAPs. * * When {@code TRUE}, lists only running VTAPs (VTAPs where isVtapEnabled = {@code TRUE}). * */ "isVtapEnabled"?: boolean; /** * For list pagination. The maximum number of results per page, or items to return in a paginated * \"List\" call. For important details about how pagination works, see * [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). *
Example: {@code 50} * */ "limit"?: number; /** * For list pagination. The value of the {@code opc-next-page} response header from the previous \"List\" * call. For important details about how pagination works, see * [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). * */ "page"?: string; /** * Unique identifier for the request. * If you need to contact Oracle about a particular request, please provide the request ID. * */ "opcRequestId"?: string; /** * The field to sort by. You can provide one sort order ({@code sortOrder}). Default order for * TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME * sort order is case sensitive. *
**Note:** In general, some \"List\" operations (for example, {@code ListInstances}) let you * optionally filter by availability domain if the scope of the resource type is within a * single availability domain. If you call one of these \"List\" operations without specifying * an availability domain, the resources are grouped by availability domain, then sorted. * */ "sortBy"?: ListVtapsRequest.SortBy; /** * The sort order to use, either ascending ({@code ASC}) or descending ({@code DESC}). The DISPLAYNAME sort order * is case sensitive. * */ "sortOrder"?: ListVtapsRequest.SortOrder; /** * A filter to return only resources that match the given display name exactly. * */ "displayName"?: string; /** * A filter to return only resources that match the given VTAP administrative lifecycle state. * The state value is case-insensitive. * */ "lifecycleState"?: string; } export declare namespace ListVtapsRequest { enum SortBy { Timecreated = "TIMECREATED", Displayname = "DISPLAYNAME" } enum SortOrder { Asc = "ASC", Desc = "DESC" } }