LibraryItemUpdatesessionFileInfo

The File.Info structure defines the uploaded file.


Properties

integer
bytes_transferred Required

The number of bytes of this file that have been received by the server.


checksum_info Optional

The checksum information of the file received by the server. If unset, the server does not verify the checksum.


error_message Optional

Details about the transfer error. An error message is set if the status is ERROR.


boolean
keep_in_storage Optional

Whether or not the file will be kept in storage upon update session completion. The flag is true for most files, and false for metadata files such as manifest and certificate file of update session with library item type OVF. Any file with File.Info.keep-in-storage set to false will not show up in the list of files returned from File.list upon update session completion. If unset, the file will be kept in storage upon update session completion.


string
name Required

The name of the file.


integer
size Optional

The file size, in bytes as received by the server. This field is guaranteed to be set when the server has completely received the file. This field won’t be set until the file status is READY.


source_endpoint Optional

A source endpoint from which to retrieve the file. This field is optional and it is only relevant when the value of File.Info.source-type is PULL.


source_type Required

The source type (SourceType) from which the file is being retrieved. This may be NONE if the file is not being changed.


status Required

The transfer status (TransferStatus) of this file.


upload_endpoint Optional

An upload endpoint to which the client can push the content. This field is optional and it is only relevant when the value of File.Info.source-type is PUSH.

JSON Example

{
    "bytes_transferred": 0,
    "name": "string",
    "source_type": "enum",
    "status": "enum"
}
Feedback

Was this page helpful?