Files
deb-python-pyvmomi/docs/vim/cluster/Recommendation.rst
Shawn Hartsock 15f7be9a52 pyVmomi reStructured Text Documentation
This external documentation for pyVmomi was generated using Googly Docs
(aka Google Standard Documentation) which renders very cleanly in
GitHub. Internal documentation for a class should be done in Sphinx
format because tools like pyCharm and Eclipse can use that documentation
as a hint for code completion.

Note: External docs as Googly Docs, internal docs as Sphinx.

Closes bug#15
2014-06-17 14:07:42 -04:00

1.7 KiB

vim.cluster.Recommendation

Recommendation is the base class for any packaged group of actions that are intended to take the system from one state to another one.

extends

vmodl.DynamicData

since

VI API 2.5

Attributes:

key (str):

Key to identify the recommendation when calling applyRecommendation.

type (str):

Type of the recommendation. This differentiates between various of recommendations aimed at achieving different goals.

time (datetime):

The time this recommendation was computed.

rating (int):

A rating of the recommendation. Valid values range from 1 (lowest confidence) to 5 (highest confidence).

reason (str):

A reason code explaining why this set of migrations is being suggested.

reasonText (str):

Text that provides more information about the reason code for the suggested set of migrations.

prerequisite (str, optional):

This recommendation may depend on some other recommendations. The prerequisite recommendations are listed by their keys.

action (vim.cluster.Action, optional):

List of actions that are executed as part of this recommendation

target (vmodl.ManagedObject, optional):

The target object of this recommendation.