Class ListChannelsRequest

Inheritance

object

ListChannelsRequest

Implements

IOciRequest

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.MysqlService.Requests

Assembly: OCI.DotNetSDK.Mysql.dll

Syntax

public class ListChannelsRequest : IOciRequest

Examples

Click here to see an example of how to use ListChannels request.

Properties

ChannelId

Declaration

[HttpConverter(TargetEnum.Query, "channelId")]
public string ChannelId { get; set; }

Property Value

Type	Description
string	The OCID of the Channel.

CompartmentId

Declaration

[Required(ErrorMessage = "CompartmentId is required.")]
[HttpConverter(TargetEnum.Query, "compartmentId")]
public string CompartmentId { get; set; }

Property Value

Type	Description
string	The compartment OCID.

Remarks

Required

DbSystemId

Declaration

[HttpConverter(TargetEnum.Query, "dbSystemId")]
public string DbSystemId { get; set; }

Property Value

Type	Description
string	The DB System OCID.

DisplayName

Declaration

[HttpConverter(TargetEnum.Query, "displayName")]
public string DisplayName { get; set; }

Property Value

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

IsEnabled

Declaration

[HttpConverter(TargetEnum.Query, "isEnabled")]
public bool? IsEnabled { get; set; }

Property Value

Type	Description
bool?	If true, returns only Channels that are enabled. If false, returns only Channels that are disabled.

LifecycleState

Declaration

[HttpConverter(TargetEnum.Query, "lifecycleState")]
public Channel.LifecycleStateEnum? LifecycleState { get; set; }

Property Value

Type	Description
Channel.LifecycleStateEnum?	The LifecycleState of the Channel.

Limit

Declaration

[HttpConverter(TargetEnum.Query, "limit")]
public int? Limit { get; set; }

Property Value

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

OpcRequestId

Declaration

[HttpConverter(TargetEnum.Header, "opc-request-id")]
public string OpcRequestId { get; set; }

Property Value

Type	Description
string	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.

Page

Declaration

[HttpConverter(TargetEnum.Query, "page")]
public string Page { get; set; }

Property Value

Type	Description
string	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.

SortBy

Declaration

[HttpConverter(TargetEnum.Query, "sortBy")]
public ListChannelsRequest.SortByEnum? SortBy { get; set; }

Property Value

Type	Description
ListChannelsRequest.SortByEnum?	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.

SortOrder

Declaration

[HttpConverter(TargetEnum.Query, "sortOrder")]
public ListChannelsRequest.SortOrderEnum? SortOrder { get; set; }

Property Value

Type	Description
ListChannelsRequest.SortOrderEnum?	The sort order to use (ASC or DESC).

Implements

IOciRequest