com.oracle.bmc.mysql.requests

Class ListChannelsRequest

java.lang.Object

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

com.oracle.bmc.mysql.requests.ListChannelsRequest

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20190415")
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 The field to sort by.
static class	ListChannelsRequest.SortOrder The sort order to use (ASC or DESC).

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’.
String	getChannelId() The OCID of the Channel.
String	getCompartmentId() The compartment OCID.
String	getDbSystemId() The DB System OCID.
String	getDisplayName() A filter to return only the resource matching the given display name exactly.
Boolean	getIsEnabled() If true, returns only Channels that are enabled.
Channel.LifecycleState	getLifecycleState() The LifecycleState of the Channel.
Integer	getLimit() The maximum number of items to return in a paginated list call.
String	getOpcRequestId() Customer-defined unique identifier for the request.
String	getPage() The value of the opc-next-page or opc-prev-page response header from the previous list call.
ListChannelsRequest.SortBy	getSortBy() The field to sort by.
ListChannelsRequest.SortOrder	getSortOrder() The sort order to use (ASC or DESC).
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

getCompartmentId

public String getCompartmentId()

The compartment OCID.

getOpcRequestId

public String getOpcRequestId()

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.

getDbSystemId

public String getDbSystemId()

The DB System OCID.

getChannelId

public String getChannelId()

The OCID of the Channel.

getDisplayName

public String getDisplayName()

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

getLifecycleState

public Channel.LifecycleState getLifecycleState()

The LifecycleState of the Channel.

getIsEnabled

public Boolean getIsEnabled()

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

getSortBy

public ListChannelsRequest.SortBy getSortBy()

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.

getSortOrder

public ListChannelsRequest.SortOrder getSortOrder()

The sort order to use (ASC or DESC).

getLimit

public Integer getLimit()

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

getPage

public String getPage()

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.

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>