Package com.oracle.bmc.core.requests

Class ListPublicIpsRequest.Builder

java.lang.Object

com.oracle.bmc.core.requests.ListPublicIpsRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListPublicIpsRequest,Void>

Enclosing class:

ListPublicIpsRequest

public static class ListPublicIpsRequest.Builder
extends Object
implements BmcRequest.Builder<ListPublicIpsRequest,Void>

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListPublicIpsRequest.Builder	availabilityDomain(String availabilityDomain)	The name of the availability domain.
ListPublicIpsRequest	build()	Build the instance of ListPublicIpsRequest as configured by this builder
ListPublicIpsRequest	buildWithoutInvocationCallback()	Build the instance of ListPublicIpsRequest as configured by this builder
ListPublicIpsRequest.Builder	compartmentId(String compartmentId)	The OCID of the compartment.
ListPublicIpsRequest.Builder	copy(ListPublicIpsRequest o)	Copy method to populate the builder with values from the given instance.
ListPublicIpsRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListPublicIpsRequest.Builder	lifetime(ListPublicIpsRequest.Lifetime lifetime)	A filter to return only public IPs that match given lifetime.
ListPublicIpsRequest.Builder	limit(Integer limit)	For list pagination.
ListPublicIpsRequest.Builder	page(String page)	For list pagination.
ListPublicIpsRequest.Builder	publicIpPoolId(String publicIpPoolId)	A filter to return only resources that belong to the given public IP pool.
ListPublicIpsRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListPublicIpsRequest.Builder	scope(ListPublicIpsRequest.Scope scope)	Whether the public IP is regional or specific to a particular availability domain.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.oracle.bmc.requests.BmcRequest.Builder

body$

Constructor Detail

Builder

public Builder()

Method Detail

scope

public ListPublicIpsRequest.Builder scope(ListPublicIpsRequest.Scope scope)

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.

Parameters:

scope - the value to set

Returns:

this builder instance

compartmentId

public ListPublicIpsRequest.Builder compartmentId(String compartmentId)

The OCID of the compartment.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

limit

public ListPublicIpsRequest.Builder limit(Integer limit)

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

Parameters:

limit - the value to set

Returns:

this builder instance

page

public ListPublicIpsRequest.Builder page(String page)

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.

Parameters:

page - the value to set

Returns:

this builder instance

availabilityDomain

public ListPublicIpsRequest.Builder availabilityDomain(String availabilityDomain)

The name of the availability domain.

Example: Uocm:PHX-AD-1

Parameters:

availabilityDomain - the value to set

Returns:

this builder instance

lifetime

public ListPublicIpsRequest.Builder lifetime(ListPublicIpsRequest.Lifetime lifetime)

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

Parameters:

lifetime - the value to set

Returns:

this builder instance

publicIpPoolId

public ListPublicIpsRequest.Builder publicIpPoolId(String publicIpPoolId)

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

Parameters:

publicIpPoolId - the value to set

Returns:

this builder instance

invocationCallback

public ListPublicIpsRequest.Builder invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)

Set the invocation callback for the request to be built.

Parameters:

invocationCallback - the invocation callback to be set for the request

Returns:

this builder instance

retryConfiguration

public ListPublicIpsRequest.Builder retryConfiguration(RetryConfiguration retryConfiguration)

Set the retry configuration for the request to be built.

Parameters:

retryConfiguration - the retry configuration to be used for the request

Returns:

this builder instance

copy

public ListPublicIpsRequest.Builder copy(ListPublicIpsRequest o)

Copy method to populate the builder with values from the given instance.

Specified by:

copy in interface BmcRequest.Builder<ListPublicIpsRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListPublicIpsRequest build()

Build the instance of ListPublicIpsRequest as configured by this builder

Note that this method takes calls to invocationCallback(com.oracle.bmc.http.client.RequestInterceptor) into account, while the method buildWithoutInvocationCallback() does not.

This is the preferred method to build an instance.

Specified by:

build in interface BmcRequest.Builder<ListPublicIpsRequest,Void>

Returns:

instance of ListPublicIpsRequest

buildWithoutInvocationCallback

public ListPublicIpsRequest buildWithoutInvocationCallback()

Build the instance of ListPublicIpsRequest as configured by this builder

Note that this method does not take calls to invocationCallback(com.oracle.bmc.http.client.RequestInterceptor) into account, while the method build() does

Returns:

instance of ListPublicIpsRequest