com.oracle.bmc.bds.requests

Class ListBdsInstancesRequest

java.lang.Object

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

com.oracle.bmc.bds.requests.ListBdsInstancesRequest

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

Example: Click here to see how to use ListBdsInstancesRequest.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListBdsInstancesRequest.Builder
static class	ListBdsInstancesRequest.SortBy The field to sort by.

Method Summary

Modifier and Type	Method and Description
static ListBdsInstancesRequest.Builder	builder()
String	getCompartmentId() The OCID of the compartment.
String	getDisplayName() A filter to return only resources that match the entire display name given.
BdsInstance.LifecycleState	getLifecycleState() The state of the BDS instance.
Integer	getLimit() The maximum number of items to return.
String	getOpcRequestId() The client request ID for tracing.
String	getPage() The page token representing the page at which to start retrieving results.
ListBdsInstancesRequest.SortBy	getSortBy() The field to sort by.
SortOrders	getSortOrder() The sort order to use, either ‘asc’ or ‘desc’.

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

getCompartmentId

public String getCompartmentId()

The OCID of the compartment.

getLifecycleState

public BdsInstance.LifecycleState getLifecycleState()

The state of the BDS instance.

getPage

public String getPage()

The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

getLimit

public Integer getLimit()

The maximum number of items to return.

getSortBy

public ListBdsInstancesRequest.SortBy getSortBy()

The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.

getSortOrder

public SortOrders getSortOrder()

The sort order to use, either ‘asc’ or ‘desc’.

getDisplayName

public String getDisplayName()

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

getOpcRequestId

public String getOpcRequestId()

The client request ID for tracing.