public final class Task extends java.lang.Object implements java.io.Serializable, StaticStructure
Modifier and Type | Class and Description |
---|---|
static class |
Task.Builder
Builder class for
Task . |
Modifier and Type | Field and Description |
---|---|
protected StructValue |
__dynamicStructureFields |
static java.lang.String |
STATUS_CANCELED |
static java.lang.String |
STATUS_CANCELING |
static java.lang.String |
STATUS_FAILED |
static java.lang.String |
STATUS_FINISHED |
static java.lang.String |
STATUS_STARTED |
Modifier | Constructor and Description |
---|---|
|
Task()
Default constructor.
|
protected |
Task(StructValue __dynamicStructureFields) |
Modifier and Type | Method and Description |
---|---|
<T extends Structure> |
_convertTo(java.lang.Class<T> clazz)
Converts this structure into an instance of the provided class structure
if possible.
|
java.lang.String |
_getCanonicalName()
Returns the canonical name of the structure.
|
static java.lang.String |
_getCanonicalTypeName()
Returns the canonical type name.
|
static com.vmware.vapi.bindings.type.StructType |
_getClassType()
WARNING: Internal method, subject to change in future versions.
|
StructValue |
_getDataValue()
Returns this
Structure represented in the dynamic
DataValue model. |
DataValue |
_getDynamicField(java.lang.String fieldName)
Get a dynamic field value, doesn't allow access to static fields (which
have getters/setters).
|
java.util.Set<java.lang.String> |
_getDynamicFieldNames()
Get the names of the dynamic fields in the structure.
|
com.vmware.vapi.bindings.type.StructType |
_getType()
WARNING: Internal method, subject to change in future versions.
|
boolean |
_hasTypeNameOf(java.lang.Class<? extends Structure> clazz)
Checks if the runtime type name of this structure matches the type
represented by the specified binding class.
|
static Task |
_newInstance(StructValue structValue)
WARNING: Internal method, subject to change in future versions.
Returns new instance of this binding class and injects the provided data value. WARNING: The returned object is not fully initialized. |
static Task |
_newInstance2(StructValue structValue)
WARNING: Internal method, subject to change in future versions.
Serves as a versioning mechanism. |
void |
_setDynamicField(java.lang.String fieldName,
DataValue fieldValue)
Sets a dynamic field value.
|
protected void |
_updateDataValue(StructValue structValue) |
void |
_validate()
Validates the state of the discriminated unions and HasFieldsOf
restrictions (if any) in this Java language binding
Structure . |
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getCorrelationId()
(Optional) Client provided uniqifier to make task creation idempotent.
|
java.util.Calendar |
getCreated() |
java.lang.String |
getCustomerErrorMessage() |
java.lang.Long |
getEndResourceEntityVersion()
Entity version of the resource at the end of the task.
|
java.util.Calendar |
getEndTime() |
java.lang.String |
getErrorMessage() |
java.lang.Long |
getEstimatedRemainingMinutes()
Estimated remaining time in minute of the task execution, < 0 means no
estimation for the task.
|
java.lang.String |
getId()
Unique ID for this entity
|
java.lang.String |
getLocalizedErrorMessage() |
java.lang.String |
getOrgId() |
java.lang.String |
getOrgType() |
Structure |
getParams() |
java.lang.String |
getParentTaskId()
If this task was created by another task - this provides the linkage.
|
java.lang.String |
getPhaseInProgress()
The current in progress phase ID in the task execution, if none in progress,
empty string returned.
|
java.lang.Long |
getProgressPercent()
Estimated progress percentage the task executed format: int32
|
java.lang.String |
getResourceId()
UUID of the resource the task is acting upon
|
java.lang.String |
getResourceType()
Type of resource being acted upon
|
java.util.List<ServiceError> |
getServiceErrors()
Service errors returned from SDDC services.
|
java.lang.Long |
getStartResourceEntityVersion()
Entity version of the resource at the start of the task.
|
java.util.Calendar |
getStartTime() |
java.lang.String |
getStatus()
|
java.lang.String |
getSubStatus() |
java.util.List<TaskProgressPhase> |
getTaskProgressPhases()
Task progress phases involved in current task execution
|
java.lang.String |
getTaskType() |
java.lang.String |
getTaskVersion() |
java.util.Calendar |
getUpdated() |
java.lang.String |
getUpdatedByUserId()
User id that last updated this record
|
java.lang.String |
getUpdatedByUserName()
User name that last updated this record
|
java.lang.String |
getUserId()
User id that last updated this record
|
java.lang.String |
getUserName()
User name that last updated this record
|
long |
getVersion()
Version of this entity format: int32
|
int |
hashCode() |
void |
setCorrelationId(java.lang.String correlationId)
(Optional) Client provided uniqifier to make task creation idempotent.
|
void |
setCreated(java.util.Calendar created) |
void |
setCustomerErrorMessage(java.lang.String customerErrorMessage) |
void |
setEndResourceEntityVersion(java.lang.Long endResourceEntityVersion)
Entity version of the resource at the end of the task.
|
void |
setEndTime(java.util.Calendar endTime) |
void |
setErrorMessage(java.lang.String errorMessage) |
void |
setEstimatedRemainingMinutes(java.lang.Long estimatedRemainingMinutes)
Estimated remaining time in minute of the task execution, < 0 means no
estimation for the task.
|
void |
setId(java.lang.String id)
Unique ID for this entity
|
void |
setLocalizedErrorMessage(java.lang.String localizedErrorMessage) |
void |
setOrgId(java.lang.String orgId) |
void |
setOrgType(java.lang.String orgType) |
void |
setParams(Structure params) |
void |
setParentTaskId(java.lang.String parentTaskId)
If this task was created by another task - this provides the linkage.
|
void |
setPhaseInProgress(java.lang.String phaseInProgress)
The current in progress phase ID in the task execution, if none in progress,
empty string returned.
|
void |
setProgressPercent(java.lang.Long progressPercent)
Estimated progress percentage the task executed format: int32
|
void |
setResourceId(java.lang.String resourceId)
UUID of the resource the task is acting upon
|
void |
setResourceType(java.lang.String resourceType)
Type of resource being acted upon
|
void |
setServiceErrors(java.util.List<ServiceError> serviceErrors)
Service errors returned from SDDC services.
|
void |
setStartResourceEntityVersion(java.lang.Long startResourceEntityVersion)
Entity version of the resource at the start of the task.
|
void |
setStartTime(java.util.Calendar startTime) |
void |
setStatus(java.lang.String status)
|
void |
setSubStatus(java.lang.String subStatus) |
void |
setTaskProgressPhases(java.util.List<TaskProgressPhase> taskProgressPhases)
Task progress phases involved in current task execution
|
void |
setTaskType(java.lang.String taskType) |
void |
setTaskVersion(java.lang.String taskVersion) |
void |
setUpdated(java.util.Calendar updated) |
void |
setUpdatedByUserId(java.lang.String updatedByUserId)
User id that last updated this record
|
void |
setUpdatedByUserName(java.lang.String updatedByUserName)
User name that last updated this record
|
void |
setUserId(java.lang.String userId)
User id that last updated this record
|
void |
setUserName(java.lang.String userName)
User name that last updated this record
|
void |
setVersion(long version)
Version of this entity format: int32
|
java.lang.String |
toString()
Returns a string representation of this structure.
|
public static final java.lang.String STATUS_STARTED
public static final java.lang.String STATUS_CANCELING
public static final java.lang.String STATUS_FINISHED
public static final java.lang.String STATUS_FAILED
public static final java.lang.String STATUS_CANCELED
protected StructValue __dynamicStructureFields
public Task()
protected Task(StructValue __dynamicStructureFields)
public java.util.Calendar getUpdated()
public void setUpdated(java.util.Calendar updated)
updated
- New value for the property.public java.lang.String getUserId()
public void setUserId(java.lang.String userId)
userId
- New value for the property.public java.lang.String getUpdatedByUserId()
public void setUpdatedByUserId(java.lang.String updatedByUserId)
updatedByUserId
- New value for the property.public java.util.Calendar getCreated()
public void setCreated(java.util.Calendar created)
created
- New value for the property.public long getVersion()
public void setVersion(long version)
version
- New value for the property.public java.lang.String getUpdatedByUserName()
public void setUpdatedByUserName(java.lang.String updatedByUserName)
updatedByUserName
- New value for the property.public java.lang.String getUserName()
public void setUserName(java.lang.String userName)
userName
- New value for the property.public java.lang.String getId()
public void setId(java.lang.String id)
id
- New value for the property.public java.lang.String getStatus()
public void setStatus(java.lang.String status)
status
- New value for the property.public java.lang.String getLocalizedErrorMessage()
public void setLocalizedErrorMessage(java.lang.String localizedErrorMessage)
localizedErrorMessage
- New value for the property.public java.lang.String getResourceId()
public void setResourceId(java.lang.String resourceId)
resourceId
- New value for the property.public java.lang.String getParentTaskId()
public void setParentTaskId(java.lang.String parentTaskId)
parentTaskId
- New value for the property.public java.lang.String getTaskVersion()
public void setTaskVersion(java.lang.String taskVersion)
taskVersion
- New value for the property.public java.lang.String getCorrelationId()
public void setCorrelationId(java.lang.String correlationId)
correlationId
- New value for the property.public java.lang.Long getStartResourceEntityVersion()
public void setStartResourceEntityVersion(java.lang.Long startResourceEntityVersion)
startResourceEntityVersion
- New value for the property.public java.lang.String getCustomerErrorMessage()
public void setCustomerErrorMessage(java.lang.String customerErrorMessage)
customerErrorMessage
- New value for the property.public java.lang.String getSubStatus()
public void setSubStatus(java.lang.String subStatus)
subStatus
- New value for the property.public java.lang.String getTaskType()
public void setTaskType(java.lang.String taskType)
taskType
- New value for the property.public java.util.Calendar getStartTime()
public void setStartTime(java.util.Calendar startTime)
startTime
- New value for the property.public java.util.List<TaskProgressPhase> getTaskProgressPhases()
public void setTaskProgressPhases(java.util.List<TaskProgressPhase> taskProgressPhases)
taskProgressPhases
- New value for the property.public java.lang.String getErrorMessage()
public void setErrorMessage(java.lang.String errorMessage)
errorMessage
- New value for the property.public java.lang.String getOrgId()
public void setOrgId(java.lang.String orgId)
orgId
- New value for the property.public java.lang.Long getEndResourceEntityVersion()
public void setEndResourceEntityVersion(java.lang.Long endResourceEntityVersion)
endResourceEntityVersion
- New value for the property.public java.util.List<ServiceError> getServiceErrors()
public void setServiceErrors(java.util.List<ServiceError> serviceErrors)
serviceErrors
- New value for the property.public java.lang.String getOrgType()
public void setOrgType(java.lang.String orgType)
orgType
- New value for the property.public java.lang.Long getEstimatedRemainingMinutes()
public void setEstimatedRemainingMinutes(java.lang.Long estimatedRemainingMinutes)
estimatedRemainingMinutes
- New value for the property.public Structure getParams()
public void setParams(Structure params)
params
- New value for the property.public java.lang.Long getProgressPercent()
public void setProgressPercent(java.lang.Long progressPercent)
progressPercent
- New value for the property.public java.lang.String getPhaseInProgress()
public void setPhaseInProgress(java.lang.String phaseInProgress)
phaseInProgress
- New value for the property.public java.lang.String getResourceType()
public void setResourceType(java.lang.String resourceType)
resourceType
- New value for the property.public java.util.Calendar getEndTime()
public void setEndTime(java.util.Calendar endTime)
endTime
- New value for the property.public com.vmware.vapi.bindings.type.StructType _getType()
StaticStructure
StructType
instance representing the static bindings
type for this Structure
._getType
in interface StaticStructure
StructType
public StructValue _getDataValue()
Structure
Structure
represented in the dynamic
DataValue
model.
Attempts to change the returned StructValue
representation are not required to change the state of this structure.
Actually the behavior is implementation dependent and is unspecified.
In general the returned value shouldn't be changed.
_getDataValue
in interface Structure
StructValue
representing this structureprotected void _updateDataValue(StructValue structValue)
public void _validate()
StaticStructure
Structure
.
More precisely, for each union: given value of the discriminant/tag
field (@UnionTag
in the IDL) of an union in this structure,
validates that:
_validate
in interface StaticStructure
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public java.lang.String toString()
StaticStructure
In general no code should depend on the format of the resulting string. E.g. there must be no attempts to parse for re-creation of the original instance.
toString
in interface StaticStructure
toString
in class java.lang.Object
public boolean _hasTypeNameOf(java.lang.Class<? extends Structure> clazz)
Structure
This can be used as efficient check to determine if this instance
can be successfully converted
to the target
type.
_hasTypeNameOf
in interface Structure
clazz
- bindings class for the target structure; must not be null
public <T extends Structure> T _convertTo(java.lang.Class<T> clazz)
Structure
_convertTo
in interface Structure
clazz
- type of the result structure. cannot be null.CoreException
is thrown otherwise.public void _setDynamicField(java.lang.String fieldName, DataValue fieldValue)
StaticStructure
_setDynamicField
in interface StaticStructure
fieldName
- canonical name of the dynamic field to setfieldValue
- the value of the fieldpublic DataValue _getDynamicField(java.lang.String fieldName)
StaticStructure
_getDynamicField
in interface StaticStructure
fieldName
- the canonical name of the dynamic fieldDataValue
of the dynamic fieldpublic java.util.Set<java.lang.String> _getDynamicFieldNames()
StaticStructure
_getDynamicFieldNames
in interface StaticStructure
public static com.vmware.vapi.bindings.type.StructType _getClassType()
StructType
instance representing the static bindings
type for this Structure
.public java.lang.String _getCanonicalName()
Structure
org.example.FooBar
would turn into
org.example.foo_bar
._getCanonicalName
in interface Structure
public static java.lang.String _getCanonicalTypeName()
_getCanonicalName()
.public static Task _newInstance(StructValue structValue)
structValue
- the source of the data contained in the binding object. Could
contain more data than fields of this class can describe i.e.
newer version of the binding object. Could be null.StructType
public static Task _newInstance2(StructValue structValue)