com.oracle.bmc.oda.requests

Class ListChannelsRequest

java.lang.Object

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

com.oracle.bmc.oda.requests.ListChannelsRequest

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

Example: Click here to see how to use ListChannelsRequest.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListChannelsRequest.Builder
static class	ListChannelsRequest.SortBy Sort on this field.
static class	ListChannelsRequest.SortOrder Sort the results in this order, use either ASC (ascending) or DESC (descending).

Constructor Summary

Constructors

Constructor and Description
ListChannelsRequest()

Method Summary

Modifier and Type	Method and Description
static ListChannelsRequest.Builder	builder() Return a new builder for this request object.
boolean	equals(Object o) Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.
ChannelCategory	getCategory() List only Channels with this category.
String	getId() Unique Channel identifier.
LifecycleState	getLifecycleState() List only the resources that are in this lifecycle state.
Integer	getLimit() The maximum number of items to return per page.
String	getName() List only the information for Channels with this name.
String	getOdaInstanceId() Unique Digital Assistant instance identifier.
String	getOpcRequestId() The client request ID for tracing.
String	getPage() The page at which to start retrieving results.
ListChannelsRequest.SortBy	getSortBy() Sort on this field.
ListChannelsRequest.SortOrder	getSortOrder() Sort the results in this order, use either ASC (ascending) or DESC (descending).
ChannelType	getType() List only Channels of this type.
int	hashCode() Uses getInvocationCallback and getRetryConfiguration to generate a hash.
ListChannelsRequest.Builder	toBuilder() Return an instance of ListChannelsRequest.Builder that allows you to modify request properties.
String	toString()

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

getBody$, getInvocationCallback, getRetryConfiguration, setInvocationCallback, setRetryConfiguration, supportsExpect100Continue

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListChannelsRequest

public ListChannelsRequest()

Method Detail

getOdaInstanceId

public String getOdaInstanceId()

Unique Digital Assistant instance identifier.

getId

public String getId()

Unique Channel identifier.

getName

public String getName()

List only the information for Channels with this name. Channels names are unique and may not change.

Example: MyChannel

getCategory

public ChannelCategory getCategory()

List only Channels with this category.

getType

public ChannelType getType()

List only Channels of this type.

getLifecycleState

public LifecycleState getLifecycleState()

List only the resources 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 ListChannelsRequest.SortOrder getSortOrder()

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

getSortBy

public ListChannelsRequest.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 and timeUpdated is descending, and the default sort order for name is ascending.

getOpcRequestId

public String getOpcRequestId()

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

toBuilder

public ListChannelsRequest.Builder toBuilder()

Return an instance of ListChannelsRequest.Builder that allows you to modify request properties.

Returns:

instance of ListChannelsRequest.Builder that allows you to modify request properties.

builder

public static ListChannelsRequest.Builder builder()

Return a new builder for this request object.

Returns:

builder for the request object

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Description copied from class: BmcRequest

Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.

Overrides:

equals in class BmcRequest<Void>

hashCode

public int hashCode()

Description copied from class: BmcRequest

Uses getInvocationCallback and getRetryConfiguration to generate a hash.

Overrides:

hashCode in class BmcRequest<Void>