File: claim.rst

package info (click to toggle)
python-zaqarclient 4.1.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 828 kB
  • sloc: python: 4,417; makefile: 18; sh: 2
file content (121 lines) | stat: -rw-r--r-- 2,935 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
Claim
=====

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

.. code-block:: console

   $ openstack messaging claim COMMAND -h/--help

The eight commands:

.. code-block:: console

      messaging claim create
      messaging claim query
      messaging claim release
      messaging claim renew

.. _openstack_messaging_claim_create:

openstack messaging claim create
--------------------------------

.. code-block:: console

   usage: openstack messaging claim create [-h] [-f {csv,json,table,value,yaml}]
                                           [-c COLUMN] [--max-width <integer>] [--noindent]
                                           [--quote {all,minimal,none,nonnumeric}]
                                           [--ttl <ttl>] [--grace <grace>]
                                           [--limit <limit>]
                                           <queue_name>

Create claim and return a list of claimed messages.

**Positional arguments:**

``<queue_name>``
  Name of the queue to be claim.

**Optional arguments:**

``--ttl <ttl>``
  Time to live in seconds for claim.

``--grace <grace>``
  The message grace period in seconds.

``--limit <limit>``
  Claims a set of messages, up to limit.

.. _openstack_messaging_claim_query:

openstack messaging claim query
-------------------------------

.. code-block:: console

   usage: openstack messaging claim query [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                                          [--max-width <integer>] [--noindent]
                                          [--quote {all,minimal,none,nonnumeric}]
                                          <queue_name> <claim_id>

Display claim details.

**Positional arguments:**

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

``<claim_id>``
  ID of the claim.

.. _openstack_messaging_claim_release:

openstack messaging claim release
---------------------------------

.. code-block:: console

   usage: openstack messaging claim release [-h] <queue_name> <claim_id>

Delete a claim.

**Positional arguments:**

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

``<claim_id>``
  Claim ID to delete.

.. _openstack_messaging_claim_renew:

openstack messaging claim renew
-------------------------------

.. code-block:: console

   usage: openstack messaging claim renew [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                                          [--max-width <integer>] [--noindent]
                                          [--quote {all,minimal,none,nonnumeric}]
                                          [--ttl <ttl>] [--grace <grace>]
                                          <queue_name> <claim_id>

Renew a claim.

**Positional arguments:**

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

``<claim_id>``
  Claim ID.

**Optional arguments:**

``--ttl <ttl>``
  Time to live in seconds for claim.

``--grace <grace>``
  The message grace period in seconds.