otcextensions.sdk.dcs.v1.queue¶
The DMS Queue Class¶
The Queue
class inherits from
Resource
.
- class otcextensions.sdk.dms.v1.queue.Queue(_synchronized=False, connection=None, **attrs)¶
The base resource
- Parameters:
_synchronized (bool) – This is not intended to be used directly. See
new()
andexisting()
.connection (openstack.connection.Connection) – Reference to the Connection being used. Defaults to None to allow Resource objects to be used without an active Connection, such as in unit tests. Use of
self._connection
in Resource code should protect itself with a check for None.
- resources_key: ty.Optional[str] = 'queues'¶
Plural form of key for resource.
- base_path: str = '/queues'¶
The base part of the URI for this resource.
- allow_create = True¶
Allow create operation for this resource.
- allow_list = True¶
Allow list operation for this resource.
- allow_fetch = True¶
Allow get operation for this resource.
- allow_delete = True¶
Allow delete operation for this resource.
- created¶
Created time Type: int
- description¶
Description for the queue. The value is a string of a maximum of 160 characters and cannot contain the angle brackets (<>).
- id¶
Queue Id
- max_consume_count¶
Max consume count number Type: int Value range: 1–100.
- name: ty.Union[Body, URI]¶
Queue name
- queue_mode¶
Queue mode: NORMAL: Standard queue, which supports high concurrency performance but cannot guarantee that messages are retrieved in the exact sequence as how they are received. FIFO: First-in-first-out (FIFO) queue, which guarantees that messages are retrieved in the exact sequence as how they are received. KAFKA_HA: High-reliability Kafka queue. All message replicas are flushed to a disk synchronously, ensuring message reliability. KAFKA_HT: High-throughput Kafka queue. All message replicas are flushed to a disk asynchronously, ensuring high performance.
- redrive_policy¶
Redrive policy. Supported values: enable, disable. Default: disable
- retention_hours¶
Indicates the hours of storing messages in the Kafka queue. This parameter is valid only when queue_mode is set to KAFKA_HA or KAFKA_HT. Value range: 1–72. Type: int