Package com.oracle.bmc.oda.requests

Class ListChannelsRequest.Builder

java.lang.Object

com.oracle.bmc.oda.requests.ListChannelsRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListChannelsRequest,Void>

Enclosing class:

ListChannelsRequest

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListChannelsRequest	build()	Build the instance of ListChannelsRequest as configured by this builder
ListChannelsRequest	buildWithoutInvocationCallback()	Build the instance of ListChannelsRequest as configured by this builder
ListChannelsRequest.Builder	category(ChannelCategory category)	List only Channels with this category.
ListChannelsRequest.Builder	copy(ListChannelsRequest o)	Copy method to populate the builder with values from the given instance.
ListChannelsRequest.Builder	id(String id)	Unique Channel identifier.
ListChannelsRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListChannelsRequest.Builder	lifecycleState(LifecycleState lifecycleState)	List only the resources that are in this lifecycle state.
ListChannelsRequest.Builder	limit(Integer limit)	The maximum number of items to return per page.
ListChannelsRequest.Builder	name(String name)	List only the information for Channels with this name.
ListChannelsRequest.Builder	odaInstanceId(String odaInstanceId)	Unique Digital Assistant instance identifier.
ListChannelsRequest.Builder	opcRequestId(String opcRequestId)	The client request ID for tracing.
ListChannelsRequest.Builder	page(String page)	The page at which to start retrieving results.
ListChannelsRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListChannelsRequest.Builder	sortBy(ListChannelsRequest.SortBy sortBy)	Sort on this field.
ListChannelsRequest.Builder	sortOrder(ListChannelsRequest.SortOrder sortOrder)	Sort the results in this order, use either ASC (ascending) or DESC (descending).
ListChannelsRequest.Builder	type(ChannelType type)	List only Channels of this type.

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

odaInstanceId

public ListChannelsRequest.Builder odaInstanceId(String odaInstanceId)

Unique Digital Assistant instance identifier.

Parameters:

odaInstanceId - the value to set

Returns:

this builder instance

id

public ListChannelsRequest.Builder id(String id)

Unique Channel identifier.

Parameters:

id - the value to set

Returns:

this builder instance

name

public ListChannelsRequest.Builder name(String name)

List only the information for Channels with this name.

Channels names are unique and may not change.

Example: MyChannel

Parameters:

name - the value to set

Returns:

this builder instance

category

public ListChannelsRequest.Builder category(ChannelCategory category)

List only Channels with this category.

Parameters:

category - the value to set

Returns:

this builder instance

type

public ListChannelsRequest.Builder type(ChannelType type)

List only Channels of this type.

Parameters:

type - the value to set

Returns:

this builder instance

lifecycleState

public ListChannelsRequest.Builder lifecycleState(LifecycleState lifecycleState)

List only the resources that are in this lifecycle state.

Parameters:

lifecycleState - the value to set

Returns:

this builder instance

limit

public ListChannelsRequest.Builder limit(Integer limit)

The maximum number of items to return per page.

Parameters:

limit - the value to set

Returns:

this builder instance

page

public ListChannelsRequest.Builder page(String page)

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==

Parameters:

page - the value to set

Returns:

this builder instance

sortOrder

public ListChannelsRequest.Builder sortOrder(ListChannelsRequest.SortOrder sortOrder)

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

Parameters:

sortOrder - the value to set

Returns:

this builder instance

sortBy

public ListChannelsRequest.Builder sortBy(ListChannelsRequest.SortBy sortBy)

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.

Parameters:

sortBy - the value to set

Returns:

this builder instance

opcRequestId

public ListChannelsRequest.Builder opcRequestId(String opcRequestId)

The client request ID for tracing.

This value is included in the opc-request-id response header.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<ListChannelsRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListChannelsRequest build()

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

Returns:

instance of ListChannelsRequest

buildWithoutInvocationCallback

public ListChannelsRequest buildWithoutInvocationCallback()

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