Files
python-zaqarclient/doc/source/command/claim.rst
gecong1973 19796a6f7c Add new command guide doc
All the zaqarclient command have been added according to 'openstack
messaging XXX' format,see [1] , this patch update doc accordingly.

[1] https://review.openstack.org/#/c/470201/

Change-Id: I552b0b95c960b17d25272c53863e16e191428da2
2017-07-21 00:19:40 +00:00

5.2 KiB

Claim

For help on a specific openstack claim command, enter:

$ openstack claim COMMAND -h/--help

The eight commands:

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

openstack claim create

usage: openstack 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 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 claim query

usage: openstack 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 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 claim release

usage: openstack 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 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 claim renew

usage: openstack 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.

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.