Library_Item_Storage_Info

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.

JSON Example

{
    "storage_backing": {
        "type": "string",
        "datastore_id": "string",
        "storage_uri": "string"
    },
    "storage_uris": [
        "string"
    ],
    "checksum_info": {
        "algorithm": "string",
        "checksum": "string"
    },
    "name": "string",
    "size": 0,
    "cached": false,
    "version": "string"
}

Library_StorageBacking

storage_backing

Required

The StorageBacking structure defines a storage location where content in a library will be stored. The storage location can either be a Datastore or Other type.

array of string

storage_uris

Required

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.

Library_Item_File_ChecksumInfo

checksum_info

Optional

Provides checksums for a File.Info object.

string

name

Required

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

integer As int64

size

Required

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.

boolean

cached

Required

Indicates whether the file is on disk or not.

string

version

Required

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