LibraryItemStorageInfo

The Storage.Info structure is the expanded form of File.Info that includes details about the storage backing for a file in a library item.


Properties

Required Property Name Type Description
required cached boolean

Indicates whether the file is on disk or not.

optional checksum_info LibraryItemFileChecksumInfo

A checksum for validating the content of the file. This value can be used to verify that a transfer was completed without errors.

A checksum cannot always be calculated, and the value will be unset if the file does not have content.

required name string

The name of the file. This value will be unique within the library item for each file. It cannot be an empty string.

required size integer

The file size, in bytes. The file size is the storage used and not the uploaded or provisioned size. For example, when uploading a disk to a datastore, the amount of storage that the disk consumes may be different from the disk file size. When the file is not cached, the size is 0.

required storage_backing LibraryStorageBacking

The storage backing on which this object resides. This might not be the same as the default storage backing associated with the library.

required storage_uris array of string

URIs that identify the file on the storage backing. These URIs may be specific to the backing and may need interpretation by the client. A client that understands a URI scheme in this list may use that URI to directly access the file on the storage backing. This can provide high-performance support for file manipulation.

required version string

The version of this file; incremented when a new copy of the file is uploaded.

JSON Example

{
    "cached": false,
    "name": "string",
    "size": 0,
    "storage_backing": {},
    "storage_uris": [
        "string"
    ],
    "version": "string"
}
Feedback

Was this page helpful?