python-magnumclient/magnumclient/v1/mservices.py
Surojit Pathak b452363e92 Adding 'magnum service-list'
The client changes after introducing API/backend implementations.

Change-Id: I81e84c98e63dc0a1eafb1c1429cd6316c3852e88
Partially-Implements: blueprint magnum-service-list
Closes-bug: #1498228
Depends-On: Ib816f595ba2edef29edaec40fa940570755b10aa
2015-09-22 00:25:48 +00:00

72 lines
2.5 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 magnumclient.common import base
from magnumclient.common import utils
class MService(base.Resource):
def __repr__(self):
return "<Service %s>" % self._info
class MServiceManager(base.Manager):
resource_class = MService
@staticmethod
def _path(id=None):
return '/v1/mservices/%s' % id if id else '/v1/mservices'
def list(self, marker=None, limit=None, sort_key=None,
sort_dir=None, detail=False):
"""Retrieve list of magnum services.
:param marker: Optional, the ID of a magnum service, eg the last
services from a previous result set. Return
the next result set.
:param limit: The maximum number of results to return per
request, if:
1) limit > 0, the maximum number of services to return.
2) limit == 0, return the entire list of services.
3) limit param is NOT specified (None), the number of items
returned respect the maximum imposed by the Magnum API
(see Magnum's api.max_limit option).
:param sort_key: Optional, field used for sorting.
:param sort_dir: Optional, direction of sorting, either 'asc' (the
default) or 'desc'.
:param detail: Optional, boolean whether to return detailed information
about services.
:returns: A list of services.
"""
if limit is not None:
limit = int(limit)
filters = utils.common_filters(marker, limit, sort_key, sort_dir)
path = ''
if detail:
path += 'detail'
if filters:
path += '?' + '&'.join(filters)
if limit is None:
return self._list(self._path(path), "mservices")
else:
return self._list_pagination(self._path(path), "mservices",
limit=limit)