com.vmware.appliance.recovery.reconciliation

Class JobTypes.Info.Builder

java.lang.Object

com.vmware.appliance.recovery.reconciliation.JobTypes.Info.Builder

Enclosing class:

JobTypes.Info

public static final class JobTypes.Info.Builder
extends java.lang.Object

Builder class for JobTypes.Info.

Constructor Summary

Constructors

Constructor and Description
Builder(LocalizableMessage description, java.lang.String service, java.lang.String operation, JobTypes.Status status, java.util.List<LocalizableMessage> messages, long progress) Constructor with parameters for the required properties of JobTypes.Info.

Method Summary

Modifier and Type	Method and Description
JobTypes.Info	build()
JobTypes.Info.Builder	setCancelable(java.lang.Boolean cancelable) Flag to indicate whether or not the operation can be cancelled.
JobTypes.Info.Builder	setEndTime(java.util.Calendar endTime) Time when the operation is completed.
JobTypes.Info.Builder	setError(ApiError error) Description of the error if the operation status is "FAILED".
JobTypes.Info.Builder	setParent(java.lang.String parent) Parent of the current task.
JobTypes.Info.Builder	setStartTime(java.util.Calendar startTime) Time when the operation is started.
JobTypes.Info.Builder	setTarget(DynamicID target) Identifier of the target resource the operation modifies.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder(LocalizableMessage description,
               java.lang.String service,
               java.lang.String operation,
               JobTypes.Status status,
               java.util.List<LocalizableMessage> messages,
               long progress)

Constructor with parameters for the required properties of JobTypes.Info.

Method Detail

setParent

public JobTypes.Info.Builder setParent(java.lang.String parent)

Parent of the current task. This property was added in vSphere API 6.7. This property will be null if the task has no parent.

Parameters:

parent - New value for the property. When clients pass a value of this class as a parameter, the property must be an identifier for the resource type: com.vmware.appliance.recovery.reconciliation.job. When methods return a value of this class as a return value, the property will be an identifier for the resource type: com.vmware.appliance.recovery.reconciliation.job.

setTarget

public JobTypes.Info.Builder setTarget(DynamicID target)

Identifier of the target resource the operation modifies. This property was added in vSphere API 6.7. This property will be null if the task has multiple targets or no target.

Parameters:

target - New value for the property.

setCancelable

public JobTypes.Info.Builder setCancelable(java.lang.Boolean cancelable)

Flag to indicate whether or not the operation can be cancelled. The value may change as the operation progresses. This property was added in vSphere API 6.7. If null, the operation cannot be canceled.

Parameters:

cancelable - New value for the property.

setError

public JobTypes.Info.Builder setError(ApiError error)

Description of the error if the operation status is "FAILED". This property was added in vSphere API 6.7. If null the description of why the operation failed will be included in the result of the operation (see Info#result).

Parameters:

error - New value for the property.

setStartTime

public JobTypes.Info.Builder setStartTime(java.util.Calendar startTime)

Time when the operation is started. This property was added in vSphere API 6.7. This property is optional and it is only relevant when the value of getStatus() is one of JobTypes.Status.RUNNING, JobTypes.Status.SUCCEEDED, or JobTypes.Status.FAILED.

Parameters:

startTime - New value for the property.

setEndTime

public JobTypes.Info.Builder setEndTime(java.util.Calendar endTime)

Time when the operation is completed. This property was added in vSphere API 6.7. This property is optional and it is only relevant when the value of getStatus() is one of JobTypes.Status.SUCCEEDED or JobTypes.Status.FAILED.

Parameters:

endTime - New value for the property.

build

public JobTypes.Info build()