openstack/python-zaqarclient
Code Issues Proposed changes
master
python-zaqarclient/doc/source/command/claim.rst
wanghao 8f0b9f5b07 Adding the doc of message in CLI 
The doc of message is missing in zaqarclient.
So this patch will add it and also remove the unused docs for
other resources.

Change-Id: I55c745a81226487292220edfb629ca4f7dfd95d7
Closes-Bug: #1893145
Signed-off-by: wanghao <sxmatch1986@gmail.com>
2020-08-27 08:51:23 +08:00

2.9 KiB
Raw Permalink Blame History

Claim

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

$ openstack messaging claim COMMAND -h/--help

The eight commands:

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

openstack messaging claim create

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

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

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

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.