com.vmware.cis.task

Class Info.Builder

java.lang.Object

com.vmware.cis.task.Info.Builder

Enclosing class:

Info

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

Builder class for Info.

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

Method Summary

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

Method Detail

setProgress

public Info.Builder setProgress(Progress progress)

Progress of the operation. 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 Info.Builder setResult(DataValue result)

Result of the operation. If an operation reports partial results before it completes, this property could be Set before the CommonInfo.getStatus() has the value Status.SUCCEEDED. The value could change as the operation progresses. This property was added in vSphere API 6.7. This property will be null if the operation does not return a result or if the result is not available at the current step of the operation.

Parameters:

result - New value for the property.

setParent

public 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.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 Info.Builder setTarget(DynamicID target)

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

Parameters:

target - New value for the property.

setError

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

Parameters:

error - New value for the property.

setStartTime

public 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 Status.RUNNING, Status.BLOCKED, Status.SUCCEEDED, or Status.FAILED.

Parameters:

startTime - New value for the property.

setEndTime

public 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 Status.SUCCEEDED or Status.FAILED.

Parameters:

endTime - New value for the property.

setUser

public Info.Builder setUser(java.lang.String user)

Name of the user who performed the operation. This property was added in vSphere API 6.7. This property will be null if the operation is performed by the system.

Parameters:

user - New value for the property.

build

public Info build()