com.vmware.vcenter

Class DeploymentTypes.Task.Builder

java.lang.Object

com.vmware.vcenter.DeploymentTypes.Task.Builder

Enclosing class:

DeploymentTypes.Task

public static final class DeploymentTypes.Task.Builder
extends java.lang.Object

Builder class for DeploymentTypes.Task.

Constructor Summary

Constructors

Constructor and Description
DeploymentTypes.Task.Builder(LocalizableMessage description, java.lang.String service, java.lang.String operation, Status status, boolean cancelable) Constructor with parameters for the required properties of DeploymentTypes.Task.

Method Summary

Methods

Modifier and Type	Method and Description
DeploymentTypes.Task	build()
DeploymentTypes.Task.Builder	setEndTime(java.util.Calendar endTime) Time when the operation is completed.
DeploymentTypes.Task.Builder	setError(ApiError error) Description of the error if the operation status is "FAILED".
DeploymentTypes.Task.Builder	setParent(java.lang.String parent) Parent of the current task.
DeploymentTypes.Task.Builder	setProgress(Progress progress) The progress info of this deployment task.
DeploymentTypes.Task.Builder	setResult(Notifications result) Result of the task.
DeploymentTypes.Task.Builder	setStartTime(java.util.Calendar startTime) Time when the operation is started.
DeploymentTypes.Task.Builder	setTarget(DynamicID target) Identifier of the target created by the operation or an existing one the operation performed on.
DeploymentTypes.Task.Builder	setUser(java.lang.String user) Name of the user who performed the operation.

Methods inherited from class java.lang.Object

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

Constructor Detail

DeploymentTypes.Task.Builder

public DeploymentTypes.Task.Builder(LocalizableMessage description,
                            java.lang.String service,
                            java.lang.String operation,
                            Status status,
                            boolean cancelable)

Constructor with parameters for the required properties of DeploymentTypes.Task.

Method Detail

setProgress

public DeploymentTypes.Task.Builder setProgress(Progress progress)

The progress info of this deployment task. This property was added in vSphere API 6.7. This property is optional and it is only relevant when the value of #status is one of Status.RUNNING, Status.BLOCKED, Status.SUCCEEDED, or Status.FAILED.

Parameters:

progress - New value for the property.

setResult

public DeploymentTypes.Task.Builder setResult(Notifications result)

Result of the task. This property was added in vSphere API 6.7. This property will be null if result is not available at the current step of the task.

Parameters:

result - New value for the property.

setParent

public DeploymentTypes.Task.Builder setParent(java.lang.String parent)

Parent of the current task. 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.cis.task. When methods return a value of this class as a return value, the property will be an identifier for the resource type: com.vmware.cis.task.

setTarget

public DeploymentTypes.Task.Builder setTarget(DynamicID target)

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

Parameters:

target - New value for the property.

setError

public DeploymentTypes.Task.Builder setError(ApiError error)

Description of the error if the operation status is "FAILED". If null the description of why the operation failed will be included in the result of the operation (see Info.getResult()).

Parameters:

error - New value for the property.

setStartTime

public DeploymentTypes.Task.Builder setStartTime(java.util.Calendar startTime)

Time when the operation is started. This property is optional and it is only relevant when the value of getStatus() is one of Status.RUNNING, Status.BLOCKED, Status.SUCCEEDED, or Status.FAILED.

Parameters:

startTime - New value for the property.

setEndTime

public DeploymentTypes.Task.Builder setEndTime(java.util.Calendar endTime)

Time when the operation is completed. This property is optional and it is only relevant when the value of getStatus() is one of Status.SUCCEEDED or Status.FAILED.

Parameters:

endTime - New value for the property.

setUser

public DeploymentTypes.Task.Builder setUser(java.lang.String user)

Name of the user who performed the operation. This property will be null if the operation is performed by the system.

Parameters:

user - New value for the property.

build

public DeploymentTypes.Task build()