com.oracle.bmc.mysql.requests

Class ListChannelsRequest.Builder

java.lang.Object

com.oracle.bmc.mysql.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 and Description
Builder()

Method Summary

Modifier and Type	Method and 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	channelId(String channelId) The OCID of the Channel.
ListChannelsRequest.Builder	compartmentId(String compartmentId) The compartment OCID.
ListChannelsRequest.Builder	copy(ListChannelsRequest o) Copy method to populate the builder with values from the given instance.
ListChannelsRequest.Builder	dbSystemId(String dbSystemId) The DB System OCID.
ListChannelsRequest.Builder	displayName(String displayName) A filter to return only the resource matching the given display name exactly.
ListChannelsRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback) Set the invocation callback for the request to be built.
ListChannelsRequest.Builder	isEnabled(Boolean isEnabled) If true, returns only Channels that are enabled.
ListChannelsRequest.Builder	lifecycleState(Channel.LifecycleState lifecycleState) The LifecycleState of the Channel.
ListChannelsRequest.Builder	limit(Integer limit) The maximum number of items to return in a paginated list call.
ListChannelsRequest.Builder	opcRequestId(String opcRequestId) Customer-defined unique identifier for the request.
ListChannelsRequest.Builder	page(String page) The value of the opc-next-page or opc-prev-page response header from the previous list call.
ListChannelsRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration) Set the retry configuration for the request to be built.
ListChannelsRequest.Builder	sortBy(ListChannelsRequest.SortBy sortBy) The field to sort by.
ListChannelsRequest.Builder	sortOrder(ListChannelsRequest.SortOrder sortOrder) The sort order to use (ASC or DESC).

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

compartmentId

public ListChannelsRequest.Builder compartmentId(String compartmentId)

The compartment OCID.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

opcRequestId

public ListChannelsRequest.Builder opcRequestId(String opcRequestId)

Customer-defined unique identifier for the request. If you need to contact Oracle about a specific request, please provide the request ID that you supplied in this header with the request.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

dbSystemId

public ListChannelsRequest.Builder dbSystemId(String dbSystemId)

The DB System OCID.

Parameters:

dbSystemId - the value to set

Returns:

this builder instance

channelId

public ListChannelsRequest.Builder channelId(String channelId)

The OCID of the Channel.

Parameters:

channelId - the value to set

Returns:

this builder instance

displayName

public ListChannelsRequest.Builder displayName(String displayName)

A filter to return only the resource matching the given display name exactly.

Parameters:

displayName - the value to set

Returns:

this builder instance

lifecycleState

public ListChannelsRequest.Builder lifecycleState(Channel.LifecycleState lifecycleState)

The LifecycleState of the Channel.

Parameters:

lifecycleState - the value to set

Returns:

this builder instance

isEnabled

public ListChannelsRequest.Builder isEnabled(Boolean isEnabled)

If true, returns only Channels that are enabled. If false, returns only Channels that are disabled.

Parameters:

isEnabled - the value to set

Returns:

this builder instance

sortBy

public ListChannelsRequest.Builder sortBy(ListChannelsRequest.SortBy sortBy)

The field to sort by. Only one sort order may be provided. Time fields are default ordered as descending. Display name is default ordered as ascending.

Parameters:

sortBy - the value to set

Returns:

this builder instance

sortOrder

public ListChannelsRequest.Builder sortOrder(ListChannelsRequest.SortOrder sortOrder)

The sort order to use (ASC or DESC).

Parameters:

sortOrder - the value to set

Returns:

this builder instance

limit

public ListChannelsRequest.Builder limit(Integer limit)

The maximum number of items to return in a paginated list call. For information about pagination, see List Pagination.

Parameters:

limit - the value to set

Returns:

this builder instance

page

public ListChannelsRequest.Builder page(String page)

The value of the opc-next-page or opc-prev-page response header from the previous list call. For information about pagination, see List Pagination.

Parameters:

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