The `watcherclient.v1.goal` Module

updated: 2018-08-28 08:03

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]¶

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

Retrieve a list of goal.

Parameters:

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

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.

updated: 2018-08-28 08:03

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.