LibraryItemUpdateSessionModel

The UpdateSessionModel structure provides information on an active UpdateSession resource.


Properties

integer as int64
client_progress Optional

The progress that has been made with the upload. This property is to be updated by the client during the upload process to indicate the progress of its work in completing the upload. The initial progress is 0 until updated by the client. The maximum value is 100, which indicates that the update 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 not used 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 earlier than 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 update 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.UpdateSession. 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.UpdateSession.


string
library_item_content_version Optional

The content version of the library item whose content is being modified. 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 to which content will be uploaded or removed. 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.


preview_info Optional

A preview of the files currently being uploaded in the session. This property will be set only when the session is in the ACTIVE. This field is optional and it is only relevant when the value of UpdateSessionModel.state is ACTIVE.


state Optional

The current state (State) of the update 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: ACTIVEDONEERRORCANCELED


warning_behavior Optional

Indicates the update session behavior if warnings are raised in the session preview. Any warning which is raised by session preview but not ignored by the client will, by default, fail the update session. This field is optional for the create operation. It is optional in the result of the get or list operations. It is optional for the update operation.

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",
    "preview_info": {
        "certificate_info": {
            "issuer": "string",
            "self_signed": false,
            "subject": "string",
            "x509": "string"
        },
        "state": "enum",
        "warnings": [
            {
                "ignored": false,
                "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"
                        }
                    }
                },
                "type": "enum"
            }
        ]
    },
    "state": "enum",
    "warning_behavior": [
        {
            "ignored": false,
            "type": "enum"
        }
    ]
}
Feedback

Was this page helpful?