74 lines
2.9 KiB
Python
74 lines
2.9 KiB
Python
# Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
# not use this file except in compliance with the License. You may obtain
|
|
# a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
# License for the specific language governing permissions and limitations
|
|
# under the License.
|
|
|
|
from openstack.message.v2 import queue as _queue
|
|
from openstack import proxy2
|
|
|
|
|
|
class Proxy(proxy2.BaseProxy):
|
|
|
|
def create_queue(self, **attrs):
|
|
"""Create a new queue from attributes
|
|
|
|
:param dict attrs: Keyword arguments which will be used to create
|
|
a :class:`~openstack.message.v2.queue.Queue`,
|
|
comprised of the properties on the Queue class.
|
|
|
|
:returns: The results of queue creation
|
|
:rtype: :class:`~openstack.message.v2.queue.Queue`
|
|
"""
|
|
return self._create(_queue.Queue, **attrs)
|
|
|
|
def get_queue(self, queue):
|
|
"""Get a queue
|
|
|
|
:param queue: The value can be the name of a queue or a
|
|
:class:`~openstack.message.v2.queue.Queue` instance.
|
|
|
|
:returns: One :class:`~openstack.message.v2.queue.Queue`
|
|
:raises: :class:`~openstack.exceptions.ResourceNotFound` when no
|
|
queue matching the name could be found.
|
|
"""
|
|
return self._get(_queue.Queue, queue)
|
|
|
|
def queues(self, **query):
|
|
"""Retrieve a generator of queues
|
|
|
|
:param kwargs \*\*query: Optional query parameters to be sent to
|
|
restrict the queues to be returned. Available parameters include:
|
|
|
|
* limit: Requests at most the specified number of items be
|
|
returned from the query.
|
|
* marker: Specifies the ID of the last-seen queue. Use the limit
|
|
parameter to make an initial limited request and use the ID of
|
|
the last-seen queue from the response as the marker parameter
|
|
value in a subsequent limited request.
|
|
|
|
:returns: A generator of queue instances.
|
|
"""
|
|
return self._list(_queue.Queue, paginated=True, **query)
|
|
|
|
def delete_queue(self, value, ignore_missing=True):
|
|
"""Delete a queue
|
|
|
|
:param value: The value can be either the name of a queue or a
|
|
:class:`~openstack.message.v2.queue.Queue` instance.
|
|
:param bool ignore_missing: When set to ``False``
|
|
:class:`~openstack.exceptions.ResourceNotFound` will be
|
|
raised when the queue does not exist.
|
|
When set to ``True``, no exception will be set when
|
|
attempting to delete a nonexistent queue.
|
|
|
|
:returns: ``None``
|
|
"""
|
|
return self._delete(_queue.Queue, value, ignore_missing=ignore_missing)
|