python-zaqarclient/doc/source/command/claim.rst

Claim

For help on a specific openstack claim command, enter:

$ openstack claim COMMAND -h/--help

The four commands:

claim create
claim query
claim release
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 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 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 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.