6f59061ec4
This change organizes the message docs by topic rather than letting autodoc organize methods by the order they appear in the _proxy.py file. These were not previously included so they're technically all brand new. There are some minor adjustments made to the docstrings as they weren't known to be raising warnings before due to not actually being included anywhere. Change-Id: Id4b8f08015a6f00b8134fcd2a01506562d9787fb
54 lines
1.8 KiB
ReStructuredText
54 lines
1.8 KiB
ReStructuredText
Message API v2
|
|
==============
|
|
|
|
For details on how to use message, see :doc:`/users/guides/message`
|
|
|
|
.. automodule:: openstack.message.v2._proxy
|
|
|
|
The Message v2 Class
|
|
--------------------
|
|
|
|
The message high-level interface is available through the ``message`` member
|
|
of a :class:`~openstack.connection.Connection` object. The ``message``
|
|
member will only be added if the service is detected.
|
|
|
|
Message Operations
|
|
^^^^^^^^^^^^^^^^^^
|
|
|
|
.. autoclass:: openstack.message.v2._proxy.Proxy
|
|
|
|
.. automethod:: openstack.message.v2._proxy.Proxy.post_message
|
|
.. automethod:: openstack.message.v2._proxy.Proxy.delete_message
|
|
.. automethod:: openstack.message.v2._proxy.Proxy.get_message
|
|
.. automethod:: openstack.message.v2._proxy.Proxy.messages
|
|
|
|
Queue Operations
|
|
^^^^^^^^^^^^^^^^
|
|
|
|
.. autoclass:: openstack.message.v2._proxy.Proxy
|
|
|
|
.. automethod:: openstack.message.v2._proxy.Proxy.create_queue
|
|
.. automethod:: openstack.message.v2._proxy.Proxy.delete_queue
|
|
.. automethod:: openstack.message.v2._proxy.Proxy.get_queue
|
|
.. automethod:: openstack.message.v2._proxy.Proxy.queues
|
|
|
|
Claim Operations
|
|
^^^^^^^^^^^^^^^^
|
|
|
|
.. autoclass:: openstack.message.v2._proxy.Proxy
|
|
|
|
.. automethod:: openstack.message.v2._proxy.Proxy.create_claim
|
|
.. automethod:: openstack.message.v2._proxy.Proxy.update_claim
|
|
.. automethod:: openstack.message.v2._proxy.Proxy.delete_claim
|
|
.. automethod:: openstack.message.v2._proxy.Proxy.get_claim
|
|
|
|
Subscription Operations
|
|
^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
.. autoclass:: openstack.message.v2._proxy.Proxy
|
|
|
|
.. automethod:: openstack.message.v2._proxy.Proxy.create_subscription
|
|
.. automethod:: openstack.message.v2._proxy.Proxy.delete_subscription
|
|
.. automethod:: openstack.message.v2._proxy.Proxy.get_subscription
|
|
.. automethod:: openstack.message.v2._proxy.Proxy.subscriptions
|