QueueSummary¶
- class oci.queue.models.QueueSummary(**kwargs)¶
Bases:
objectSummary of the queue.
Attributes:
A constant which can be used with the capabilities property of a QueueSummary.
A constant which can be used with the capabilities property of a QueueSummary.
Gets the capabilities of this QueueSummary.
[Required] Gets the compartment_id of this QueueSummary.
Gets the defined_tags of this QueueSummary.
Gets the display_name of this QueueSummary.
Gets the freeform_tags of this QueueSummary.
[Required] Gets the id of this QueueSummary.
Gets the lifecycle_details of this QueueSummary.
[Required] Gets the lifecycle_state of this QueueSummary.
[Required] Gets the messages_endpoint of this QueueSummary.
Gets the system_tags of this QueueSummary.
[Required] Gets the time_created of this QueueSummary.
[Required] Gets the time_updated of this QueueSummary.
Methods:
__init__(**kwargs)Initializes a new QueueSummary object with values from keyword arguments.
- CAPABILITIES_CONSUMER_GROUPS = 'CONSUMER_GROUPS'¶
A constant which can be used with the capabilities property of a QueueSummary. This constant has a value of “CONSUMER_GROUPS”
- CAPABILITIES_LARGE_MESSAGES = 'LARGE_MESSAGES'¶
A constant which can be used with the capabilities property of a QueueSummary. This constant has a value of “LARGE_MESSAGES”
- __init__(**kwargs)¶
Initializes a new QueueSummary 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 QueueSummary.
display_name (str) – The value to assign to the display_name property of this QueueSummary.
compartment_id (str) – The value to assign to the compartment_id property of this QueueSummary.
time_created (datetime) – The value to assign to the time_created property of this QueueSummary.
time_updated (datetime) – The value to assign to the time_updated property of this QueueSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this QueueSummary.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this QueueSummary.
messages_endpoint (str) – The value to assign to the messages_endpoint property of this QueueSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this QueueSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this QueueSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this QueueSummary.
capabilities (list[str]) – The value to assign to the capabilities property of this QueueSummary. Allowed values for items in this list are: “CONSUMER_GROUPS”, “LARGE_MESSAGES”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- property capabilities¶
Gets the capabilities of this QueueSummary. The list of capabilities enabled on the queue
Allowed values for items in this list are: “CONSUMER_GROUPS”, “LARGE_MESSAGES”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The capabilities of this QueueSummary.
- Return type
list[str]
- property compartment_id¶
[Required] Gets the compartment_id of this QueueSummary. The OCID of the compartment containing the queue.
- Returns
The compartment_id of this QueueSummary.
- Return type
str
- property defined_tags¶
Gets the defined_tags of this QueueSummary. 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 QueueSummary.
- Return type
dict(str, dict(str, object))
- property display_name¶
Gets the display_name of this QueueSummary. A user-friendly name for the queue. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
- Returns
The display_name of this QueueSummary.
- Return type
str
- property freeform_tags¶
Gets the freeform_tags of this QueueSummary. 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 QueueSummary.
- Return type
dict(str, str)
- property id¶
[Required] Gets the id of this QueueSummary. A unique identifier for the queue that is immutable on creation.
- Returns
The id of this QueueSummary.
- Return type
str
- property lifecycle_details¶
Gets the lifecycle_details of this QueueSummary. Any additional details about the current state of the queue.
- Returns
The lifecycle_details of this QueueSummary.
- Return type
str
- property lifecycle_state¶
[Required] Gets the lifecycle_state of this QueueSummary. The current state of the queue.
- Returns
The lifecycle_state of this QueueSummary.
- Return type
str
- property messages_endpoint¶
[Required] Gets the messages_endpoint of this QueueSummary. The endpoint to use to consume or publish messages in the queue.
- Returns
The messages_endpoint of this QueueSummary.
- Return type
str
- property system_tags¶
Gets the system_tags of this QueueSummary. 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 QueueSummary.
- Return type
dict(str, dict(str, object))