LibraryItemUpdatesessionFileInfo

The File.Info structure defines the uploaded file.


Properties

integer as int64
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 as int64
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 File.SourceType enumerated type defines how the file content is retrieved.
NONE : No source type has been requested.
PUSH : The client is uploading content using HTTP(S) PUT requests.
PULL : The server is pulling content from a URL. The URL scheme can be http, https, file, or ds.

Possible values are: NONEPUSHPULL


status Required

The TransferStatus enumerated type defines the transfer state of a file.
WAITING_FOR_TRANSFER : Indicates that a file has been defined for a library item and its content needs to be uploaded.
TRANSFERRING : Indicates that data is being transferred to the file.
READY : Indicates that the file has been fully transferred and is ready to be used.
VALIDATING : Indicates that the file is being validated (checksum, type adapters).
ERROR : Indicates that there was an error transferring or validating the file.

Possible values are: WAITING_FOR_TRANSFERTRANSFERRINGREADYVALIDATINGERROR


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": "NONE",
	"status": "WAITING_FOR_TRANSFER"
}

Feedback

Was this page helpful?