public static class ListChannelsRequest.Builder extends Object implements BmcRequest.Builder<ListChannelsRequest,Void>
Modifier and Type | Method and Description |
---|---|
ListChannelsRequest |
build()
Build the instance of ListChannelsRequest as configured by this builder
|
ListChannelsRequest |
buildWithoutInvocationCallback() |
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(Consumer<javax.ws.rs.client.Invocation.Builder> 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).
|
String |
toString() |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
body$
public ListChannelsRequest.Builder invocationCallback(Consumer<javax.ws.rs.client.Invocation.Builder> invocationCallback)
Set the invocation callback for the request to be built.
invocationCallback
- the invocation callback to be set for the requestpublic ListChannelsRequest.Builder retryConfiguration(RetryConfiguration retryConfiguration)
Set the retry configuration for the request to be built.
retryConfiguration
- the retry configuration to be used for the requestpublic ListChannelsRequest.Builder copy(ListChannelsRequest o)
Copy method to populate the builder with values from the given instance.
copy
in interface BmcRequest.Builder<ListChannelsRequest,Void>
o
- other request from which to copy valuespublic ListChannelsRequest build()
Build the instance of ListChannelsRequest as configured by this builder
Note that this method takes calls to invocationCallback(com.oracle.bmc.util.internal.Consumer)
into account,
while the method buildWithoutInvocationCallback()
does not.
This is the preferred method to build an instance.
build
in interface BmcRequest.Builder<ListChannelsRequest,Void>
public ListChannelsRequest.Builder compartmentId(String compartmentId)
The compartment OCID.
this
.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.
this
.public ListChannelsRequest.Builder dbSystemId(String dbSystemId)
The DB System OCID.
this
.public ListChannelsRequest.Builder channelId(String channelId)
The OCID of the Channel.
this
.public ListChannelsRequest.Builder displayName(String displayName)
A filter to return only the resource matching the given display name exactly.
this
.public ListChannelsRequest.Builder lifecycleState(Channel.LifecycleState lifecycleState)
The LifecycleState of the Channel.
this
.public ListChannelsRequest.Builder isEnabled(Boolean isEnabled)
If true, returns only Channels that are enabled. If false, returns only Channels that are disabled.
this
.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.
this
.public ListChannelsRequest.Builder sortOrder(ListChannelsRequest.SortOrder sortOrder)
The sort order to use (ASC or DESC).
this
.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.
this
.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.
this
.public ListChannelsRequest buildWithoutInvocationCallback()
Copyright © 2016–2022. All rights reserved.