CreateConsumerGroupDetails¶

class oci.queue.models.CreateConsumerGroupDetails(**kwargs)¶

Bases: object

The information about a new consumer group.

Methods:

__init__(**kwargs)

Initializes a new CreateConsumerGroupDetails object with values from keyword arguments.

Attributes:

`dead_letter_queue_delivery_count`	Gets the dead_letter_queue_delivery_count of this CreateConsumerGroupDetails.
`defined_tags`	Gets the defined_tags of this CreateConsumerGroupDetails.
`display_name`	[Required] Gets the display_name of this CreateConsumerGroupDetails.
`filter`	Gets the filter of this CreateConsumerGroupDetails.
`freeform_tags`	Gets the freeform_tags of this CreateConsumerGroupDetails.
`is_enabled`	Gets the is_enabled of this CreateConsumerGroupDetails.
`queue_id`	[Required] Gets the queue_id of this CreateConsumerGroupDetails.

__init__(**kwargs)¶

Initializes a new CreateConsumerGroupDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters

display_name (str) – The value to assign to the display_name property of this CreateConsumerGroupDetails.
filter (str) – The value to assign to the filter property of this CreateConsumerGroupDetails.
queue_id (str) – The value to assign to the queue_id property of this CreateConsumerGroupDetails.
is_enabled (bool) – The value to assign to the is_enabled property of this CreateConsumerGroupDetails.
dead_letter_queue_delivery_count (int) – The value to assign to the dead_letter_queue_delivery_count property of this CreateConsumerGroupDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateConsumerGroupDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateConsumerGroupDetails.

property dead_letter_queue_delivery_count¶

Gets the dead_letter_queue_delivery_count of this CreateConsumerGroupDetails. 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.

Returns: The dead_letter_queue_delivery_count of this CreateConsumerGroupDetails.
Return type: int

property defined_tags¶

Gets the defined_tags of this CreateConsumerGroupDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns: The defined_tags of this CreateConsumerGroupDetails.
Return type: dict(str, dict(str, object))

property display_name¶

[Required] Gets the display_name of this CreateConsumerGroupDetails. The user-friendly name of the consumer group.

Returns: The display_name of this CreateConsumerGroupDetails.
Return type: str

property filter¶

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

Returns: The filter of this CreateConsumerGroupDetails.
Return type: str

property freeform_tags¶

Gets the freeform_tags of this CreateConsumerGroupDetails. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}

Returns: The freeform_tags of this CreateConsumerGroupDetails.
Return type: dict(str, str)

property is_enabled¶

Gets the is_enabled of this CreateConsumerGroupDetails. 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.

Returns: The is_enabled of this CreateConsumerGroupDetails.
Return type: bool

property queue_id¶

[Required] Gets the queue_id of this CreateConsumerGroupDetails. The OCID of the associated queue.

Returns: The queue_id of this CreateConsumerGroupDetails.
Return type: str