Library_Item_Updatesession_File_Info

Library_Item_Updatesession_File_Info
Library_Item_Updatesession_File_Info

The File.Info structure defines the uploaded file.

JSON Example
{
    "name": "string",
    "source_type": "string",
    "size": 0,
    "checksum_info": {
        "algorithm": "string",
        "checksum": "string"
    },
    "source_endpoint": {
        "uri": "string",
        "ssl_certificate_thumbprint": "string"
    },
    "upload_endpoint": {
        "uri": "string",
        "ssl_certificate_thumbprint": "string"
    },
    "bytes_transferred": 0,
    "status": "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"
    },
    "keep_in_storage": false
}
string
name
Required

The name of the file.

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.

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.

checksum_info
Optional

Provides checksums for a File.Info object.

source_endpoint
Optional

The TransferEndpoint structure encapsulates a URI along with extra information about it.

upload_endpoint
Optional

The TransferEndpoint structure encapsulates a URI along with extra information about it.

integer As int64
bytes_transferred
Required

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

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.

error_message
Optional

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.

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.