Class ListChannelsRequest
Implements
Inherited Members
Namespace: Oci.OdaService.Requests
Assembly: OCI.DotNetSDK.Oda.dll
Syntax
public class ListChannelsRequest : IOciRequest
Examples
Click here to see an example of how to use ListChannels request.
Properties
Category
Declaration
[HttpConverter(TargetEnum.Query, "category")]
public ChannelCategory? Category { get; set; }
Property Value
Type | Description |
---|---|
ChannelCategory? | List only Channels with this category. |
Id
Declaration
[HttpConverter(TargetEnum.Query, "id")]
public string Id { get; set; }
Property Value
Type | Description |
---|---|
string | Unique Channel identifier. |
LifecycleState
Declaration
[HttpConverter(TargetEnum.Query, "lifecycleState")]
public LifecycleState? LifecycleState { get; set; }
Property Value
Type | Description |
---|---|
LifecycleState? | List only the resources that are in this lifecycle state. |
Limit
Declaration
[HttpConverter(TargetEnum.Query, "limit")]
public int? Limit { get; set; }
Property Value
Type | Description |
---|---|
int? | The maximum number of items to return per page. |
Name
Declaration
[HttpConverter(TargetEnum.Query, "name")]
public string Name { get; set; }
Property Value
Type | Description |
---|---|
string | List only the information for Channels with this name. Channels names are unique and may not change.
|
OdaInstanceId
Declaration
[Required(ErrorMessage = "OdaInstanceId is required.")]
[HttpConverter(TargetEnum.Path, "odaInstanceId")]
public string OdaInstanceId { get; set; }
Property Value
Type | Description |
---|---|
string | Unique Digital Assistant instance identifier. |
Remarks
Required
OpcRequestId
Declaration
[HttpConverter(TargetEnum.Header, "opc-request-id")]
public string OpcRequestId { get; set; }
Property Value
Type | Description |
---|---|
string | The client request ID for tracing. This value is included in the opc-request-id response header. |
Page
Declaration
[HttpConverter(TargetEnum.Query, "page")]
public string Page { get; set; }
Property Value
Type | Description |
---|---|
string | The page at which to start retrieving results.
|
SortBy
Declaration
[HttpConverter(TargetEnum.Query, "sortBy")]
public ListChannelsRequest.SortByEnum? SortBy { get; set; }
Property Value
Type | Description |
---|---|
ListChannelsRequest.SortByEnum? | Sort on this field. You can specify one sort order only. The default sort field is |
SortOrder
Declaration
[HttpConverter(TargetEnum.Query, "sortOrder")]
public ListChannelsRequest.SortOrderEnum? SortOrder { get; set; }
Property Value
Type | Description |
---|---|
ListChannelsRequest.SortOrderEnum? | Sort the results in this order, use either |
Type
Declaration
[HttpConverter(TargetEnum.Query, "type")]
public ChannelType? Type { get; set; }
Property Value
Type | Description |
---|---|
ChannelType? | List only Channels of this type. |