ConsumerGroup¶
- class oci.queue.models.ConsumerGroup(**kwargs)¶
Bases:
objectA detailed representation of a consumer group.
Attributes:
A constant which can be used with the lifecycle_state property of a ConsumerGroup.
A constant which can be used with the lifecycle_state property of a ConsumerGroup.
A constant which can be used with the lifecycle_state property of a ConsumerGroup.
A constant which can be used with the lifecycle_state property of a ConsumerGroup.
A constant which can be used with the lifecycle_state property of a ConsumerGroup.
A constant which can be used with the lifecycle_state property of a ConsumerGroup.
A constant which can be used with the lifecycle_state property of a ConsumerGroup.
Gets the dead_letter_queue_delivery_count of this ConsumerGroup.
Gets the defined_tags of this ConsumerGroup.
[Required] Gets the display_name of this ConsumerGroup.
[Required] Gets the filter of this ConsumerGroup.
Gets the freeform_tags of this ConsumerGroup.
[Required] Gets the id of this ConsumerGroup.
Gets the lifecycle_details of this ConsumerGroup.
[Required] Gets the lifecycle_state of this ConsumerGroup.
[Required] Gets the queue_id of this ConsumerGroup.
Gets the system_tags of this ConsumerGroup.
[Required] Gets the time_created of this ConsumerGroup.
[Required] Gets the time_updated of this ConsumerGroup.
Methods:
__init__(**kwargs)Initializes a new ConsumerGroup object with values from keyword arguments.
- LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶
A constant which can be used with the lifecycle_state property of a ConsumerGroup. This constant has a value of “ACTIVE”
- LIFECYCLE_STATE_CREATING = 'CREATING'¶
A constant which can be used with the lifecycle_state property of a ConsumerGroup. This constant has a value of “CREATING”
- LIFECYCLE_STATE_DELETED = 'DELETED'¶
A constant which can be used with the lifecycle_state property of a ConsumerGroup. This constant has a value of “DELETED”
- LIFECYCLE_STATE_DELETING = 'DELETING'¶
A constant which can be used with the lifecycle_state property of a ConsumerGroup. This constant has a value of “DELETING”
- LIFECYCLE_STATE_FAILED = 'FAILED'¶
A constant which can be used with the lifecycle_state property of a ConsumerGroup. This constant has a value of “FAILED”
- LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶
A constant which can be used with the lifecycle_state property of a ConsumerGroup. This constant has a value of “INACTIVE”
- LIFECYCLE_STATE_UPDATING = 'UPDATING'¶
A constant which can be used with the lifecycle_state property of a ConsumerGroup. This constant has a value of “UPDATING”
- __init__(**kwargs)¶
Initializes a new ConsumerGroup object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
- Parameters
id (str) – The value to assign to the id property of this ConsumerGroup.
display_name (str) – The value to assign to the display_name property of this ConsumerGroup.
time_created (datetime) – The value to assign to the time_created property of this ConsumerGroup.
time_updated (datetime) – The value to assign to the time_updated property of this ConsumerGroup.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this ConsumerGroup. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, “INACTIVE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this ConsumerGroup.
filter (str) – The value to assign to the filter property of this ConsumerGroup.
queue_id (str) – The value to assign to the queue_id property of this ConsumerGroup.
dead_letter_queue_delivery_count (int) – The value to assign to the dead_letter_queue_delivery_count property of this ConsumerGroup.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this ConsumerGroup.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this ConsumerGroup.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this ConsumerGroup.
- property dead_letter_queue_delivery_count¶
Gets the dead_letter_queue_delivery_count of this ConsumerGroup. 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 dead_letter_queue_delivery_count of this ConsumerGroup.
- Return type
int
- property defined_tags¶
Gets the defined_tags of this ConsumerGroup. 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 ConsumerGroup.
- Return type
dict(str, dict(str, object))
- property display_name¶
[Required] Gets the display_name of this ConsumerGroup. A user-friendly name for the consumer group. It has to be unique within the same queue in a case-insensitive manner. It’s changeable. Avoid entering confidential information.
- Returns
The display_name of this ConsumerGroup.
- Return type
str
- property filter¶
[Required] Gets the filter of this ConsumerGroup. The filter used by the 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 filter of this ConsumerGroup.
- Return type
str
- property freeform_tags¶
Gets the freeform_tags of this ConsumerGroup. 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 ConsumerGroup.
- Return type
dict(str, str)
- property id¶
[Required] Gets the id of this ConsumerGroup. A unique identifier for the consumer group that is immutable on creation.
- Returns
The id of this ConsumerGroup.
- Return type
str
- property lifecycle_details¶
Gets the lifecycle_details of this ConsumerGroup. Any additional details about the current state of the consumer group.
- Returns
The lifecycle_details of this ConsumerGroup.
- Return type
str
- property lifecycle_state¶
[Required] Gets the lifecycle_state of this ConsumerGroup. The current state of the consumer group.
Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, “INACTIVE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The lifecycle_state of this ConsumerGroup.
- Return type
str
- property queue_id¶
[Required] Gets the queue_id of this ConsumerGroup. The OCID of the associated queue.
- Returns
The queue_id of this ConsumerGroup.
- Return type
str
- property system_tags¶
Gets the system_tags of this ConsumerGroup. Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}
- Returns
The system_tags of this ConsumerGroup.
- Return type
dict(str, dict(str, object))