Developer Documentation

FileInfo

The File.Info structure defines the uploaded file.


Properties

Required Property Name Type Description
required bytes_transferred integer

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

optional checksum_info FileChecksumInfo

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

optional error_message StdLocalizableMessage

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

optional keep_in_storage boolean

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.

required name string

The name of the file.

optional size integer

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.

optional source_endpoint ItemTransferEndpoint

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.

required source_type FileSourceType Enum

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

required status ItemTransferStatus Enum

The transfer status (TransferStatus) of this file.

optional upload_endpoint ItemTransferEndpoint

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.

Property of


File_Add_ResponseBody
Feedback

Was this page helpful?