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

38 lines
894 B
ReStructuredText

.. _str: https://docs.python.org/2/library/stdtypes.html
.. _int: https://docs.python.org/2/library/stdtypes.html
.. _datetime: https://docs.python.org/2/library/stdtypes.html
.. _vim.alarm.Alarm: ../../vim/alarm/Alarm.rst
.. _vim.ManagedEntity: ../../vim/ManagedEntity.rst
.. _vim.alarm.AlarmSpec: ../../vim/alarm/AlarmSpec.rst
vim.alarm.AlarmInfo
===================
Attributes of an alarm.
:extends: vim.alarm.AlarmSpec_
Attributes:
key (`str`_):
The unique key.
alarm (`vim.alarm.Alarm`_):
The alarm object.
entity (`vim.ManagedEntity`_):
The entity on which the alarm is registered.
lastModifiedTime (`datetime`_):
The time the alarm was created or modified.
lastModifiedUser (`str`_):
User name that modified the alarm most recently.
creationEventId (`int`_):
The event ID that records the alarm creation.