File: queue.rst

package info (click to toggle)
python-zaqarclient 4.1.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 824 kB
  • sloc: python: 4,417; makefile: 18; sh: 2
file content (199 lines) | stat: -rw-r--r-- 5,294 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
Queue
=====

For help on a specific :command:`openstack messaging queue` command, enter:

.. code-block:: console

   $ openstack messaging queue COMMAND -h/--help

The fourteen commands:

.. code-block:: console

      messaging queue create
      messaging queue delete
      messaging queue get metadata
      messaging queue list
      messaging queue set metadata
      messaging queue signed url
      messaging queue stats

.. _openstack_messaging_queue_create:

openstack messaging queue create
--------------------------------

.. code-block:: console

   usage: openstack messaging queue create [-h] [-f {json,shell,table,value,yaml}]
                                           [-c COLUMN] [--max-width <integer>] [--noindent]
                                           [--prefix PREFIX]
                                           <queue_name>

Create a queue.

**Positional arguments:**

``<queue_name>``
  Name of the queue.

.. _openstack_messaging_queue_delete:

openstack messaging queue delete
--------------------------------

.. code-block:: console

   usage: openstack messaging queue delete [-h] <queue_name>

Delete a queue.

**Positional arguments:**

``<queue_name>``
  Name of the queue.

.. _openstack_messaging_queue_get_metadata:

openstack messaging queue get metadata
--------------------------------------

.. code-block:: console

   usage: openstack messaging queue get metadata [-h] [-f {json,shell,table,value,yaml}]
                                                 [-c COLUMN] [--max-width <integer>]
                                                 [--noindent] [--prefix PREFIX]
                                                 <queue_name>

Get queue metadata.

**Positional arguments:**

``<queue_name>``
  Name of the queue.

.. _openstack_messaging_queue_list:

openstack messaging queue list
------------------------------

.. code-block:: console

   usage: openstack messaging queue list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                                         [--max-width <integer>] [--noindent]
                                         [--quote {all,minimal,none,nonnumeric}]
                                         [--marker <queue_id>] [--limit <limit>]
                                         [--detailed]

List available queues.

**Optional arguments:**

``--marker <queue_id>``
  Queue's paging marker.

``--limit <limit>``
  Page size limit.

``--detailed``
  If show detailed information of queue.

.. _openstack_messaging_queue_set_metadata:

openstack messaging queue set metadata
--------------------------------------

.. code-block:: console

   usage: openstack messaging queue set metadata [-h] <queue_name> <queue_metadata>

Set queue metadata.All the metadata of the queue will be replaced by 
queue_metadata.

**Positional arguments:**

``<queue_name>``
  Name of the queue.

``<queue_metadata>``
  Queue metadata. It should be json like. For example: '{"age": 18}'

.. _openstack_messaging_queue_signed_url:

openstack messaging queue signed url
------------------------------------

.. code-block:: console

   usage: openstack messaging queue signed url [-h] [-f {json,shell,table,value,yaml}]
                                               [-c COLUMN] [--max-width <integer>]
                                               [--noindent] [--prefix PREFIX]
                                               [--paths <paths>]
                                               [--ttl-seconds <ttl_seconds>]
                                               [--methods <methods>]
                                               <queue_name>

Create a pre-signed url for the queue.

**Positional arguments:**

``<queue_name>``
  Name of the queue.

**Optional arguments:**

``--paths <paths>``
  Allowed paths in a comma-separated list.
  Options: messages, subscriptions, claims.

``--ttl-seconds <ttl_seconds>``
  Length of time (in seconds) until the signature expires.

``--methods <methods>``
  HTTP methods to allow as a comma-separated list.
  Options: GET, HEAD, OPTIONS, POST, PUT, DELETE.

.. _openstack_messaging_queue_stats:

openstack messaging queue stats
-------------------------------

.. code-block:: console

   usage: openstack messaging queue stats [-h] [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--max-width <integer>] [--noindent]
                                          [--prefix PREFIX]
                                          <queue_name>

Get queue stats.

**Positional arguments:**

``<queue_name>``
  Name of the queue.

.. _openstack_messaging_queue_purge:

openstack messaging queue purge
-------------------------------

.. code-block:: console

   usage: openstack messaging queue purge [-h] [--resource_types <resource_types>]
                                          <queue_name>

Purge a queue. All the metadata of the queue will be kept. Use
``--resource_types`` to specify which resource should be pured. If
``--resource_types`` is not specified, all the messages and subscriptions in
the queue will be purged by default.

**Positional arguments:**

``<queue_name>``
  Name of the queue.

**Optional arguments:**

``--resource_types <resource_types>``
  Resource types want to be purged. Support ``messages`` and ``subscriptions``.