Class ListStreamPoolsRequest
Implements
Inherited Members
Namespace: Oci.StreamingService.Requests
Assembly: OCI.DotNetSDK.Streaming.dll
Syntax
public class ListStreamPoolsRequest : IOciRequest
Examples
Click here to see an example of how to use ListStreamPools request.
Properties
CompartmentId
Declaration
[Required(ErrorMessage = "CompartmentId is required.")]
[HttpConverter(TargetEnum.Query, "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type | Description |
---|---|
string | The OCID of the compartment. |
Remarks
Required
Id
Declaration
[HttpConverter(TargetEnum.Query, "id")]
public string Id { get; set; }
Property Value
Type | Description |
---|---|
string | A filter to return only resources that match the given ID exactly. |
LifecycleState
Declaration
[HttpConverter(TargetEnum.Query, "lifecycleState")]
public StreamPoolSummary.LifecycleStateEnum? LifecycleState { get; set; }
Property Value
Type | Description |
---|---|
StreamPoolSummary.LifecycleStateEnum? | A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. |
Limit
Declaration
[HttpConverter(TargetEnum.Query, "limit")]
public int? Limit { get; set; }
Property Value
Type | Description |
---|---|
int? | The maximum number of items to return. The value must be between 1 and 50. The default is 10. |
Name
Declaration
[HttpConverter(TargetEnum.Query, "name")]
public string Name { get; set; }
Property Value
Type | Description |
---|---|
string | A filter to return only resources that match the given name exactly. |
OpcRequestId
Declaration
[HttpConverter(TargetEnum.Header, "opc-request-id")]
public string OpcRequestId { get; set; }
Property Value
Type | Description |
---|---|
string | The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
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 ListStreamPoolsRequest.SortByEnum? SortBy { get; set; }
Property Value
Type | Description |
---|---|
ListStreamPoolsRequest.SortByEnum? | The field to sort by. You can provide no more than one sort order. By default, |
SortOrder
Declaration
[HttpConverter(TargetEnum.Query, "sortOrder")]
public ListStreamPoolsRequest.SortOrderEnum? SortOrder { get; set; }
Property Value
Type | Description |
---|---|
ListStreamPoolsRequest.SortOrderEnum? | The sort order to use, either 'asc' or 'desc'. |