The watcherclient.v1.goal Module

class watcherclient.v1.goal.Goal(manager, info, loaded=False)[source]

Bases: watcherclient.common.base.Resource

class watcherclient.v1.goal.GoalManager(api)[source]

Bases: watcherclient.common.base.Manager

get(goal)[source]
list(limit=None, sort_key=None, sort_dir=None, detail=False)[source]

Retrieve a list of goal.

Parameters:
  • limit
    The maximum number of results to return per
    request, if:
    1. limit > 0, the maximum number of audits to return.
    2. limit == 0, return the entire list of audits.
    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 audits.
Returns:

A list of audits.

resource_class

alias of Goal