com.oracle.bmc.loadbalancer.requests

Class ListLoadBalancersRequest

java.lang.Object

com.oracle.bmc.requests.BmcRequest

com.oracle.bmc.loadbalancer.requests.ListLoadBalancersRequest

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20170115")
public class ListLoadBalancersRequest
extends BmcRequest

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListLoadBalancersRequest.Builder
static class	ListLoadBalancersRequest.SortBy The field to sort by.
static class	ListLoadBalancersRequest.SortOrder The sort order to use, either ascending (ASC) or descending (DESC).

Method Summary

Modifier and Type	Method and Description
static ListLoadBalancersRequest.Builder	builder()
String	getCompartmentId() The OCID of the compartment containing the load balancers to list.
String	getDetail() The level of detail to return for each result.
String	getDisplayName() A filter to return only resources that match the given display name exactly.
LoadBalancer.LifecycleState	getLifecycleState() A filter to return only resources that match the given lifecycle state.
Long	getLimit() For list pagination.
String	getOpcRequestId() The unique Oracle-assigned identifier for the request.
String	getPage() For list pagination.
ListLoadBalancersRequest.SortBy	getSortBy() The field to sort by.
ListLoadBalancersRequest.SortOrder	getSortOrder() The sort order to use, either ascending (ASC) or descending (DESC).

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

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

getCompartmentId

public String getCompartmentId()

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

getOpcRequestId

public String getOpcRequestId()

The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

getLimit

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

Example: 3

getDetail

public String getDetail()

The level of detail to return for each result. Can be full or simple.

Example: full

getSortBy

public ListLoadBalancersRequest.SortBy getSortBy()

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.

getSortOrder

public ListLoadBalancersRequest.SortOrder getSortOrder()

The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive.

getDisplayName

public String getDisplayName()

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

Example: example_load_balancer

getLifecycleState

public LoadBalancer.LifecycleState getLifecycleState()

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

Example: SUCCEEDED