Library_Item_DownloadSessionModel
The DownloadSessionModel structure provides information on an active DownloadSession resource.
{
"id": "string",
"library_item_id": "string",
"library_item_content_version": "string",
"error_message": {
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": {
"id": "string",
"params": {
"params": "Std_LocalizationParam Object"
}
},
"format": "string",
"precision": 0
}
},
"localized": "string"
},
"client_progress": 0,
"state": "string",
"expiration_time": "string"
}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.
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.
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.
The LocalizableMessage structure represents localizable string and message template. Services include one or more localizable message templates in the errors they report so that clients can display diagnostic messages in the native language of the user. Services can include localizable strings in the data returned from operations to allow clients to display localized status information in the native language of the user.
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.
The state of the download session.
ACTIVE : The session is active. Individual files may be in the process of being transferred and may become ready for download at different times.
CANCELED : The session has been canceled. On-going downloads may fail. The session will stay in this state until it is either deleted by the user or automatically cleaned up by the Content Library Service.
ERROR : Indicates there was an error during the session lifecycle.
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.