CommonInfo

java.lang.Object
- com.vmware.snapservice.tasks.CommonInfo

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
```
public final class CommonInfo
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
```
The CommonInfo class contains information common to all tasks.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class CommonInfo.Builder
Builder class for CommonInfo.

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

Field Summary

Fields
Modifier and Type Field and Description

protected com.vmware.vapi.data.StructValue __dynamicStructureFields

Fields
Modifier and Type	Field and Description
`protected com.vmware.vapi.data.StructValue`	`__dynamicStructureFields`

Constructor Summary

Constructors
Modifier Constructor and Description

CommonInfo()
Default constructor.

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

Constructors
Modifier	Constructor and Description
	`CommonInfo()` Default constructor.
`protected`	`CommonInfo(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 CommonInfo`	`_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 CommonInfo`	`_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)`
`boolean`	`getCancelable()` Flag to indicate whether or not the operation can be cancelled.
`LocalizableMessage`	`getDescription()` Description of the operation associated with the task.
`java.util.Calendar`	`getEndTime()` Time when the operation is completed.
`com.vmware.vapi.bindings.ApiError`	`getError()` Description of the error if the operation status is "FAILED".
`java.lang.String`	`getOperation()` Identifier of the operation associated with the task.
`java.lang.String`	`getParent()` Parent of the current task.
`java.lang.String`	`getService()` Identifier of the service containing the operation.
`java.util.Calendar`	`getStartTime()` Time when the operation is started.
`Status`	`getStatus()` Status of the operation associated with the task.
`DynamicID`	`getTarget()` Identifier of the target created by the operation or an existing one the operation performed on.
`java.lang.String`	`getUser()` Name of the user who performed the operation.
`int`	`hashCode()`
`void`	`setCancelable(boolean cancelable)` Flag to indicate whether or not the operation can be cancelled.
`void`	`setDescription(LocalizableMessage description)` Description of the operation associated with the task.
`void`	`setEndTime(java.util.Calendar endTime)` Time when the operation is completed.
`void`	`setError(com.vmware.vapi.bindings.ApiError error)` Description of the error if the operation status is "FAILED".
`void`	`setOperation(java.lang.String operation)` Identifier of the operation associated with the task.
`void`	`setParent(java.lang.String parent)` Parent of the current task.
`void`	`setService(java.lang.String service)` Identifier of the service containing the operation.
`void`	`setStartTime(java.util.Calendar startTime)` Time when the operation is started.
`void`	`setStatus(Status status)` Status of the operation associated with the task.
`void`	`setTarget(DynamicID target)` Identifier of the target created by the operation or an existing one the operation performed on.
`void`	`setUser(java.lang.String user)` Name of the user who performed the operation.
`java.lang.String`	`toString()`

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

- Field Detail
  - __dynamicStructureFields
```
protected com.vmware.vapi.data.StructValue __dynamicStructureFields
```
- Constructor Detail
  - CommonInfo
```
public CommonInfo()
```
    Default constructor.
  - CommonInfo
```
protected CommonInfo(com.vmware.vapi.data.StructValue __dynamicStructureFields)
```
- Method Detail
  - getDescription
```
public LocalizableMessage getDescription()
```
    Description of the operation associated with the task.
    
    Returns:
    
    The current value of the property.
  - setDescription
```
public void setDescription(LocalizableMessage description)
```
    Description of the operation associated with the task.
    
    Parameters:
    
    description - New value for the property.
  - getService
```
public java.lang.String getService()
```
    Identifier of the service containing the operation.
    
    Returns:
    
    The current value of 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.snapservice.service. When methods return a value of this class as a return value, the property will be an identifier for the resource type: com.vmware.snapservice.service.
  - setService
```
public void setService(java.lang.String service)
```
    Identifier of the service containing the operation.
    
    Parameters:
    
    service - 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.snapservice.service. When methods return a value of this class as a return value, the property will be an identifier for the resource type: com.vmware.snapservice.service.
  - getOperation
```
public java.lang.String getOperation()
```
    Identifier of the operation associated with the task.
    
    Returns:
    
    The current value of 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.snapservice.operation. When methods return a value of this class as a return value, the property will be an identifier for the resource type: com.vmware.snapservice.operation.
  - setOperation
```
public void setOperation(java.lang.String operation)
```
    Identifier of the operation associated with the task.
    
    Parameters:
    
    operation - 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.snapservice.operation. When methods return a value of this class as a return value, the property will be an identifier for the resource type: com.vmware.snapservice.operation.
  - getParent
```
public java.lang.String getParent()
```
    Parent of the current task. This property will be null if the task has no parent.
    
    Returns:
    
    The current value of 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.snapservice.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.snapservice.task.
  - setParent
```
public void 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.snapservice.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.snapservice.task.
  - getTarget
```
public DynamicID getTarget()
```
    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.
    
    Returns:
    
    The current value of the property.
  - setTarget
```
public void 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.
  - getStatus
```
public Status getStatus()
```
    Status of the operation associated with the task.
    
    Returns:
    
    The current value of the property.
  - setStatus
```
public void setStatus(Status status)
```
    Status of the operation associated with the task.
    
    Parameters:
    
    status - New value for the property.
  - getCancelable
```
public boolean getCancelable()
```
    Flag to indicate whether or not the operation can be cancelled. The value may change as the operation progresses.
    
    Returns:
    
    The current value of the property.
  - setCancelable
```
public void setCancelable(boolean cancelable)
```
    Flag to indicate whether or not the operation can be cancelled. The value may change as the operation progresses.
    
    Parameters:
    
    cancelable - New value for the property.
  - getError
```
public com.vmware.vapi.bindings.ApiError getError()
```
    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()).
    
    Returns:
    
    The current value of the property.
  - setError
```
public void setError(com.vmware.vapi.bindings.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.
  - getStartTime
```
public java.util.Calendar getStartTime()
```
    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.
    
    Returns:
    
    The current value of the property.
  - setStartTime
```
public void 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.
  - getEndTime
```
public java.util.Calendar getEndTime()
```
    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.
    
    Returns:
    
    The current value of the property.
  - setEndTime
```
public void 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.
  - getUser
```
public java.lang.String getUser()
```
    Name of the user who performed the operation. This property will be null if the operation is performed by the system.
    
    Returns:
    
    The current value of the property.
  - setUser
```
public void 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.
  - _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 CommonInfo _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 CommonInfo _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class CommonInfo

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

__dynamicStructureFields

Constructor Detail

CommonInfo

CommonInfo

Method Detail

getDescription

setDescription

getService

setService

getOperation

setOperation

getParent

setParent

getTarget

setTarget

getStatus

setStatus

getCancelable

setCancelable

getError

setError

getStartTime

setStartTime

getEndTime

setEndTime

getUser

setUser

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2