The watcherclient.v1.metric_collector Module

class watcherclient.v1.metric_collector.MetricCollector(manager, info, loaded=False)

Bases: watcherclient.common.base.Resource

class watcherclient.v1.metric_collector.MetricCollectorManager(api)

Bases: watcherclient.common.base.Manager

create(**kwargs)

delete(metric_collector_id)

get(metric_collector_id)

list(category=None, limit=None, sort_key=None, sort_dir=None, detail=False)

Retrieve a list of metric collector.

Parameters:

• category – Optional, Metric category, to get all metric collectors mapped with this category.
• limit –

  The maximum number of results to return per

  request, if:

  1. limit > 0, the maximum number of metric collectors to return.
  2. limit == 0, return the entire list of metriccollectors.
  3. limit param is NOT specified (None), the number of items returned respect the maximum imposed by the Watcher API (see Watcher’s api.max_limit option).
• sort_key – Optional, field used for sorting.
• sort_dir – Optional, direction of sorting, either ‘asc’ (the default) or ‘desc’.
• detail – Optional, boolean whether to return detailed information about metric collectors.

Returns:

A list of metric collectors.

resource_class

alias of MetricCollector

update(metric_collector_id, patch)