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

2.0 KiB

vim.profile.ProfileMetadata

This data object represents the metadata information of a Profile.

extends

vmodl.DynamicData

since

vSphere API 4.0

Attributes:

key (str):

Type of the Profile

profileTypeName (str, optional):

Type identifier for the ApplyProfile

description (vim.ExtendedDescription, optional):

Property which describes the profile

sortSpec (vim.profile.ProfileMetadata.ProfileSortSpec, optional):

Property that determines a sorting order for display purposes. If the list contains more than one sort spec, then the precedence should be determined by the list order (i.e. sort first by the first spec in the list, then sort by the second spec in the list, etc).

profileCategory (str, optional):

Identifies the profile category that this subprofile is a part of. The value of this string should correspond to the key value of a ProfileCategoryMetadata object's key in its id property.

profileComponent (str, optional):

Property indicating that the subprofile described by thisProfileMetadataobject is declared in the profileTypeNames of the specified profile component. The value of this property should correspond to the key value of the ProfileComponentMetadata object's key in its id property. This property should not be present for subprofiles that are not directly declared in the profileTypeNames property of a ProfileComponentMetadata object.