Files
python-zaqarclient/doc/source/command/claim.rst
Nguyen Hai a38a7ecb63 Follow the new PTI for document build
For compliance with the Project Testing Interface as described in:
https://governance.openstack.org/tc/reference/project-testing-interface.html
http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html

Remove [build_sphinx] section as described in:
http://lists.openstack.org/pipermail/openstack-dev/2018-March/128594.html

Change-Id: Ief4342133f5b2f094feb9816f154c6d17a2d028e
2018-03-30 00:04:19 +09: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.