UpgradeStatus

Description

An object that represents upgrade status information. (Note: The field level constraints listed here might not cover all the constraints on the field. Additional constraints might exist.)

Supported Operations

Model Properties

Property Required Type Description
state False string An enumerated field that can be IN_PROGRESS, FAILED, COMPLETED
upgradePackageFilename False string A String specifying the name of the upgrade package file
updateType False string A String value that indicates the upgrade type: major (that is, A.x), maintence (A.x.y), patch (A.x.y.z)
baseVersion False string A String specifying the base version of the operating system
targetVersion False string A String specifying the target version of the operating system
canCancel False boolean A Boolean specifying if the operation can be cancelled
canRetry False boolean A Boolean specifying if the operation can be retried
cancelOnFailure False boolean A Boolean inherited from Upgrade API indicating if the operation will be automatically canceled if it fails
message False string A String showing the status information
detailedFailure False string A String providing the detailed information of failure
startTime False string A String indicating starting time of the operation, in ISO8601 extended format
endTime False string A String indicating ending time of the operation, in ISO8601 extended format
progressPercent False integer An Integer indicating the percentage of the operation progress
timeRemainingInSeconds False integer An Integer showing the time remaining for the operation in seconds
elapsedTimeInSeconds False integer An Integer showing the time already taken by the operation in seconds
cumulativeMessages False [object] A List of log messages
id False string A unique string identifier assigned by the system when the object is created. No assumption can be made on the format or content of this identifier. The identifier must be provided whenever attempting to modify/delete (or reference) an existing object.
Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
type True string A UTF8 string, all letters lower-case, that represents the class-type. This corresponds to the class name.