RecoveryBackupJobDetailsInfo

The Details.Info structure contains information about a backup job.


Properties

Required Property Name Type Description
optional build RecoveryBackupJobDetailsBuildInfo

Information about the build of the appliance. This field is optional because it was added in a newer version than its parent node.

required cancelable boolean

Flag to indicate whether or not the operation can be cancelled. The value may change as the operation progresses.

required description StdLocalizableMessage

Description of the operation associated with the task.

optional duration integer

Time in seconds since the backup job was started or the time it took to complete the backup job. This field is optional and it is only relevant when the value of #status is one of SUCCEEDED, FAILED, or RUNNING.

optional end_time string

Time when the operation is completed. This field is optional and it is only relevant when the value of CommonInfo.status is one of SUCCEEDED or FAILED.

optional error object

Description of the error if the operation status is “FAILED”. If unset the description of why the operation failed will be included in the result of the operation (see Info.result).

required location string

URL of the backup location.

required location_user string

The username for the remote backup location.

required messages array of StdLocalizableMessage

List of any info/warning/error messages returned by the backup job.

required operation string

Identifier of the operation associated with the task. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.vapi.operation. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.vapi.operation.

optional parent string

Parent of the current task. This field will be unset if the task has no parent. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.cis.task. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.cis.task.

optional progress TaskProgress

Progress of the job. This field is optional and it is only relevant when the value of #status is one of SUCCEEDED, FAILED, or RUNNING.

required service string

Identifier of the service containing the operation. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.vapi.service. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.vapi.service.

optional size integer

Size of the backup data transferred to remote location. This field is optional and it is only relevant when the value of #status is one of SUCCEEDED, FAILED, or RUNNING.

optional start_time string

Time when the operation is started. This field is optional and it is only relevant when the value of CommonInfo.status is one of RUNNING, BLOCKED, SUCCEEDED, or FAILED.

required status TaskStatus

Status of the operation associated with the task.

optional target StdDynamicID

Identifier of the target created by the operation or an existing one the operation performed on. This field will be unset if the operation has no target or multiple targets.

required type RecoveryBackupJobDetailsType Enum

Type of the backup job. Indicates whether the backup was started manually or as a scheduled backup.

optional user string

Name of the user who performed the operation. This field will be unset if the operation is performed by the system.

JSON Example

{
    "cancelable": false,
    "location": "string",
    "location_user": "string",
    "operation": "string",
    "service": "string",
    "type": "enum"
}
Feedback

Was this page helpful?