com.vmware.appliance.vcenter.settings.v1

Class TaskInfo.Builder

java.lang.Object

com.vmware.appliance.vcenter.settings.v1.TaskInfo.Builder

Enclosing class:

TaskInfo

public static final class TaskInfo.Builder
extends java.lang.Object

Builder class for TaskInfo.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
TaskInfo	build()
TaskInfo.Builder	setEndTime(java.util.Calendar endTime) Time when the operation is completed.
TaskInfo.Builder	setError(ApiError error) Description of the error if the operation status is "FAILED".
TaskInfo.Builder	setNotifications(Notifications notifications) Notifications to the user.
TaskInfo.Builder	setParent(java.lang.String parent) Parent of the current task.
TaskInfo.Builder	setProgress(Progress progress) Progress of the operation.
TaskInfo.Builder	setResult(DataValue result) Task result.
TaskInfo.Builder	setStartTime(java.util.Calendar startTime) Time when the operation is started.
TaskInfo.Builder	setTarget(DynamicID target) Identifier of the target created by the operation or an existing one the operation performed on.
TaskInfo.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

Builder

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

Constructor with parameters for the required properties of TaskInfo.

Method Detail

setProgress

public TaskInfo.Builder setProgress(Progress progress)

Progress of the operation. Warning: This property is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. 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.

setNotifications

public TaskInfo.Builder setNotifications(Notifications notifications)

Notifications to the user. Warning: This property is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. Only Set if the notifications were reported by this particular task.

Parameters:

notifications - New value for the property.

setResult

public TaskInfo.Builder setResult(DataValue result)

Task result. Warning: This property is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. This property will be null if the task has no result.

Parameters:

result - New value for the property.

setParent

public TaskInfo.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 TaskInfo.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 TaskInfo.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 TaskInfo.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 TaskInfo.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 TaskInfo.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 TaskInfo build()