openstack/python-zaqarclient
Code Issues Proposed changes
Files
09a95673d0a5798934e28c0737e369df6aad94eb
python-zaqarclient/doc/source/command/subscription.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

7.1 KiB
Raw Blame History

Subscription

For help on a specific openstack subscription command, enter:

$ openstack subscription COMMAND -h/--help

The ten commands:

subscription create
messaging subscription create
subscription delete
messaging subscription delete
subscription list
messaging subscription list
subscription show
messaging subscription show
subscription update
messaging subscription update

openstack subscription create

usage: openstack subscription create [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--noindent] [--prefix PREFIX]
                                     [--options <options>]
                                     <queue_name> <subscriber> <ttl>

Create a subscription.

Positional arguments:

<queue_name>

Name of the queue.

<subscriber>

Subscriber which will be notified.

<ttl>

Time to live of the subscription in seconds.

openstack messaging subscription create

usage: openstack messaging subscription create [-h] [-f {json,shell,table,value,yaml}]
                                               [-c COLUMN] [--max-width <integer>]
                                               [--noindent] [--prefix PREFIX]
                                               [--options <options>]
                                               <queue_name> <subscriber> <ttl>

Create a subscription.

Positional arguments:

<queue_name>

Name of the queue.

<subscriber>

Subscriber which will be notified.

<ttl>

Time to live of the subscription in seconds.

openstack subscription delete

usage: openstack subscription delete [-h] <queue_name> <subscription_id>

Delete a subscription.

Positional arguments:

<queue_name>

Name of the queue.

<subscription_id>

ID of the subscription.

openstack messaging subscription delete

usage: openstack messaging subscription delete [-h] <queue_name> <subscription_id>

Delete a subscription.

Positional arguments:

<queue_name>

Name of the queue.

<subscription_id>

ID of the subscription.

openstack subscription list

usage: openstack subscription list [-h] [-f {csv,json,table,value,yaml}]
                                   [-c COLUMN] [--max-width <integer>]
                                   [--noindent]
                                   [--quote {all,minimal,none,nonnumeric}]
                                   [--marker <subscription_id>]
                                   [--limit <limit>]
                                   <queue_name>

Get list of subscriptions.

Positional arguments:

<queue_name>

Name of the queue.

openstack messaging subscription list

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

Get list of subscriptions.

Positional arguments:

<queue_name>

Name of the queue.

openstack subscription show

usage: openstack subscription show [-h] [-f {json,shell,table,value,yaml}]
                                   [-c COLUMN] [--max-width <integer>]
                                   [--noindent] [--prefix PREFIX]
                                   <queue_name> <subscription_id>

Query a subscription details.

Positional arguments:

<queue_name>

Name of the queue.

<subscription_id>

ID of the subscription.

openstack messaging subscription show

usage: openstack messaging subscription show [-h] [-f {json,shell,table,value,yaml}]
                                             [-c COLUMN] [--max-width <integer>]
                                             [--noindent] [--prefix PREFIX]
                                             <queue_name> <subscription_id>

Query a subscription details.

Positional arguments:

<queue_name>

Name of the queue.

<subscription_id>

ID of the subscription.

openstack subscription update

usage: openstack subscription update [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--noindent] [--prefix PREFIX]
                                     [--subscriber <subscriber>] [--ttl <ttl>]
                                     [--options <options>]
                                     <queue_name> <subscription_id>

Update a subscription.

Positional arguments:

<queue_name>

Name of the queue.

<subscription_id>

ID of the subscription

Optional arguments:

--subscriber <subscriber>

Subscriber which will be notified.

--ttl <ttl>

Time to live of the subscription in seconds.

--options <options>

Metadata of the subscription in JSON format.

openstack messaging subscription update

usage: openstack messaging subscription update [-h] [-f {json,shell,table,value,yaml}]
                                               [-c COLUMN] [--max-width <integer>]
                                               [--noindent] [--prefix PREFIX]
                                               [--subscriber <subscriber>] [--ttl <ttl>]
                                               [--options <options>]
                                               <queue_name> <subscription_id>

Update a subscription.

Positional arguments:

<queue_name>

Name of the queue.

<subscription_id>

ID of the subscription

Optional arguments:

--subscriber <subscriber>

Subscriber which will be notified.

--ttl <ttl>

Time to live of the subscription in seconds.

--options <options>

Metadata of the subscription in JSON format.