TaskProperties (Java SDK for NSX Manager API 4.1.2.0.0)

java.lang.Object
- com.vmware.nsx.model.TaskProperties

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
```
public final class TaskProperties
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
```
Task properties

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class TaskProperties.Builder
Builder class for TaskProperties.

Nested Classes
Modifier and Type	Class and Description
`static class`	`TaskProperties.Builder` Builder class for `TaskProperties`.

Field Summary

Fields
Modifier and Type	Field and Description
`protected com.vmware.vapi.data.StructValue`	`__dynamicStructureFields`
`static java.lang.String`	`STATUS_CANCELED`
`static java.lang.String`	`STATUS_CANCELING`
`static java.lang.String`	`STATUS_ERROR`
`static java.lang.String`	`STATUS_KILLED`
`static java.lang.String`	`STATUS_RUNNING`
`static java.lang.String`	`STATUS_SUCCESS`

Constructor Summary

Constructors
Modifier Constructor and Description

TaskProperties()
Default constructor.

protected TaskProperties(com.vmware.vapi.data.StructValue __dynamicStructureFields)

Constructors
Modifier	Constructor and Description
	`TaskProperties()` Default constructor.
`protected`	`TaskProperties(com.vmware.vapi.data.StructValue __dynamicStructureFields)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<T extends com.vmware.vapi.bindings.Structure> T`	`_convertTo(java.lang.Class<T> clazz)`
`java.lang.String`	`_getCanonicalName()`
`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.
`com.vmware.vapi.data.StructValue`	`_getDataValue()`
`com.vmware.vapi.data.DataValue`	`_getDynamicField(java.lang.String fieldName)`
`java.util.Set<java.lang.String>`	`_getDynamicFieldNames()`
`com.vmware.vapi.bindings.type.StructType`	`_getType()`
`boolean`	`_hasTypeNameOf(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)`
`static TaskProperties`	`_newInstance(com.vmware.vapi.data.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 TaskProperties`	`_newInstance2(com.vmware.vapi.data.StructValue structValue)` WARNING: Internal method, subject to change in future versions. Serves as a versioning mechanism.
`void`	`_setDynamicField(java.lang.String fieldName, com.vmware.vapi.data.DataValue fieldValue)`
`protected void`	`_updateDataValue(com.vmware.vapi.data.StructValue structValue)`
`void`	`_validate()`
`boolean`	`equals(java.lang.Object obj)`
`java.lang.Boolean`	`getAsyncResponseAvailable()` True if response for asynchronous request is available This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`java.lang.Boolean`	`getCancelable()` True if this task can be canceled This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`java.lang.String`	`getDescription()` Description of the task This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`java.lang.Long`	`getEndTime()` The end time of the task in epoch milliseconds format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`java.lang.String`	`getId()` Identifier for this task This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`java.util.List<ResourceLink>`	`getLinks()` The server will populate this field when returing the resource.
`java.lang.String`	`getMessage()` A message describing the disposition of the task This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`java.lang.Long`	`getProgress()` Task progress if known, from 0 to 100 format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`java.lang.String`	`getRequestMethod()` HTTP request method This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`java.lang.String`	`getRequestUri()` URI of the method invocation that spawned this task This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`java.lang.String`	`getSchema()` Schema for this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`SelfResourceLink`	`getSelf()`
`java.lang.Long`	`getStartTime()` The start time of the task in epoch milliseconds format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`java.lang.String`	`getStatus()` Possible values are: `STATUS_RUNNING` `STATUS_ERROR` `STATUS_SUCCESS` `STATUS_CANCELING` `STATUS_CANCELED` `STATUS_KILLED` Current status of the task This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`java.lang.String`	`getUser()` Name of the user who created this task This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`int`	`hashCode()`
`void`	`setAsyncResponseAvailable(java.lang.Boolean asyncResponseAvailable)` True if response for asynchronous request is available This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`void`	`setCancelable(java.lang.Boolean cancelable)` True if this task can be canceled This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`void`	`setDescription(java.lang.String description)` Description of the task This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`void`	`setEndTime(java.lang.Long endTime)` The end time of the task in epoch milliseconds format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`void`	`setId(java.lang.String id)` Identifier for this task This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`void`	`setLinks(java.util.List<ResourceLink> links)` The server will populate this field when returing the resource.
`void`	`setMessage(java.lang.String message)` A message describing the disposition of the task This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`void`	`setProgress(java.lang.Long progress)` Task progress if known, from 0 to 100 format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`void`	`setRequestMethod(java.lang.String requestMethod)` HTTP request method This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`void`	`setRequestUri(java.lang.String requestUri)` URI of the method invocation that spawned this task This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`void`	`setSchema(java.lang.String schema)` Schema for this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`void`	`setSelf(SelfResourceLink self)`
`void`	`setStartTime(java.lang.Long startTime)` The start time of the task in epoch milliseconds format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`void`	`setStatus(java.lang.String status)` Possible values are: `STATUS_RUNNING` `STATUS_ERROR` `STATUS_SUCCESS` `STATUS_CANCELING` `STATUS_CANCELED` `STATUS_KILLED` Current status of the task This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`void`	`setUser(java.lang.String user)` Name of the user who created this task This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - STATUS_RUNNING
```
public static final java.lang.String STATUS_RUNNING
```
    See Also:
    
    Constant Field Values
  - STATUS_ERROR
```
public static final java.lang.String STATUS_ERROR
```
    See Also:
    
    Constant Field Values
  - STATUS_SUCCESS
```
public static final java.lang.String STATUS_SUCCESS
```
    See Also:
    
    Constant Field Values
  - STATUS_CANCELING
```
public static final java.lang.String STATUS_CANCELING
```
    See Also:
    
    Constant Field Values
  - STATUS_CANCELED
```
public static final java.lang.String STATUS_CANCELED
```
    See Also:
    
    Constant Field Values
  - STATUS_KILLED
```
public static final java.lang.String STATUS_KILLED
```
    See Also:
    
    Constant Field Values
  - __dynamicStructureFields
```
protected com.vmware.vapi.data.StructValue __dynamicStructureFields
```
- Constructor Detail
  - TaskProperties
```
public TaskProperties()
```
    Default constructor.
  - TaskProperties
```
protected TaskProperties(com.vmware.vapi.data.StructValue __dynamicStructureFields)
```
- Method Detail
  - getLinks
```
public java.util.List<ResourceLink> getLinks()
```
    The server will populate this field when returing the resource. Ignored on PUT and POST. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setLinks
```
public void setLinks(java.util.List<ResourceLink> links)
```
    The server will populate this field when returing the resource. Ignored on PUT and POST. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    links - New value for the property.
  - getSchema
```
public java.lang.String getSchema()
```
    Schema for this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setSchema
```
public void setSchema(java.lang.String schema)
```
    Schema for this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    schema - New value for the property.
  - getSelf
```
public SelfResourceLink getSelf()
```
    Returns:
    
    The current value of the property.
  - setSelf
```
public void setSelf(SelfResourceLink self)
```
    Parameters:
    
    self - New value for the property.
  - getAsyncResponseAvailable
```
public java.lang.Boolean getAsyncResponseAvailable()
```
    True if response for asynchronous request is available This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setAsyncResponseAvailable
```
public void setAsyncResponseAvailable(java.lang.Boolean asyncResponseAvailable)
```
    True if response for asynchronous request is available This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    asyncResponseAvailable - New value for the property.
  - getCancelable
```
public java.lang.Boolean getCancelable()
```
    True if this task can be canceled This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setCancelable
```
public void setCancelable(java.lang.Boolean cancelable)
```
    True if this task can be canceled This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    cancelable - New value for the property.
  - getDescription
```
public java.lang.String getDescription()
```
    Description of the task This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setDescription
```
public void setDescription(java.lang.String description)
```
    Description of the task This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    description - New value for the property.
  - getEndTime
```
public java.lang.Long getEndTime()
```
    The end time of the task in epoch milliseconds format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setEndTime
```
public void setEndTime(java.lang.Long endTime)
```
    The end time of the task in epoch milliseconds format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    endTime - New value for the property.
  - getId
```
public java.lang.String getId()
```
    Identifier for this task This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setId
```
public void setId(java.lang.String id)
```
    Identifier for this task This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    id - New value for the property.
  - getMessage
```
public java.lang.String getMessage()
```
    A message describing the disposition of the task This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setMessage
```
public void setMessage(java.lang.String message)
```
    A message describing the disposition of the task This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    message - New value for the property.
  - getProgress
```
public java.lang.Long getProgress()
```
    Task progress if known, from 0 to 100 format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setProgress
```
public void setProgress(java.lang.Long progress)
```
    Task progress if known, from 0 to 100 format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    progress - New value for the property.
  - getRequestMethod
```
public java.lang.String getRequestMethod()
```
    HTTP request method This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setRequestMethod
```
public void setRequestMethod(java.lang.String requestMethod)
```
    HTTP request method This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    requestMethod - New value for the property.
  - getRequestUri
```
public java.lang.String getRequestUri()
```
    URI of the method invocation that spawned this task This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setRequestUri
```
public void setRequestUri(java.lang.String requestUri)
```
    URI of the method invocation that spawned this task This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    requestUri - New value for the property.
  - getStartTime
```
public java.lang.Long getStartTime()
```
    The start time of the task in epoch milliseconds format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setStartTime
```
public void setStartTime(java.lang.Long startTime)
```
    The start time of the task in epoch milliseconds format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    startTime - New value for the property.
  - getStatus
```
public java.lang.String getStatus()
```
    Possible values are:
    Current status of the task This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    Returns:
    
    The current value of the property.
  - setStatus
```
public void setStatus(java.lang.String status)
```
    Possible values are:
    Current status of the task This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    Parameters:
    
    status - New value for the property.
  - getUser
```
public java.lang.String getUser()
```
    Name of the user who created this task This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setUser
```
public void setUser(java.lang.String user)
```
    Name of the user who created this task This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    user - New value for the property.
  - _getType
```
public com.vmware.vapi.bindings.type.StructType _getType()
```
    Specified by:
    
    _getType in interface com.vmware.vapi.bindings.StaticStructure
  - _getDataValue
```
public com.vmware.vapi.data.StructValue _getDataValue()
```
    Specified by:
    
    _getDataValue in interface com.vmware.vapi.bindings.Structure
  - _updateDataValue
```
protected void _updateDataValue(com.vmware.vapi.data.StructValue structValue)
```
  - _validate
```
public void _validate()
```
    Specified by:
    
    _validate in interface com.vmware.vapi.bindings.StaticStructure
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Specified by:
    
    toString in interface com.vmware.vapi.bindings.StaticStructure
    
    Overrides:
    
    toString in class java.lang.Object
  - _hasTypeNameOf
```
public boolean _hasTypeNameOf(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)
```
    Specified by:
    
    _hasTypeNameOf in interface com.vmware.vapi.bindings.Structure
  - _convertTo
```
public <T extends com.vmware.vapi.bindings.Structure> T _convertTo(java.lang.Class<T> clazz)
```
    Specified by:
    
    _convertTo in interface com.vmware.vapi.bindings.Structure
  - _setDynamicField
```
public void _setDynamicField(java.lang.String fieldName,
                             com.vmware.vapi.data.DataValue fieldValue)
```
    Specified by:
    
    _setDynamicField in interface com.vmware.vapi.bindings.StaticStructure
  - _getDynamicField
```
public com.vmware.vapi.data.DataValue _getDynamicField(java.lang.String fieldName)
```
    Specified by:
    
    _getDynamicField in interface com.vmware.vapi.bindings.StaticStructure
  - _getDynamicFieldNames
```
public java.util.Set<java.lang.String> _getDynamicFieldNames()
```
    Specified by:
    
    _getDynamicFieldNames in interface com.vmware.vapi.bindings.StaticStructure
  - _getClassType
```
public static com.vmware.vapi.bindings.type.StructType _getClassType()
```
    WARNING: Internal method, subject to change in future versions.
    
    Returns:
    
    StructType instance representing the static bindings type for this Structure.
  - _getCanonicalName
```
public java.lang.String _getCanonicalName()
```
    Specified by:
    
    _getCanonicalName in interface com.vmware.vapi.bindings.Structure
  - _getCanonicalTypeName
```
public static java.lang.String _getCanonicalTypeName()
```
    Returns the canonical type name. See _getCanonicalName().
    
    Returns:
    
    canonical type name
  - _newInstance
```
public static TaskProperties _newInstance(com.vmware.vapi.data.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.
    
    Parameters:
    
    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.
    
    Returns:
    
    the static bindings StructType
  - _newInstance2
```
public static TaskProperties _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class TaskProperties

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

STATUS_RUNNING

STATUS_ERROR

STATUS_SUCCESS

STATUS_CANCELING

STATUS_CANCELED

STATUS_KILLED

__dynamicStructureFields

Constructor Detail

TaskProperties

TaskProperties

Method Detail

getLinks

setLinks

getSchema

setSchema

getSelf

setSelf

getAsyncResponseAvailable

setAsyncResponseAvailable

getCancelable

setCancelable

getDescription

setDescription

getEndTime

setEndTime

getId

setId

getMessage

setMessage

getProgress

setProgress

getRequestMethod

setRequestMethod

getRequestUri

setRequestUri

getStartTime

setStartTime

getStatus

setStatus

getUser

setUser

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2