Show / Hide Table of Contents

Class CreateConsumerGroupDetails

The information about a new consumer group.

Inheritance
object
CreateConsumerGroupDetails
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Oci.QueueService.Models
Assembly: OCI.DotNetSDK.Queue.dll
Syntax
public class CreateConsumerGroupDetails

Properties

DeadLetterQueueDeliveryCount

Declaration
[JsonProperty(PropertyName = "deadLetterQueueDeliveryCount")]
public int? DeadLetterQueueDeliveryCount { get; set; }
Property Value
Type Description
int?

The number of times a message can be delivered to a consumer before being moved to the dead letter queue. A value of 0 indicates that the DLQ is not used. If the value isn't specified, it will be using the value defined at the queue level.

DefinedTags

Declaration
[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }
Property Value
Type Description
Dictionary<string, Dictionary<string, object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}}

DisplayName

Declaration
[Required(ErrorMessage = "DisplayName is required.")]
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }
Property Value
Type Description
string

The user-friendly name of the consumer group.

Remarks

Required

Filter

Declaration
[JsonProperty(PropertyName = "filter")]
public string Filter { get; set; }
Property Value
Type Description
string

The filter used by the consumer group. Only messages matching the filter will be available by consumers of the group.

FreeformTags

Declaration
[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }
Property Value
Type Description
Dictionary<string, string>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

IsEnabled

Declaration
[JsonProperty(PropertyName = "isEnabled")]
public bool? IsEnabled { get; set; }
Property Value
Type Description
bool?

Used to enable or disable the consumer group. An enabled consumer group will have a lifecycle state of ACTIVE, while a disabled will have its state as INACTIVE.

QueueId

Declaration
[Required(ErrorMessage = "QueueId is required.")]
[JsonProperty(PropertyName = "queueId")]
public string QueueId { get; set; }
Property Value
Type Description
string

The OCID of the associated queue.

Remarks

Required

In this article
Back to top