RecoveryBackupJobDetailsInfo

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


Properties

string
operation Required

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.


boolean
cancelable Required

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


description Required

Description of the operation associated with the task.


type Required

The Details.Type enumerated type defines the type of backup job.
SCHEDULED : Job type is Scheduled.
MANUAL : Job type is Manual.

Possible values are: SCHEDULEDMANUAL


status Required

Status of the operation associated with the task.


string
service Required

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.


string as uri
location Required

URL of the backup location.


string
location_user Required

The username for the remote backup location.


messages Required

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


build Optional

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


string
parent Optional

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.


progress Optional

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


object
error Optional

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).


integer as int64
size Optional

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


string as date-time
start_time Optional

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.


string as date-time
end_time Optional

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.


target Optional

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.


integer as int64
duration Optional

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 CommonInfo#status is one of SUCCEEDED, FAILED, or RUNNING.


string
user Optional

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,
	"description": {
		"args": [
			"string"
		],
		"default_message": "string",
		"id": "string"
	},
	"location": "string",
	"location_user": "string",
	"messages": [
		{
			"args": [
				"string"
			],
			"default_message": "string",
			"id": "string"
		}
	],
	"operation": "string",
	"service": "string",
	"status": "enum",
	"type": "SCHEDULED"
}

Feedback

Was this page helpful?