com.oracle.bmc.core.requests

Class ListPublicIpsRequest

java.lang.Object

com.oracle.bmc.requests.BmcRequest<Void>

com.oracle.bmc.core.requests.ListPublicIpsRequest

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20160918")
public class ListPublicIpsRequest
extends BmcRequest<Void>

Example: Click here to see how to use ListPublicIpsRequest.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListPublicIpsRequest.Builder
static class	ListPublicIpsRequest.Lifetime A filter to return only public IPs that match given lifetime.
static class	ListPublicIpsRequest.Scope Whether the public IP is regional or specific to a particular availability domain.

Method Summary

Modifier and Type	Method and Description
static ListPublicIpsRequest.Builder	builder()
String	getAvailabilityDomain() The name of the availability domain.
String	getCompartmentId() The OCID of the compartment.
ListPublicIpsRequest.Lifetime	getLifetime() A filter to return only public IPs that match given lifetime.
Integer	getLimit() For list pagination.
String	getPage() For list pagination.
String	getPublicIpPoolId() A filter to return only resources that belong to the given public IP pool.
ListPublicIpsRequest.Scope	getScope() Whether the public IP is regional or specific to a particular availability domain.

Methods inherited from class com.oracle.bmc.requests.BmcRequest

getBody$, getInvocationCallback, getRetryConfiguration, setInvocationCallback, setRetryConfiguration

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static ListPublicIpsRequest.Builder builder()

getScope

public ListPublicIpsRequest.Scope getScope()

Whether the public IP is regional or specific to a particular availability domain.

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

`AVAILABILITY_DOMAIN`: The public IP exists within the availability domain of the entity it's assigned to, which is specified by the `availabilityDomain` property of the public IP object. Ephemeral public IPs that are assigned to private IPs have `scope` = `AVAILABILITY_DOMAIN`.

getCompartmentId

public String getCompartmentId()

The OCID of the compartment.

getLimit

public Integer getLimit()

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.

Example: `50`

getPage

public String getPage()

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

getAvailabilityDomain

public String getAvailabilityDomain()

The name of the availability domain.

Example: `Uocm:PHX-AD-1`

getLifetime

public ListPublicIpsRequest.Lifetime getLifetime()

A filter to return only public IPs that match given lifetime.

getPublicIpPoolId

public String getPublicIpPoolId()

A filter to return only resources that belong to the given public IP pool.