ContentLibraryItem

ContentLibraryItem
ContentLibraryItem

An object representing a VCF Content Library Item.

JSON Example
{
    "id": "string",
    "name": "string",
    "imageIdentifier": "string",
    "description": "string",
    "isPublished": false,
    "isSubscribed": false,
    "creationDate": "string",
    "lastSuccessfulSync": "string",
    "version": 0,
    "status": "READY, NOT_READY, FAILED, PARTIALLY_READY",
    "contentLibrary": {
        "name": "string",
        "id": "string"
    },
    "org": {
        "name": "string",
        "id": "string"
    },
    "fileUploadSizeBytes": 0,
    "sizeBytes": 0,
    "itemType": "string",
    "placeholder": false
}
string
id
Optional

A unique identifier for the library item.

string
name
Required

The name of the content library item.

string
imageIdentifier
Optional

VirtualMachineIdentifier (VMI) of the item. This is a ReadOnly field.

string
description
Optional

The description of the content library item.

boolean
isPublished
Optional

Whether this item is published.

boolean
isSubscribed
Optional

Whether this item is subscribed.

string As date-time As date-time
creationDate
Optional

The ISO-8601 timestamp representing when this item was created.

string As date-time As date-time
lastSuccessfulSync
Optional

The ISO-8601 timestamp representing when this item was last synced if subscribed.

integer As int64 As int64
version
Optional

The version of this item. For a subscribed library, this version is same as in publisher library.

string
status
Optional

Status of this content library item.

contentLibrary
Required

Entity reference used to describe VCD entities

org
Optional

Entity reference used to describe VCD entities

integer As int64 As int64
fileUploadSizeBytes
Optional
Constraints: minimum: 1

Indicative size of the content library item as provided by the client before to upload. This value is only required for ISO content library items however when provided the value is used to provide immediate storage quotas validation. Actual value consumed may differ down the line.

integer As int64 As int64
sizeBytes
Optional
Constraints: minimum: 1

Read-only. Represents the size of the VM image as it is currently stored, measured in bytes. This value reflects the storage consumed by single instance of the image and explicitly excludes any additional storage due to the image being replicated to be made available across infrastructure shard such as Regions and Zones.

string
itemType
Required

The type of content library item. This field is only required for content library upload.

boolean
placeholder
Optional

A value of true represents an item that has not been uploaded yet but is holding storage allocation. Typically used to reserve necessary storage capacity during capture operation.