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

37 lines
1.2 KiB
ReStructuredText

.. _str: https://docs.python.org/2/library/stdtypes.html
.. _vim.Description: ../../vim/Description.rst
.. _vmodl.DynamicData: ../../vmodl/DynamicData.rst
.. _DiagnosticManagerLogFormat: ../../vim/DiagnosticManager/LogDescriptor/Format.rst
.. _DiagnosticManagerLogCreator: ../../vim/DiagnosticManager/LogDescriptor/Creator.rst
vim.DiagnosticManager.LogDescriptor
===================================
Describes a log file that is available on a server.
:extends: vmodl.DynamicData_
Attributes:
key (`str`_):
A key to identify the log file for browsing and download operations.
fileName (`str`_):
The filename of the log.
creator (`str`_):
The application that generated the log file. For more information on currently supported creators, see `DiagnosticManagerLogCreator`_ .
format (`str`_):
Describes the format of the log file. For more information on currently supported formats, see `DiagnosticManagerLogFormat`_ .
mimeType (`str`_):
Describes the mime-type of the returned file. Typical mime-types include:
* text/plain - for a plain log file
info (`vim.Description`_):
Localized description of log file.