Package com.oracle.bmc.loadbalancer.requests

Class ListLoadBalancersRequest.Builder

java.lang.Object

com.oracle.bmc.loadbalancer.requests.ListLoadBalancersRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListLoadBalancersRequest,Void>

Enclosing class:

ListLoadBalancersRequest

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

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 ListLoadBalancersRequest.Builder compartmentId(String compartmentId)

The OCID of the compartment containing the load balancers to list.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

opcRequestId

public ListLoadBalancersRequest.Builder opcRequestId(String opcRequestId)

The unique Oracle-assigned identifier for the request.

If you need to contact Oracle about a particular request, please provide the request ID.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

limit

public ListLoadBalancersRequest.Builder limit(Long 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 ListLoadBalancersRequest.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.

Example: 3

Parameters:

page - the value to set

Returns:

this builder instance

detail

public ListLoadBalancersRequest.Builder detail(String detail)

The level of detail to return for each result.

Can be full or simple.

Example: full

Parameters:

detail - the value to set

Returns:

this builder instance

sortBy

public ListLoadBalancersRequest.Builder sortBy(ListLoadBalancersRequest.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.

Parameters:

sortBy - the value to set

Returns:

this builder instance

sortOrder

public ListLoadBalancersRequest.Builder sortOrder(ListLoadBalancersRequest.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

displayName

public ListLoadBalancersRequest.Builder displayName(String displayName)

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

Example: example_load_balancer

Parameters:

displayName - the value to set

Returns:

this builder instance

lifecycleState

public ListLoadBalancersRequest.Builder lifecycleState(LoadBalancer.LifecycleState lifecycleState)

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

Example: SUCCEEDED

Parameters:

lifecycleState - the value to set

Returns:

this builder instance

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<ListLoadBalancersRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListLoadBalancersRequest build()

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

Returns:

instance of ListLoadBalancersRequest

buildWithoutInvocationCallback

public ListLoadBalancersRequest buildWithoutInvocationCallback()

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