Class ListConsumerGroupsRequest

Inheritance

object

ListConsumerGroupsRequest

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.QueueService.Requests

Assembly: OCI.DotNetSDK.Queue.dll

Syntax

public class ListConsumerGroupsRequest : IOciRequest

Examples

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

Properties

DisplayName

Declaration

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

Property Value

Type	Description
string	A filter to return only resources that match the entire display name given.

Id

Declaration

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

Property Value

Type	Description
string	The unique consumer group identifier.

LifecycleState

Declaration

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

Property Value

Type	Description
ConsumerGroup.LifecycleStateEnum?	A filter to return only resources their lifecycleState matches the given lifecycleState.

Limit

Declaration

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

Property Value

Type	Description
int?	For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination.

OpcRequestId

Declaration

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

Property Value

Type	Description
string	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	For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

QueueId

Declaration

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

Property Value

Type	Description
string	The unique queue identifier.

SortBy

Declaration

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

Property Value

Type	Description
ListConsumerGroupsRequest.SortByEnum?	The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.

SortOrder

Declaration

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

Property Value

Type	Description
SortOrder?	The sort order to use, either 'asc' or 'desc'.

Implements

IOciRequest