UpdateQueueDetails¶

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

Bases: object

The information to be updated.

Methods:

__init__(**kwargs)

Initializes a new UpdateQueueDetails object with values from keyword arguments.

Attributes:

`capabilities`	Gets the capabilities of this UpdateQueueDetails.
`channel_consumption_limit`	Gets the channel_consumption_limit of this UpdateQueueDetails.
`custom_encryption_key_id`	Gets the custom_encryption_key_id of this UpdateQueueDetails.
`dead_letter_queue_delivery_count`	Gets the dead_letter_queue_delivery_count of this UpdateQueueDetails.
`defined_tags`	Gets the defined_tags of this UpdateQueueDetails.
`display_name`	Gets the display_name of this UpdateQueueDetails.
`freeform_tags`	Gets the freeform_tags of this UpdateQueueDetails.
`timeout_in_seconds`	Gets the timeout_in_seconds of this UpdateQueueDetails.
`visibility_in_seconds`	Gets the visibility_in_seconds of this UpdateQueueDetails.

__init__(**kwargs)¶

Initializes a new UpdateQueueDetails 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 UpdateQueueDetails.
visibility_in_seconds (int) – The value to assign to the visibility_in_seconds property of this UpdateQueueDetails.
timeout_in_seconds (int) – The value to assign to the timeout_in_seconds property of this UpdateQueueDetails.
channel_consumption_limit (int) – The value to assign to the channel_consumption_limit property of this UpdateQueueDetails.
dead_letter_queue_delivery_count (int) – The value to assign to the dead_letter_queue_delivery_count property of this UpdateQueueDetails.
custom_encryption_key_id (str) – The value to assign to the custom_encryption_key_id property of this UpdateQueueDetails.
capabilities (list[oci.queue.models.CapabilityDetails]) – The value to assign to the capabilities property of this UpdateQueueDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this UpdateQueueDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this UpdateQueueDetails.

property capabilities¶

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

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

property channel_consumption_limit¶

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

property custom_encryption_key_id¶

Gets the custom_encryption_key_id of this UpdateQueueDetails. The OCID of the custom encryption key to be used to encrypt messages content. A string with a length of 0 means the custom key should be removed from queue.

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

property dead_letter_queue_delivery_count¶

Gets the dead_letter_queue_delivery_count of this UpdateQueueDetails. 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. Changing that value to a lower threshold does not retroactively move in-flight messages in the dead letter queue.

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

property defined_tags¶

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

property display_name¶

Gets the display_name of this UpdateQueueDetails. The OCID of the queue.

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

property freeform_tags¶

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

property timeout_in_seconds¶

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

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

property visibility_in_seconds¶

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

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