com.vmware.vmc.model

Class Task.Builder

java.lang.Object

com.vmware.vmc.model.Task.Builder

Enclosing class:

Task

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

Builder class for Task.

Constructor Summary

Constructors

Constructor and Description
Builder(java.util.Calendar updated, java.lang.String userId, java.lang.String updatedByUserId, java.util.Calendar created, long version, java.lang.String userName, java.lang.String id) Constructor with parameters for the required properties of Task.

Method Summary

Modifier and Type	Method and Description
Task	build()
Task.Builder	setCorrelationId(java.lang.String correlationId) (Optional) Client provided uniqifier to make task creation idempotent.
Task.Builder	setCustomerErrorMessage(java.lang.String customerErrorMessage)
Task.Builder	setEndResourceEntityVersion(java.lang.Long endResourceEntityVersion) Entity version of the resource at the end of the task.
Task.Builder	setEndTime(java.util.Calendar endTime)
Task.Builder	setErrorMessage(java.lang.String errorMessage)
Task.Builder	setEstimatedRemainingMinutes(java.lang.Long estimatedRemainingMinutes) Estimated remaining time in minute of the task execution, < 0 means no estimation for the task.
Task.Builder	setLocalizedErrorMessage(java.lang.String localizedErrorMessage)
Task.Builder	setOrgId(java.lang.String orgId)
Task.Builder	setOrgType(java.lang.String orgType)
Task.Builder	setParams(Structure params)
Task.Builder	setParentTaskId(java.lang.String parentTaskId) If this task was created by another task - this provides the linkage.
Task.Builder	setPhaseInProgress(java.lang.String phaseInProgress) The current in progress phase ID in the task execution, if none in progress, empty string returned.
Task.Builder	setProgressPercent(java.lang.Long progressPercent) Estimated progress percentage the task executed format: int32
Task.Builder	setResourceId(java.lang.String resourceId) UUID of the resource the task is acting upon
Task.Builder	setResourceType(java.lang.String resourceType) Type of resource being acted upon
Task.Builder	setServiceErrors(java.util.List<ServiceError> serviceErrors) Service errors returned from SDDC services.
Task.Builder	setStartResourceEntityVersion(java.lang.Long startResourceEntityVersion) Entity version of the resource at the start of the task.
Task.Builder	setStartTime(java.util.Calendar startTime)
Task.Builder	setStatus(java.lang.String status) Possible values are: Task.STATUS_STARTED Task.STATUS_CANCELING Task.STATUS_FINISHED Task.STATUS_FAILED Task.STATUS_CANCELED
Task.Builder	setSubStatus(java.lang.String subStatus)
Task.Builder	setTaskProgressPhases(java.util.List<TaskProgressPhase> taskProgressPhases) Task progress phases involved in current task execution
Task.Builder	setTaskType(java.lang.String taskType)
Task.Builder	setTaskVersion(java.lang.String taskVersion)
Task.Builder	setUpdatedByUserName(java.lang.String updatedByUserName) User name that last updated this record

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(java.util.Calendar updated,
               java.lang.String userId,
               java.lang.String updatedByUserId,
               java.util.Calendar created,
               long version,
               java.lang.String userName,
               java.lang.String id)

Constructor with parameters for the required properties of Task.

Method Detail

setUpdatedByUserName

public Task.Builder setUpdatedByUserName(java.lang.String updatedByUserName)

User name that last updated this record

Parameters:

updatedByUserName - New value for the property.

setStatus

public Task.Builder setStatus(java.lang.String status)

Possible values are:

• Task.STATUS_STARTED
• Task.STATUS_CANCELING
• Task.STATUS_FINISHED
• Task.STATUS_FAILED
• Task.STATUS_CANCELED

Parameters:

status - New value for the property.

setLocalizedErrorMessage

public Task.Builder setLocalizedErrorMessage(java.lang.String localizedErrorMessage)

Parameters:

localizedErrorMessage - New value for the property.

setResourceId

public Task.Builder setResourceId(java.lang.String resourceId)

UUID of the resource the task is acting upon

Parameters:

resourceId - New value for the property.

setParentTaskId

public Task.Builder setParentTaskId(java.lang.String parentTaskId)

If this task was created by another task - this provides the linkage. Mostly for debugging.

Parameters:

parentTaskId - New value for the property.

setTaskVersion

public Task.Builder setTaskVersion(java.lang.String taskVersion)

Parameters:

taskVersion - New value for the property.

setCorrelationId

public Task.Builder setCorrelationId(java.lang.String correlationId)

(Optional) Client provided uniqifier to make task creation idempotent. Be aware not all tasks support this. For tasks that do - supplying the same correlation Id, for the same task type, within a predefined window will ensure the operation happens at most once.

Parameters:

correlationId - New value for the property.

setStartResourceEntityVersion

public Task.Builder setStartResourceEntityVersion(java.lang.Long startResourceEntityVersion)

Entity version of the resource at the start of the task. This is only set for some task types. format: int32

Parameters:

startResourceEntityVersion - New value for the property.

setCustomerErrorMessage

public Task.Builder setCustomerErrorMessage(java.lang.String customerErrorMessage)

Parameters:

customerErrorMessage - New value for the property.

setSubStatus

public Task.Builder setSubStatus(java.lang.String subStatus)

Parameters:

subStatus - New value for the property.

setTaskType

public Task.Builder setTaskType(java.lang.String taskType)

Parameters:

taskType - New value for the property.

setStartTime

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

Parameters:

startTime - New value for the property.

setTaskProgressPhases

public Task.Builder setTaskProgressPhases(java.util.List<TaskProgressPhase> taskProgressPhases)

Task progress phases involved in current task execution

Parameters:

taskProgressPhases - New value for the property.

setErrorMessage

public Task.Builder setErrorMessage(java.lang.String errorMessage)

Parameters:

errorMessage - New value for the property.

setOrgId

public Task.Builder setOrgId(java.lang.String orgId)

Parameters:

orgId - New value for the property.

setEndResourceEntityVersion

public Task.Builder setEndResourceEntityVersion(java.lang.Long endResourceEntityVersion)

Entity version of the resource at the end of the task. This is only set for some task types. format: int32

Parameters:

endResourceEntityVersion - New value for the property.

setServiceErrors

public Task.Builder setServiceErrors(java.util.List<ServiceError> serviceErrors)

Service errors returned from SDDC services.

Parameters:

serviceErrors - New value for the property.

setOrgType

public Task.Builder setOrgType(java.lang.String orgType)

Parameters:

orgType - New value for the property.

setEstimatedRemainingMinutes

public Task.Builder setEstimatedRemainingMinutes(java.lang.Long estimatedRemainingMinutes)

Estimated remaining time in minute of the task execution, < 0 means no estimation for the task. format: int32

Parameters:

estimatedRemainingMinutes - New value for the property.

setParams

public Task.Builder setParams(Structure params)

Parameters:

params - New value for the property.

setProgressPercent

public Task.Builder setProgressPercent(java.lang.Long progressPercent)

Estimated progress percentage the task executed format: int32

Parameters:

progressPercent - New value for the property.

setPhaseInProgress

public Task.Builder setPhaseInProgress(java.lang.String phaseInProgress)

The current in progress phase ID in the task execution, if none in progress, empty string returned.

Parameters:

phaseInProgress - New value for the property.

setResourceType

public Task.Builder setResourceType(java.lang.String resourceType)

Type of resource being acted upon

Parameters:

resourceType - New value for the property.

setEndTime

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

Parameters:

endTime - New value for the property.

build

public Task build()