For details on how to use message, see Using OpenStack Message
The message high-level interface is available through the message
member
of a Connection
object. The message
member will only be added if the service is detected.
openstack.message.v2._proxy.
Proxy
(session=None, task_manager=None, *args, **kwargs)¶post_message
(queue_name, messages)¶Post messages to given queue
Parameters: |
|
---|---|
Returns: | A string includes location of messages successfully posted. |
delete_message
(queue_name, value, claim=None, ignore_missing=True)¶Delete a message
Parameters: |
|
---|---|
Returns: |
|
get_message
(queue_name, message)¶Get a message
Parameters: |
|
---|---|
Returns: | One |
Raises: |
|
messages
(queue_name, **query)¶Retrieve a generator of messages
Parameters: |
|
---|---|
Returns: | A generator of message instances. |
openstack.message.v2._proxy.
Proxy
(session=None, task_manager=None, *args, **kwargs)create_queue
(**attrs)¶Create a new queue from attributes
Parameters: | attrs (dict) – Keyword arguments which will be used to create
a Queue ,
comprised of the properties on the Queue class. |
---|---|
Returns: | The results of queue creation |
Return type: | Queue |
delete_queue
(value, ignore_missing=True)¶Delete a queue
Parameters: |
|
---|---|
Returns: |
|
get_queue
(queue)¶Get a queue
Parameters: | queue – The value can be the name of a queue or a
Queue instance. |
---|---|
Returns: | One Queue |
Raises: | ResourceNotFound when no
queue matching the name could be found. |
queues
(**query)¶Retrieve a generator of queues
Parameters: | **query (kwargs) – Optional query parameters to be sent to restrict the queues to be returned. Available parameters include:
|
---|---|
Returns: | A generator of queue instances. |
openstack.message.v2._proxy.
Proxy
(session=None, task_manager=None, *args, **kwargs)create_claim
(queue_name, **attrs)¶Create a new claim from attributes
Parameters: |
|
---|---|
Returns: | The results of claim creation |
Return type: |
|
update_claim
(queue_name, claim, **attrs)¶Update an existing claim from attributes
Parameters: |
|
---|---|
Returns: | The results of claim update |
Return type: |
|
delete_claim
(queue_name, claim, ignore_missing=True)¶Delete a claim
Parameters: |
|
---|---|
Returns: |
|
get_claim
(queue_name, claim)¶Get a claim
Parameters: |
|
---|---|
Returns: | One |
Raises: |
|
openstack.message.v2._proxy.
Proxy
(session=None, task_manager=None, *args, **kwargs)create_subscription
(queue_name, **attrs)¶Create a new subscription from attributes
Parameters: |
|
---|---|
Returns: | The results of subscription creation |
Return type: |
|
delete_subscription
(queue_name, value, ignore_missing=True)¶Delete a subscription
Parameters: |
|
---|---|
Returns: |
|
get_subscription
(queue_name, subscription)¶Get a subscription
Parameters: |
|
---|---|
Returns: | One |
Raises: |
|
subscriptions
(queue_name, **query)¶Retrieve a generator of subscriptions
Parameters: |
|
---|---|
Returns: | A generator of subscription instances. |
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.