The watcher.api.controllers.v1.service Module

Service mechanism provides ability to monitor Watcher services state.

class watcher.api.controllers.v1.service.Service(**kwargs)

Bases: watcher.api.controllers.base.APIBase

API representation of a service.

This class enforces type checking and value constraints, and converts between the internal object model and the API representation of a service.

classmethod convert_with_links(service, expand=True)

classmethod sample(expand=True)

class watcher.api.controllers.v1.service.ServiceCollection(**kwargs)

Bases: watcher.api.controllers.v1.collection.Collection

API representation of a collection of services.

static convert_with_links(services, limit, url=None, expand=False, **kwargs)

classmethod sample()

class watcher.api.controllers.v1.service.ServicesController

Bases: pecan.rest.RestController

REST controller for Services.

detail(*args, **kwargs)

Retrieve a list of services with detail.

Parameters:

• marker – pagination marker for large data sets.
• limit – maximum number of resources to return in a single result.
• sort_key – column to sort results by. Default: id.
• sort_dir – direction to sort. “asc” or “desc”. Default: asc.

get_all(*args, **kwargs)

Retrieve a list of services.

Parameters:

• marker – pagination marker for large data sets.
• limit – maximum number of resources to return in a single result.
• sort_key – column to sort results by. Default: id.
• sort_dir – direction to sort. “asc” or “desc”. Default: asc.

get_one(*args, **kwargs)

Retrieve information about the given service.

Parameters:service – ID or name of the service.