ConsumerGroupsCapabilityDetails¶

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

Bases: oci.queue.models.capability_details.CapabilityDetails

Specifies the details for the consumer group capability. All fields are optional and are only used when the capability is added. Fields will be null when the capability is returned as part of the GetQueue API.

Attributes

`TYPE_CONSUMER_GROUPS`	str(object=’’) -> str
`TYPE_LARGE_MESSAGES`	str(object=’’) -> str
`is_primary_consumer_group_enabled`	Gets the is_primary_consumer_group_enabled of this ConsumerGroupsCapabilityDetails.
`primary_consumer_group_dead_letter_queue_delivery_count`	Gets the primary_consumer_group_dead_letter_queue_delivery_count of this ConsumerGroupsCapabilityDetails.
`primary_consumer_group_display_name`	Gets the primary_consumer_group_display_name of this ConsumerGroupsCapabilityDetails.
`primary_consumer_group_filter`	Gets the primary_consumer_group_filter of this ConsumerGroupsCapabilityDetails.
`type`	Gets the type of this CapabilityDetails.

Methods

`__init__`(**kwargs)	Initializes a new ConsumerGroupsCapabilityDetails object with values from keyword arguments.
`get_subtype`(object_dictionary)	Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

TYPE_CONSUMER_GROUPS = 'CONSUMER_GROUPS'¶

TYPE_LARGE_MESSAGES = 'LARGE_MESSAGES'¶

__init__(**kwargs)¶

Initializes a new ConsumerGroupsCapabilityDetails object with values from keyword arguments. The default value of the type attribute of this class is CONSUMER_GROUPS and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

type (str) – The value to assign to the type property of this ConsumerGroupsCapabilityDetails. Allowed values for this property are: “CONSUMER_GROUPS”, “LARGE_MESSAGES”
is_primary_consumer_group_enabled (bool) – The value to assign to the is_primary_consumer_group_enabled property of this ConsumerGroupsCapabilityDetails.
primary_consumer_group_display_name (str) – The value to assign to the primary_consumer_group_display_name property of this ConsumerGroupsCapabilityDetails.
primary_consumer_group_filter (str) – The value to assign to the primary_consumer_group_filter property of this ConsumerGroupsCapabilityDetails.
primary_consumer_group_dead_letter_queue_delivery_count (int) – The value to assign to the primary_consumer_group_dead_letter_queue_delivery_count property of this ConsumerGroupsCapabilityDetails.

static get_subtype(object_dictionary)¶: Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

is_primary_consumer_group_enabled¶

Gets the is_primary_consumer_group_enabled of this ConsumerGroupsCapabilityDetails. Specifies if the primary consumer group should be automatically enabled after adding the capability.

Returns:	The is_primary_consumer_group_enabled of this ConsumerGroupsCapabilityDetails.
Return type:	bool

primary_consumer_group_dead_letter_queue_delivery_count¶

Gets the primary_consumer_group_dead_letter_queue_delivery_count of this ConsumerGroupsCapabilityDetails. 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 set, it will be using the value defined at the queue level.

Returns:	The primary_consumer_group_dead_letter_queue_delivery_count of this ConsumerGroupsCapabilityDetails.
Return type:	int

primary_consumer_group_display_name¶

Gets the primary_consumer_group_display_name of this ConsumerGroupsCapabilityDetails. Name of the primary consumer group. If omitted, it will be named “Primary Consumer Group”.

Returns:	The primary_consumer_group_display_name of this ConsumerGroupsCapabilityDetails.
Return type:	str

primary_consumer_group_filter¶

Gets the primary_consumer_group_filter of this ConsumerGroupsCapabilityDetails. The filter used by the primary consumer group. Only messages matching the filter will be available by consumers of the group. An empty value means that all messages will be available in the group.

Returns:	The primary_consumer_group_filter of this ConsumerGroupsCapabilityDetails.
Return type:	str

type¶

Gets the type of this CapabilityDetails. The type of the capability

Allowed values for this property are: “CONSUMER_GROUPS”, “LARGE_MESSAGES”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The type of this CapabilityDetails.
Return type:	str