public static final class ToolsTypes.Info extends java.lang.Object implements java.io.Serializable, StaticStructure
Info
class describes the VMWare Tools properties of a virtual
machine. This class was added in vSphere API 7.0.0.0.Modifier and Type | Class and Description |
---|---|
static class |
ToolsTypes.Info.Builder
Builder class for
ToolsTypes.Info . |
Modifier and Type | Field and Description |
---|---|
protected StructValue |
__dynamicStructureFields |
Modifier | Constructor and Description |
---|---|
|
Info()
Default constructor.
|
protected |
Info(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 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 ToolsTypes.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 ToolsTypes.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 |
getAutoUpdateSupported()
Set if the virtual machine supports auto-upgrading Tools via
ToolsTypes.UpgradePolicy . |
ApiError |
getError()
Error that happened, if any, during last attempt to upgrade or install Tools.
|
java.lang.Long |
getInstallAttemptCount()
Number of attempts that have been made to install or upgrade the version of
Tools installed on this virtual machine.
|
ToolsTypes.ToolsInstallType |
getInstallType()
Current installation type of VMware Tools in the guest operating system.
|
ToolsTypes.RunState |
getRunState()
Current run state of VMware Tools in the guest operating system.
|
ToolsTypes.UpgradePolicy |
getUpgradePolicy()
Tools upgrade policy setting for the virtual machine.
|
java.lang.String |
getVersion()
Version of VMware Tools installed on the guest operating system.
|
java.lang.Long |
getVersionNumber()
Version of VMware Tools installed on the guest operating system.
|
ToolsTypes.VersionStatus |
getVersionStatus()
Current version status of VMware Tools in the guest operating system, if known.
|
int |
hashCode() |
void |
setAutoUpdateSupported(boolean autoUpdateSupported)
Set if the virtual machine supports auto-upgrading Tools via
ToolsTypes.UpgradePolicy . |
void |
setError(ApiError error)
Error that happened, if any, during last attempt to upgrade or install Tools.
|
void |
setInstallAttemptCount(java.lang.Long installAttemptCount)
Number of attempts that have been made to install or upgrade the version of
Tools installed on this virtual machine.
|
void |
setInstallType(ToolsTypes.ToolsInstallType installType)
Current installation type of VMware Tools in the guest operating system.
|
void |
setRunState(ToolsTypes.RunState runState)
Current run state of VMware Tools in the guest operating system.
|
void |
setUpgradePolicy(ToolsTypes.UpgradePolicy upgradePolicy)
Tools upgrade policy setting for the virtual machine.
|
void |
setVersion(java.lang.String version)
Version of VMware Tools installed on the guest operating system.
|
void |
setVersionNumber(java.lang.Long versionNumber)
Version of VMware Tools installed on the guest operating system.
|
void |
setVersionStatus(ToolsTypes.VersionStatus versionStatus)
Current version status of VMware Tools in the guest operating system, if known.
|
java.lang.String |
toString()
Returns a string representation of this structure.
|
protected StructValue __dynamicStructureFields
public Info()
protected Info(StructValue __dynamicStructureFields)
public boolean getAutoUpdateSupported()
ToolsTypes.UpgradePolicy
. This property was added in
vSphere API 7.0.0.0.public void setAutoUpdateSupported(boolean autoUpdateSupported)
ToolsTypes.UpgradePolicy
. This property was added in
vSphere API 7.0.0.0.autoUpdateSupported
- New value for the property.public java.lang.Long getInstallAttemptCount()
public void setInstallAttemptCount(java.lang.Long installAttemptCount)
installAttemptCount
- New value for the property.public ApiError getError()
public void setError(ApiError error)
error
- New value for the property.public java.lang.Long getVersionNumber()
public void setVersionNumber(java.lang.Long versionNumber)
versionNumber
- New value for the property.public java.lang.String getVersion()
public void setVersion(java.lang.String version)
version
- New value for the property.public ToolsTypes.UpgradePolicy getUpgradePolicy()
ToolsTypes.UpgradePolicy
. This property was added in
vSphere API 7.0.0.0.public void setUpgradePolicy(ToolsTypes.UpgradePolicy upgradePolicy)
ToolsTypes.UpgradePolicy
. This property was added in
vSphere API 7.0.0.0.upgradePolicy
- New value for the property.public ToolsTypes.VersionStatus getVersionStatus()
public void setVersionStatus(ToolsTypes.VersionStatus versionStatus)
versionStatus
- New value for the property.public ToolsTypes.ToolsInstallType getInstallType()
public void setInstallType(ToolsTypes.ToolsInstallType installType)
installType
- New value for the property.public ToolsTypes.RunState getRunState()
public void setRunState(ToolsTypes.RunState runState)
runState
- 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 ToolsTypes.Info _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 ToolsTypes.Info _newInstance2(StructValue structValue)