/** * * * 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/ListPublicIps.ts.html |here} to see how to use ListPublicIpsRequest. */ export interface ListPublicIpsRequest extends common.BaseRequest { /** * Whether the public IP is regional or specific to a particular availability domain. *

* {@code REGION}: The public IP exists within a region and is assigned to a regional entity * (such as a {@link NatGateway}), or can be assigned to a private IP * in any availability domain in the region. Reserved public IPs have {@code scope} = {@code REGION}, as do * ephemeral public IPs assigned to a regional entity. *

* {@code AVAILABILITY_DOMAIN}: The public IP exists within the availability domain of the entity * it's assigned to, which is specified by the {@code availabilityDomain} property of the public IP object. * Ephemeral public IPs that are assigned to private IPs have {@code scope} = {@code AVAILABILITY_DOMAIN}. * */ "scope": ListPublicIpsRequest.Scope; /** * The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ "compartmentId": string; /** * 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; /** * The name of the availability domain. *

Example: {@code Uocm:PHX-AD-1} * */ "availabilityDomain"?: string; /** * A filter to return only public IPs that match given lifetime. * */ "lifetime"?: ListPublicIpsRequest.Lifetime; /** * A filter to return only resources that belong to the given public IP pool. * */ "publicIpPoolId"?: string; } export declare namespace ListPublicIpsRequest { enum Scope { Region = "REGION", AvailabilityDomain = "AVAILABILITY_DOMAIN" } enum Lifetime { Ephemeral = "EPHEMERAL", Reserved = "RESERVED" } }