
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
23 lines
754 B
ReStructuredText
23 lines
754 B
ReStructuredText
.. _str: https://docs.python.org/2/library/stdtypes.html
|
|
|
|
.. _bool: https://docs.python.org/2/library/stdtypes.html
|
|
|
|
.. _vmodl.DynamicData: ../vmodl/DynamicData.rst
|
|
|
|
|
|
vim.UserSearchResult
|
|
====================
|
|
When searching for users, the search results in some additional information. This object describes the additional information.
|
|
:extends: vmodl.DynamicData_
|
|
|
|
Attributes:
|
|
principal (`str`_):
|
|
|
|
Login name of a user or the name of a group. This key is the user within the searched domain.
|
|
fullName (`str`_, optional):
|
|
|
|
Full name of the user found by the search, or the description of a group, if available.
|
|
group (`bool`_):
|
|
|
|
If this is true, then the result is a group. If this is false, then the result is a user.
|