Info (vSphere Automation SDK for Java 7.0.1.0)

java.lang.Object
- com.vmware.cis.task.Info

All Implemented Interfaces:

StaticStructure, Structure, java.io.Serializable
```
public final class Info
extends java.lang.Object
implements java.io.Serializable, StaticStructure
```
The Info class contains information about a task. This class was added in vSphere API 6.7.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Info.Builder
Builder class for Info.

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

Field Summary

Fields
Modifier and Type Field and Description

protected StructValue __dynamicStructureFields

Fields
Modifier and Type	Field and Description
`protected StructValue`	`__dynamicStructureFields`

Constructor Summary

Constructors
Modifier Constructor and Description

Info()
Default constructor.

protected Info(StructValue __dynamicStructureFields)

Constructors
Modifier	Constructor and Description
	`Info()` Default constructor.
`protected`	`Info(StructValue __dynamicStructureFields)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<T extends Structure> T`	`_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 dynamic filed value.
`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 Info`	`_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 Info`	`_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)`
`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.
`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.
`Progress`	`getProgress()` Progress of the operation.
`DataValue`	`getResult()` Result of the operation.
`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(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`	`setProgress(Progress progress)` Progress of the operation.
`void`	`setResult(DataValue result)` Result of the operation.
`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()` Returns a string representation of this structure.

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

- Field Detail
  - __dynamicStructureFields
```
protected StructValue __dynamicStructureFields
```
- Constructor Detail
  - Info
```
public Info()
```
    Default constructor.
  - Info
```
protected Info(StructValue __dynamicStructureFields)
```
- Method Detail
  - getProgress
```
public Progress getProgress()
```
    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.
    
    Returns:
    
    The current value of the property.
  - setProgress
```
public void 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.
  - getResult
```
public DataValue getResult()
```
    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.
    
    Returns:
    
    The current value of the property.
  - setResult
```
public void 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.
  - getDescription
```
public LocalizableMessage getDescription()
```
    Description of the operation associated with the task. This property was added in vSphere API 6.7.
    
    Returns:
    
    The current value of the property.
  - setDescription
```
public void setDescription(LocalizableMessage description)
```
    Description of the operation associated with the task. This property was added in vSphere API 6.7.
    
    Parameters:
    
    description - New value for the property.
  - getService
```
public java.lang.String getService()
```
    Identifier of the service containing the operation. This property was added in vSphere API 6.7.
    
    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.vapi.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.vapi.service.
  - setService
```
public void setService(java.lang.String service)
```
    Identifier of the service containing the operation. This property was added in vSphere API 6.7.
    
    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.vapi.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.vapi.service.
  - getOperation
```
public java.lang.String getOperation()
```
    Identifier of the operation associated with the task. This property was added in vSphere API 6.7.
    
    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.vapi.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.vapi.operation.
  - setOperation
```
public void setOperation(java.lang.String operation)
```
    Identifier of the operation associated with the task. This property was added in vSphere API 6.7.
    
    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.vapi.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.vapi.operation.
  - getParent
```
public java.lang.String getParent()
```
    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.
    
    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.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.
  - setParent
```
public void 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.
  - getTarget
```
public DynamicID getTarget()
```
    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.
    
    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 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.
  - getStatus
```
public Status getStatus()
```
    Status of the operation associated with the task. This property was added in vSphere API 6.7.
    
    Returns:
    
    The current value of the property.
  - setStatus
```
public void setStatus(Status status)
```
    Status of the operation associated with the task. This property was added in vSphere API 6.7.
    
    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. This property was added in vSphere API 6.7.
    
    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. This property was added in vSphere API 6.7.
    
    Parameters:
    
    cancelable - New value for the property.
  - getError
```
public ApiError getError()
```
    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 getResult()).
    
    Returns:
    
    The current value of the property.
  - setError
```
public void 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 getResult()).
    
    Parameters:
    
    error - New value for the property.
  - getStartTime
```
public java.util.Calendar getStartTime()
```
    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.
    
    Returns:
    
    The current value of the property.
  - setStartTime
```
public void 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.
  - getEndTime
```
public java.util.Calendar getEndTime()
```
    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.
    
    Returns:
    
    The current value of the property.
  - setEndTime
```
public void 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.
  - getUser
```
public java.lang.String getUser()
```
    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.
    
    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 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.
  - _getType
```
public com.vmware.vapi.bindings.type.StructType _getType()
```
    Description copied from interface: StaticStructure
    
    WARNING: Internal method, subject to change in future versions. Returns StructType instance representing the static bindings type for this Structure.
    
    Specified by:
    
    _getType in interface StaticStructure
    
    Returns:
    
    the static bindings StructType
  - _getDataValue
```
public StructValue _getDataValue()
```
    Description copied from interface: Structure
    
    Returns this 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.
    
    Specified by:
    
    _getDataValue in interface Structure
    
    Returns:
    
    StructValue representing this structure
  - _updateDataValue
```
protected void _updateDataValue(StructValue structValue)
```
  - _validate
```
public void _validate()
```
    Description copied from interface: StaticStructure
    
    Validates the state of the discriminated unions and HasFieldsOf restrictions (if any) in this Java language binding 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:
  - all fields of the union required for that value of the discriminant are set
  - fields of the union that are not allowed for that value of the discriminant are not set
  - any other fields of the structure (not participating in the union) do not affect the validation result

Specified by:: _validate in interface 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()
```
Description copied from interface: StaticStructure

Returns a string representation of this structure. The result is pretty printed in order to be easy to read. It is intended to be used for different debugging/tracing purposes, e.g. dumping structures into logging traces.
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.

Specified by:

toString in interface StaticStructure

Overrides:

toString in class java.lang.Object

Returns:

a string representation of this static structure instance

_hasTypeNameOf
```
public boolean _hasTypeNameOf(java.lang.Class<? extends Structure> clazz)
```
Description copied from interface: Structure

Checks if the runtime type name of this structure matches the type represented by the specified binding class.
This can be used as efficient check to determine if this instance can be successfully converted to the target type.

Specified by:

_hasTypeNameOf in interface Structure

Parameters:

clazz - bindings class for the target structure; must not be null

Returns:

true if this structures type name matches exactly the specified class' type name.

_convertTo
```
public <T extends Structure> T _convertTo(java.lang.Class<T> clazz)
```
Description copied from interface: Structure

Converts this structure into an instance of the provided class structure if possible. A conversion will be possible if the requested structure's fields are all present in this structure.

Specified by:

_convertTo in interface Structure

Parameters:

clazz - type of the result structure. cannot be null.

Returns:

an instance of the requested type if conversion is possible. CoreException is thrown otherwise.

_setDynamicField
```
public void _setDynamicField(java.lang.String fieldName,
                             DataValue fieldValue)
```
Description copied from interface: StaticStructure

Sets a dynamic field value. The dynamic filed is extra filed that is not part of the static fields of the structure.

Specified by:

_setDynamicField in interface StaticStructure

Parameters:

fieldName - canonical name of the dynamic field to set

fieldValue - the value of the field

_getDynamicField
```
public DataValue _getDynamicField(java.lang.String fieldName)
```
Description copied from interface: StaticStructure

Get dynamic filed value. Works only on dynamic fields.

Specified by:

_getDynamicField in interface StaticStructure

Parameters:

fieldName - the canonical name of the dynamic field

Returns:

the DataValue of the dynamic field

_getDynamicFieldNames
```
public java.util.Set<java.lang.String> _getDynamicFieldNames()
```
Description copied from interface: StaticStructure

Get the names of the dynamic fields in the structure.

Specified by:

_getDynamicFieldNames in interface StaticStructure

Returns:

set of the canonical field names for the dynamic fields

_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()
```
Description copied from interface: Structure

Returns the canonical name of the structure. By default the canonical name is derived from the fully-qualified IDL name by converting to lower case and inserting underscores between words. For example org.example.FooBar would turn into org.example.foo_bar.

Specified by:

_getCanonicalName in interface Structure

Returns:

canonical name

_getCanonicalTypeName
```
public static java.lang.String _getCanonicalTypeName()
```
Returns the canonical type name. See _getCanonicalName().

Returns:

canonical type name

_newInstance
```
public static Info _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.

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 Info _newInstance2(StructValue structValue)
```
WARNING: Internal method, subject to change in future versions.
Serves as a versioning mechanism.

Class Info

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

__dynamicStructureFields

Constructor Detail

Info

Info

Method Detail

getProgress

setProgress

getResult

setResult

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