com.vmware.esx.settings.clusters.configuration

Class HostResult

java.lang.Object

com.vmware.esx.settings.clusters.configuration.HostResult

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable

public final class HostResult
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure

This HostResult class contains properties that describe the result of the check compliance operation on an ESXi host. This class was added in vSphere API 8.0.1.0.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HostResult.Builder Builder class for HostResult.

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

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 HostResult	_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 HostResult	_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.util.List<ValidationError>	getErrors() List of validation errors returned by the host.
HostCompliance	getHostCompliance() This field provides compliance results for the host if the operation successfully completed on the host.
HostStatus	getHostStatus() This field represents the status of the check compliance operation.
LocalizableMessage	getSummary() Summary of check compliance operation on the host.
int	hashCode()
void	setErrors(java.util.List<ValidationError> errors) List of validation errors returned by the host.
void	setHostCompliance(HostCompliance hostCompliance) This field provides compliance results for the host if the operation successfully completed on the host.
void	setHostStatus(HostStatus hostStatus) This field represents the status of the check compliance operation.
void	setSummary(LocalizableMessage summary) Summary of check compliance operation on the host.
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

HostResult

public HostResult()

Default constructor.

HostResult

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

Method Detail

getHostStatus

public HostStatus getHostStatus()

This field represents the status of the check compliance operation. If status is OK, the result of operation can be retrived from {#HostCompliance} {#Summary} field will summarize the status of the operation and if applicable, the specific error that occured. Additionally, {#ValidationError} is populated if the operation fails due to host validation errors in desired document. This property was added in vSphere API 8.0.1.0.

Returns:

The current value of the property.

setHostStatus

public void setHostStatus(HostStatus hostStatus)

This field represents the status of the check compliance operation. If status is OK, the result of operation can be retrived from {#HostCompliance} {#Summary} field will summarize the status of the operation and if applicable, the specific error that occured. Additionally, {#ValidationError} is populated if the operation fails due to host validation errors in desired document. This property was added in vSphere API 8.0.1.0.

Parameters:

hostStatus - New value for the property.

getSummary

public LocalizableMessage getSummary()

Summary of check compliance operation on the host. This property was added in vSphere API 8.0.1.0.

Returns:

The current value of the property.

setSummary

public void setSummary(LocalizableMessage summary)

Summary of check compliance operation on the host. This property was added in vSphere API 8.0.1.0.

Parameters:

summary - New value for the property.

getErrors

public java.util.List<ValidationError> getErrors()

List of validation errors returned by the host. This is only set for a specific HostStatus ERROR case. This property was added in vSphere API 8.0.1.0. This field is Set only if the document fails to validate on the host.

Returns:

The current value of the property.

setErrors

public void setErrors(java.util.List<ValidationError> errors)

List of validation errors returned by the host. This is only set for a specific HostStatus ERROR case. This property was added in vSphere API 8.0.1.0. This field is Set only if the document fails to validate on the host.

Parameters:

errors - New value for the property.

getHostCompliance

public HostCompliance getHostCompliance()

This field provides compliance results for the host if the operation successfully completed on the host. That is, this field is populated only if HostStatus is OK. This property was added in vSphere API 8.0.1.0. This field is null if check compliance could not be completed on the host.

Returns:

The current value of the property.

setHostCompliance

public void setHostCompliance(HostCompliance hostCompliance)

This field provides compliance results for the host if the operation successfully completed on the host. That is, this field is populated only if HostStatus is OK. This property was added in vSphere API 8.0.1.0. This field is null if check compliance could not be completed on the host.

Parameters:

hostCompliance - 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 HostResult _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 HostResult _newInstance2(com.vmware.vapi.data.StructValue structValue)

WARNING: Internal method, subject to change in future versions.
Serves as a versioning mechanism.