Package com.oracle.bmc.core.requests

Class ListNatGatewaysRequest.Builder

java.lang.Object

com.oracle.bmc.core.requests.ListNatGatewaysRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListNatGatewaysRequest,Void>

Enclosing class:

ListNatGatewaysRequest

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListNatGatewaysRequest	build()	Build the instance of ListNatGatewaysRequest as configured by this builder
ListNatGatewaysRequest	buildWithoutInvocationCallback()	Build the instance of ListNatGatewaysRequest as configured by this builder
ListNatGatewaysRequest.Builder	compartmentId(String compartmentId)	The OCID of the compartment.
ListNatGatewaysRequest.Builder	copy(ListNatGatewaysRequest o)	Copy method to populate the builder with values from the given instance.
ListNatGatewaysRequest.Builder	displayName(String displayName)	A filter to return only resources that match the given display name exactly.
ListNatGatewaysRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListNatGatewaysRequest.Builder	lifecycleState(NatGateway.LifecycleState lifecycleState)	A filter to return only resources that match the specified lifecycle state.
ListNatGatewaysRequest.Builder	limit(Integer limit)	For list pagination.
ListNatGatewaysRequest.Builder	page(String page)	For list pagination.
ListNatGatewaysRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListNatGatewaysRequest.Builder	sortBy(ListNatGatewaysRequest.SortBy sortBy)	The field to sort by.
ListNatGatewaysRequest.Builder	sortOrder(ListNatGatewaysRequest.SortOrder sortOrder)	The sort order to use, either ascending (ASC) or descending (DESC).
ListNatGatewaysRequest.Builder	vcnId(String vcnId)	The OCID of the VCN.

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

compartmentId

public ListNatGatewaysRequest.Builder compartmentId(String compartmentId)

The OCID of the compartment.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

vcnId

public ListNatGatewaysRequest.Builder vcnId(String vcnId)

The OCID of the VCN.

Parameters:

vcnId - the value to set

Returns:

this builder instance

limit

public ListNatGatewaysRequest.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 ListNatGatewaysRequest.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

displayName

public ListNatGatewaysRequest.Builder displayName(String displayName)

A filter to return only resources that match the given display name exactly.

Parameters:

displayName - the value to set

Returns:

this builder instance

sortBy

public ListNatGatewaysRequest.Builder sortBy(ListNatGatewaysRequest.SortBy sortBy)

The field to sort by.

You can provide one sort order (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, 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.

Parameters:

sortBy - the value to set

Returns:

this builder instance

sortOrder

public ListNatGatewaysRequest.Builder sortOrder(ListNatGatewaysRequest.SortOrder sortOrder)

The sort order to use, either ascending (ASC) or descending (DESC).

The DISPLAYNAME sort order is case sensitive.

Parameters:

sortOrder - the value to set

Returns:

this builder instance

lifecycleState

public ListNatGatewaysRequest.Builder lifecycleState(NatGateway.LifecycleState lifecycleState)

A filter to return only resources that match the specified lifecycle state.

The value is case insensitive.

Parameters:

lifecycleState - the value to set

Returns:

this builder instance

invocationCallback

public ListNatGatewaysRequest.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 ListNatGatewaysRequest.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 ListNatGatewaysRequest.Builder copy(ListNatGatewaysRequest o)

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

Specified by:

copy in interface BmcRequest.Builder<ListNatGatewaysRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListNatGatewaysRequest build()

Build the instance of ListNatGatewaysRequest 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<ListNatGatewaysRequest,Void>

Returns:

instance of ListNatGatewaysRequest

buildWithoutInvocationCallback

public ListNatGatewaysRequest buildWithoutInvocationCallback()

Build the instance of ListNatGatewaysRequest 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 ListNatGatewaysRequest