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

754 B

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.