com.vmware.esx.settings.clusters.configuration

Class HostPrecheckResult

java.lang.Object

com.vmware.esx.settings.clusters.configuration.HostPrecheckResult

All Implemented Interfaces:

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

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

This HostPrecheckResult class contains properties that describes the Precheck API result on a 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	HostPrecheckResult.Builder Builder class for HostPrecheckResult.

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	HostPrecheckResult() Default constructor.
protected	HostPrecheckResult(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 HostPrecheckResult	_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 HostPrecheckResult	_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)
ImpactInfo	getImpact() This field represents the impact on the host to reach the desired configuration state.
StatusInfo	getPrecheckResult() This field represents the health check results from the host, if the host needs to be put in maintenance mode or to be rebooted.
HostStatus	getStatus() This field represents the status of the precheck request for this host.
LocalizableMessage	getSummary() Summarizing precheck operation on the host.
java.util.List<ValidationError>	getValidationErrors() This field represents the validation errors if the desired configuration specified is not valid.
int	hashCode()
void	setImpact(ImpactInfo impact) This field represents the impact on the host to reach the desired configuration state.
void	setPrecheckResult(StatusInfo precheckResult) This field represents the health check results from the host, if the host needs to be put in maintenance mode or to be rebooted.
void	setStatus(HostStatus status) This field represents the status of the precheck request for this host.
void	setSummary(LocalizableMessage summary) Summarizing precheck operation on the host.
void	setValidationErrors(java.util.List<ValidationError> validationErrors) This field represents the validation errors if the desired configuration specified is not valid.
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

HostPrecheckResult

public HostPrecheckResult()

Default constructor.

HostPrecheckResult

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

Method Detail

getStatus

public HostStatus getStatus()

This field represents the status of the precheck request for this host. {link HostStatus#status} is ERROR or SKIPPED, if precheck was not completed on the host due to some error or if health checks failed. If precheck failed due to host validation errors, details are specified in getValidationErrors(). If precheck failed due to generic error, details are specified in the getSummary(). Health check result is specified in getPrecheckResult(). This property was added in vSphere API 8.0.1.0.

Returns:

The current value of the property.

setStatus

public void setStatus(HostStatus status)

This field represents the status of the precheck request for this host. {link HostStatus#status} is ERROR or SKIPPED, if precheck was not completed on the host due to some error or if health checks failed. If precheck failed due to host validation errors, details are specified in getValidationErrors(). If precheck failed due to generic error, details are specified in the getSummary(). Health check result is specified in getPrecheckResult(). This property was added in vSphere API 8.0.1.0.

Parameters:

status - New value for the property.

getSummary

public LocalizableMessage getSummary()

Summarizing precheck 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)

Summarizing precheck operation on the host. This property was added in vSphere API 8.0.1.0.

Parameters:

summary - New value for the property.

getValidationErrors

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

This field represents the validation errors if the desired configuration specified is not valid. This property was added in vSphere API 8.0.1.0. This field is Set if #HostStatus#status is ERROR due to host returning validation errors.

Returns:

The current value of the property.

setValidationErrors

public void setValidationErrors(java.util.List<ValidationError> validationErrors)

This field represents the validation errors if the desired configuration specified is not valid. This property was added in vSphere API 8.0.1.0. This field is Set if #HostStatus#status is ERROR due to host returning validation errors.

Parameters:

validationErrors - New value for the property.

getImpact

public ImpactInfo getImpact()

This field represents the impact on the host to reach the desired configuration state. This property was added in vSphere API 8.0.1.0. This field is Set if there are no validation errors on the host. The HostStatus.getStatus() may be OK or ERROR.

Returns:

The current value of the property.

setImpact

public void setImpact(ImpactInfo impact)

This field represents the impact on the host to reach the desired configuration state. This property was added in vSphere API 8.0.1.0. This field is Set if there are no validation errors on the host. The HostStatus.getStatus() may be OK or ERROR.

Parameters:

impact - New value for the property.

getPrecheckResult

public StatusInfo getPrecheckResult()

This field represents the health check results from the host, if the host needs to be put in maintenance mode or to be rebooted. This property was added in vSphere API 8.0.1.0. This field is Set if there are not validation errors and health checks are run on the host. The HostStatus.getStatus() may be OK or ERROR.

Returns:

The current value of the property.

setPrecheckResult

public void setPrecheckResult(StatusInfo precheckResult)

This field represents the health check results from the host, if the host needs to be put in maintenance mode or to be rebooted. This property was added in vSphere API 8.0.1.0. This field is Set if there are not validation errors and health checks are run on the host. The HostStatus.getStatus() may be OK or ERROR.

Parameters:

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

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