com.oracle.bmc.oda.requests

Class ListOdaInstancesRequest

java.lang.Object

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

com.oracle.bmc.oda.requests.ListOdaInstancesRequest

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

Example: Click here to see how to use ListOdaInstancesRequest.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListOdaInstancesRequest.Builder
static class	ListOdaInstancesRequest.LifecycleState List only the Digital Assistant instances that are in this lifecycle state.
static class	ListOdaInstancesRequest.SortBy Sort on this field.
static class	ListOdaInstancesRequest.SortOrder Sort the results in this order, use either ASC (ascending) or DESC (descending).

Method Summary

Modifier and Type	Method and Description
static ListOdaInstancesRequest.Builder	builder()
String	getCompartmentId() List the Digital Assistant instances that belong to this compartment.
String	getDisplayName() List only the information for the Digital Assistant instance with this user-friendly name.
ListOdaInstancesRequest.LifecycleState	getLifecycleState() List only the Digital Assistant instances that are in this lifecycle state.
Integer	getLimit() The maximum number of items to return per page.
String	getOpcRequestId() The client request ID for tracing.
String	getPage() The page at which to start retrieving results.
ListOdaInstancesRequest.SortBy	getSortBy() Sort on this field.
ListOdaInstancesRequest.SortOrder	getSortOrder() Sort the results in this order, use either ASC (ascending) or DESC (descending).

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

getCompartmentId

public String getCompartmentId()

List the Digital Assistant instances that belong to this compartment.

getDisplayName

public String getDisplayName()

List only the information for the Digital Assistant instance with this user-friendly name. These names don’t have to be unique and may change.

Example: `My new resource`

getLifecycleState

public ListOdaInstancesRequest.LifecycleState getLifecycleState()

List only the Digital Assistant instances that are in this lifecycle state.

getLimit

public Integer getLimit()

The maximum number of items to return per page.

getPage

public String getPage()

The page at which to start retrieving results.

You get this value from the `opc-next-page` header in a previous list request. To retireve the first page, omit this query parameter.

Example: `MToxMA==`

getSortOrder

public ListOdaInstancesRequest.SortOrder getSortOrder()

Sort the results in this order, use either ASC (ascending) or DESC (descending).

getSortBy

public ListOdaInstancesRequest.SortBy getSortBy()

Sort on this field. You can specify one sort order only. The default sort field is TIMECREATED.

The default sort order for `TIMECREATED` is descending, and the default sort order for `DISPLAYNAME` is ascending.

getOpcRequestId

public String getOpcRequestId()

The client request ID for tracing. This value is included in the opc-request-id response header.