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

1.6 KiB

vim.vm.FileLayoutEx.FileInfo

Basic information about a file.

extends

vmodl.DynamicData

since

vSphere API 4.0

Attributes:

key (int):

Key to reference this file.

name (str):

Name of the file, including the complete datastore path.

type (str):

Type of the file. VirtualMachineFileLayoutExFileType lists all valid values.

size (long):

Size of the file in bytes.

uniqueSize (long, optional):

Size of the file in bytes corresponding to the file blocks that were allocated uniquely. In other words, if the underlying storage supports sharing of file blocks across disk files, the property corresponds to the size of the file blocks that were allocated only in context of this file, i.e. it does not include shared blocks that were allocated in other files. This property will be unset if the underlying implementation is unable to compute this information. One example of this is when the file resides on a NAS datastore whose underlying storage doesn't support this metric. In some cases the field might be set but the value could be over-estimated due to the inability of the NAS based storage to provide an accurate value.