LibraryItemDownloadSessionModel

The DownloadSessionModel structure provides information on an active DownloadSession resource.


Properties

integer as int64
client_progress Optional

The progress that has been made with the download. This property is to be updated by the client during the download process to indicate the progress of its work in completing the download. The initial progress is 0 until updated by the client. The maximum value is 100, which indicates that the download is complete. This field is not used for the create operation. It will always be present in the result of the get or list operations. It is optional for the update operation.


error_message Optional

If the session is in the ERROR status this property will have more details about the error. This field is not used for the create operation. It is optional in the result of the get or list operations. It is not used for the update operation.


string as date-time
expiration_time Optional

Indicates the time after which the session will expire. The session is guaranteed not to expire before this time. This field is not used for the create operation. It will always be present in the result of the get or list operations. It is not used for the update operation.


string
id Optional

The identifier of this download session. This field is not used for the create operation. It will not be present in the result of the get or list operations. It is not used for the update operation. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.content.library.item.DownloadSession. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.content.library.item.DownloadSession.


string
library_item_content_version Optional

The content version of the library item whose content is being downloaded. This value is the ItemModel.content-version at the time when the session is created for the library item. This field is not used for the create operation. It will always be present in the result of the get or list operations. It is not used for the update operation.


string
library_item_id Optional

The identifier of the library item whose content is being downloaded. This field must be provided for the create operation. It will always be present in the result of the get or list operations. It is not used for the update operation. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.content.library.Item. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.content.library.Item.


state Optional

The current state (State) of the download session. This field is not used for the create operation. It will always be present in the result of the get or list operations. It is not used for the update operation.

Possible values are: ACTIVECANCELEDERROR

JSON Example

{
    "client_progress": 0,
    "error_message": {
        "args": [
            "string"
        ],
        "default_message": "string",
        "id": "string",
        "localized": "string",
        "params": {
            "key": {
                "d": 0,
                "dt": "string",
                "format": "enum",
                "i": 0,
                "l": {
                    "id": "string",
                    "params": "StdLocalizationParam Object"
                },
                "precision": 0,
                "s": "string"
            }
        }
    },
    "expiration_time": "string",
    "id": "string",
    "library_item_content_version": "string",
    "library_item_id": "string",
    "state": "enum"
}
Feedback

Was this page helpful?