CreateQueueDetails¶

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

Bases: object

The information about a new queue.

Methods:

__init__(**kwargs)

Initializes a new CreateQueueDetails object with values from keyword arguments.

Attributes:

`capabilities`	Gets the capabilities of this CreateQueueDetails.
`channel_consumption_limit`	Gets the channel_consumption_limit of this CreateQueueDetails.
`compartment_id`	[Required] Gets the compartment_id of this CreateQueueDetails.
`custom_encryption_key_id`	Gets the custom_encryption_key_id of this CreateQueueDetails.
`dead_letter_queue_delivery_count`	Gets the dead_letter_queue_delivery_count of this CreateQueueDetails.
`defined_tags`	Gets the defined_tags of this CreateQueueDetails.
`display_name`	[Required] Gets the display_name of this CreateQueueDetails.
`freeform_tags`	Gets the freeform_tags of this CreateQueueDetails.
`retention_in_seconds`	Gets the retention_in_seconds of this CreateQueueDetails.
`timeout_in_seconds`	Gets the timeout_in_seconds of this CreateQueueDetails.
`visibility_in_seconds`	Gets the visibility_in_seconds of this CreateQueueDetails.

__init__(**kwargs)¶

Initializes a new CreateQueueDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters

display_name (str) – The value to assign to the display_name property of this CreateQueueDetails.
compartment_id (str) – The value to assign to the compartment_id property of this CreateQueueDetails.
retention_in_seconds (int) – The value to assign to the retention_in_seconds property of this CreateQueueDetails.
visibility_in_seconds (int) – The value to assign to the visibility_in_seconds property of this CreateQueueDetails.
timeout_in_seconds (int) – The value to assign to the timeout_in_seconds property of this CreateQueueDetails.
channel_consumption_limit (int) – The value to assign to the channel_consumption_limit property of this CreateQueueDetails.
dead_letter_queue_delivery_count (int) – The value to assign to the dead_letter_queue_delivery_count property of this CreateQueueDetails.
custom_encryption_key_id (str) – The value to assign to the custom_encryption_key_id property of this CreateQueueDetails.
capabilities (list[oci.queue.models.CapabilityDetails]) – The value to assign to the capabilities property of this CreateQueueDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateQueueDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateQueueDetails.

property capabilities¶

Gets the capabilities of this CreateQueueDetails. The capability to add on the queue

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

property channel_consumption_limit¶

Gets the channel_consumption_limit of this CreateQueueDetails. 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 CreateQueueDetails.
Return type: int

property compartment_id¶

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

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

property custom_encryption_key_id¶

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

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

property dead_letter_queue_delivery_count¶

Gets the dead_letter_queue_delivery_count of this CreateQueueDetails. 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 CreateQueueDetails.
Return type: int

property defined_tags¶

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

property display_name¶

[Required] Gets the display_name of this CreateQueueDetails. The user-friendly name of the queue.

Returns: The display_name of this CreateQueueDetails.
Return type: str

property freeform_tags¶

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

property retention_in_seconds¶

Gets the retention_in_seconds of this CreateQueueDetails. The retention period of messages in the queue, in seconds.

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

property timeout_in_seconds¶

Gets the timeout_in_seconds of this CreateQueueDetails. The default polling timeout of the messages in the queue, in seconds.

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

property visibility_in_seconds¶

Gets the visibility_in_seconds of this CreateQueueDetails. The default visibility timeout of the messages consumed from the queue, in seconds.

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