ConsumerGroupSummary¶

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

Bases: object

Summary of the consumer group.

Methods

__init__(**kwargs) Initializes a new ConsumerGroupSummary object with values from keyword arguments.

Attributes

`defined_tags`	Gets the defined_tags of this ConsumerGroupSummary.
`display_name`	[Required] Gets the display_name of this ConsumerGroupSummary.
`filter`	[Required] Gets the filter of this ConsumerGroupSummary.
`freeform_tags`	Gets the freeform_tags of this ConsumerGroupSummary.
`id`	[Required] Gets the id of this ConsumerGroupSummary.
`lifecycle_details`	Gets the lifecycle_details of this ConsumerGroupSummary.
`lifecycle_state`	[Required] Gets the lifecycle_state of this ConsumerGroupSummary.
`queue_id`	[Required] Gets the queue_id of this ConsumerGroupSummary.
`system_tags`	Gets the system_tags of this ConsumerGroupSummary.
`time_created`	[Required] Gets the time_created of this ConsumerGroupSummary.
`time_updated`	[Required] Gets the time_updated of this ConsumerGroupSummary.

__init__(**kwargs)¶

Initializes a new ConsumerGroupSummary 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 ConsumerGroupSummary.
display_name (str) – The value to assign to the display_name property of this ConsumerGroupSummary.
time_created (datetime) – The value to assign to the time_created property of this ConsumerGroupSummary.
time_updated (datetime) – The value to assign to the time_updated property of this ConsumerGroupSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this ConsumerGroupSummary.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this ConsumerGroupSummary.
filter (str) – The value to assign to the filter property of this ConsumerGroupSummary.
queue_id (str) – The value to assign to the queue_id property of this ConsumerGroupSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this ConsumerGroupSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this ConsumerGroupSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this ConsumerGroupSummary.

defined_tags¶

Gets the defined_tags of this ConsumerGroupSummary. 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 ConsumerGroupSummary.
Return type:	dict(str, dict(str, object))

display_name¶

[Required] Gets the display_name of this ConsumerGroupSummary. 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 ConsumerGroupSummary.
Return type:	str

filter¶

[Required] Gets the filter of this ConsumerGroupSummary. 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 ConsumerGroupSummary.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this ConsumerGroupSummary. 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 ConsumerGroupSummary.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this ConsumerGroupSummary. A unique identifier for the consumer group that is immutable on creation.

Returns:	The id of this ConsumerGroupSummary.
Return type:	str

lifecycle_details¶

Gets the lifecycle_details of this ConsumerGroupSummary. Any additional details about the current state of the consumer group.

Returns:	The lifecycle_details of this ConsumerGroupSummary.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this ConsumerGroupSummary. The current state of the consumer group.

Returns:	The lifecycle_state of this ConsumerGroupSummary.
Return type:	str

queue_id¶

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

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

system_tags¶

Gets the system_tags of this ConsumerGroupSummary. 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 ConsumerGroupSummary.
Return type:	dict(str, dict(str, object))

time_created¶

[Required] Gets the time_created of this ConsumerGroupSummary. The time that the consumer group was created, expressed in RFC 3339 timestamp format.

Example: 2018-04-20T00:00:07.405Z

Returns:	The time_created of this ConsumerGroupSummary.
Return type:	datetime

time_updated¶

[Required] Gets the time_updated of this ConsumerGroupSummary. The time that the consumer group was updated, expressed in RFC 3339 timestamp format.

Example: 2018-04-20T00:00:07.405Z

Returns:	The time_updated of this ConsumerGroupSummary.
Return type:	datetime