Files
deb-python-pyvmomi/docs/vim/alarm/AlarmTriggeringAction.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.4 KiB

vim.alarm.AlarmTriggeringAction

This data object type describes one or more triggering transitions and an action to be done when an alarm is triggered.There are four triggering transitions; at least one of them must be provided. A gray state is considered the same as a green state, for the purpose of detecting transitions.

extends

vim.alarm.AlarmAction

Attributes:

action (vim.action.Action):

The action to be done when the alarm is triggered.

transitionSpecs (vim.alarm.AlarmTriggeringAction.TransitionSpec, optional):

Indicates on which transitions this action executes and repeats. This is optional only for backwards compatibility.

green2yellow (bool):

Flag to specify that the alarm should trigger on a transition from green to yellow.

yellow2red (bool):

Flag to specify that the alarm should trigger on a transition from yellow to red.

red2yellow (bool):

Flag to specify that the alarm should trigger on a transition from red to yellow.

yellow2green (bool):

Flag to specify that the alarm should trigger on a transition from yellow to green.