Queue¶

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

Bases: object

A detailed representation of a queue and its configuration.

Attributes:

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a Queue.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a Queue.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a Queue.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a Queue.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a Queue.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a Queue.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a Queue.
`capabilities`	Gets the capabilities of this Queue.
`channel_consumption_limit`	Gets the channel_consumption_limit of this Queue.
`compartment_id`	[Required] Gets the compartment_id of this Queue.
`custom_encryption_key_id`	Gets the custom_encryption_key_id of this Queue.
`dead_letter_queue_delivery_count`	[Required] Gets the dead_letter_queue_delivery_count of this Queue.
`defined_tags`	Gets the defined_tags of this Queue.
`display_name`	Gets the display_name of this Queue.
`freeform_tags`	Gets the freeform_tags of this Queue.
`id`	[Required] Gets the id of this Queue.
`lifecycle_details`	Gets the lifecycle_details of this Queue.
`lifecycle_state`	[Required] Gets the lifecycle_state of this Queue.
`messages_endpoint`	[Required] Gets the messages_endpoint of this Queue.
`retention_in_seconds`	[Required] Gets the retention_in_seconds of this Queue.
`system_tags`	Gets the system_tags of this Queue.
`time_created`	[Required] Gets the time_created of this Queue.
`time_updated`	[Required] Gets the time_updated of this Queue.
`timeout_in_seconds`	[Required] Gets the timeout_in_seconds of this Queue.
`visibility_in_seconds`	[Required] Gets the visibility_in_seconds of this Queue.

Methods:

__init__(**kwargs)

Initializes a new Queue object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a Queue. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a Queue. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a Queue. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a Queue. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a Queue. This constant has a value of “FAILED”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶: A constant which can be used with the lifecycle_state property of a Queue. This constant has a value of “INACTIVE”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a Queue. This constant has a value of “UPDATING”

__init__(**kwargs)¶

Initializes a new Queue 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 Queue.
display_name (str) – The value to assign to the display_name property of this Queue.
compartment_id (str) – The value to assign to the compartment_id property of this Queue.
time_created (datetime) – The value to assign to the time_created property of this Queue.
time_updated (datetime) – The value to assign to the time_updated property of this Queue.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this Queue. 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 Queue.
messages_endpoint (str) – The value to assign to the messages_endpoint property of this Queue.
retention_in_seconds (int) – The value to assign to the retention_in_seconds property of this Queue.
visibility_in_seconds (int) – The value to assign to the visibility_in_seconds property of this Queue.
timeout_in_seconds (int) – The value to assign to the timeout_in_seconds property of this Queue.
dead_letter_queue_delivery_count (int) – The value to assign to the dead_letter_queue_delivery_count property of this Queue.
custom_encryption_key_id (str) – The value to assign to the custom_encryption_key_id property of this Queue.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this Queue.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this Queue.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this Queue.
channel_consumption_limit (int) – The value to assign to the channel_consumption_limit property of this Queue.
capabilities (list[oci.queue.models.CapabilityDetails]) – The value to assign to the capabilities property of this Queue.

property capabilities¶

Gets the capabilities of this Queue. The list of capabilities enabled on the queue

Returns: The capabilities of this Queue.
Return type: list[oci.queue.models.CapabilityDetails]

property channel_consumption_limit¶

Gets the channel_consumption_limit of this Queue. The percentage of allocated queue resources that can be consumed by a single channel. For example, if a queue has a storage limit of 2Gb, and a single channel consumption limit is 0.1 (10%), that means data size of a single channel can’t exceed 200Mb. Consumption limit of 100% (default) means that a single channel can consume up-to all allocated queue’s resources.

Returns: The channel_consumption_limit of this Queue.
Return type: int

property compartment_id¶

[Required] Gets the compartment_id of this Queue. The OCID of the compartment containing the queue.

Returns: The compartment_id of this Queue.
Return type: str

property custom_encryption_key_id¶

Gets the custom_encryption_key_id of this Queue. The OCID of the custom encryption key to be used to encrypt messages content.

Returns: The custom_encryption_key_id of this Queue.
Return type: str

property dead_letter_queue_delivery_count¶

[Required] Gets the dead_letter_queue_delivery_count of this Queue. 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.

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

property defined_tags¶

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

property display_name¶

Gets the display_name of this Queue. 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 Queue.
Return type: str

property freeform_tags¶

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

property id¶

[Required] Gets the id of this Queue. A unique identifier for the queue that is immutable on creation.

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

property lifecycle_details¶

Gets the lifecycle_details of this Queue. Any additional details about the current state of the queue.

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

property lifecycle_state¶

[Required] Gets the lifecycle_state of this Queue. The current state of the queue.

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 Queue.
Return type: str

property messages_endpoint¶

[Required] Gets the messages_endpoint of this Queue. The endpoint to use to consume or publish messages in the queue.

Returns: The messages_endpoint of this Queue.
Return type: str

property retention_in_seconds¶

[Required] Gets the retention_in_seconds of this Queue. The retention period of the messages in the queue, in seconds.

Returns: The retention_in_seconds of this Queue.
Return type: int

property system_tags¶

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

property time_created¶

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

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

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

property time_updated¶

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

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

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

property timeout_in_seconds¶

[Required] Gets the timeout_in_seconds of this Queue. The default polling timeout of the messages in the queue, in seconds.

Returns: The timeout_in_seconds of this Queue.
Return type: int

property visibility_in_seconds¶

[Required] Gets the visibility_in_seconds of this Queue. The default visibility timeout of the messages consumed from the queue, in seconds.

Returns: The visibility_in_seconds of this Queue.
Return type: int