ClusterPrecheckResult

java.lang.Object
- com.vmware.esx.settings.clusters.configuration.ClusterPrecheckResult

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
```
public final class ClusterPrecheckResult
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
```
The PrecheckResult class contains properties that describe precheck status of applying the desired document to a group of hosts. 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`	`ClusterPrecheckResult.Builder` Builder class for `ClusterPrecheckResult`.
`static class`	`ClusterPrecheckResult.Status` The `Status` enumeration class contains the possible statuses of the Precheck API on the cluster.

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
	`ClusterPrecheckResult()` Default constructor.
`protected`	`ClusterPrecheckResult(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 ClusterPrecheckResult`	`_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 ClusterPrecheckResult`	`_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.lang.String`	`getCommit()` This identifier refers to the commit action of importing the desired configuration document.
`java.util.Calendar`	`getEndTime()` Precheck completion time.
`java.util.Set<java.lang.String>`	`getFailedHosts()` Hosts in this cluster where the precheck failed to run.
`java.util.Map<java.lang.String,HostInfo>`	`getHostInfo()` Map of host IDs to hostname.
`java.util.Map<java.lang.String,HostPrecheckResult>`	`getHostPrecheck()` Map of host IDs to their precheck results.
`StatusInfo`	`getPrecheckResult()` This field represents the precheck results on the cluster, if any one host in the cluster needs to be put in maintenance mode or to be rebooted.
`java.util.List<LocalizableMessage>`	`getRemediationNotes()` Static notes to the user describing steps that will be taken during remediation.
`java.util.List<LocalizableMessage>`	`getRemediationSummary()` Summarizing remediation stating number of hosts needing reboot and maintenance mode during remediation and number of precheck errors on host and cluster.
`java.util.Set<java.lang.String>`	`getSkippedHosts()` Hosts in this cluster where the precheck was not tried because the host was disconnected.
`java.lang.String`	`getSoftwareCommit()` The current commit ID for the software associated with the cluster.
`ClusterPrecheckResult.Status`	`getStatus()` Overall status of precheck on the cluster.
`java.util.Set<java.lang.String>`	`getSuccessfulHosts()` Hosts in this cluster where the precheck was sucessfully run.
`LocalizableMessage`	`getSummary()` Summarizing precheck operation on the host and cluster.
`java.util.List<ValidationError>`	`getValidationErrors()` This field represents the validation errors if the desired configuration specified is not valid.
`int`	`hashCode()`
`void`	`setCommit(java.lang.String commit)` This identifier refers to the commit action of importing the desired configuration document.
`void`	`setEndTime(java.util.Calendar endTime)` Precheck completion time.
`void`	`setFailedHosts(java.util.Set<java.lang.String> failedHosts)` Hosts in this cluster where the precheck failed to run.
`void`	`setHostInfo(java.util.Map<java.lang.String,HostInfo> hostInfo)` Map of host IDs to hostname.
`void`	`setHostPrecheck(java.util.Map<java.lang.String,HostPrecheckResult> hostPrecheck)` Map of host IDs to their precheck results.
`void`	`setPrecheckResult(StatusInfo precheckResult)` This field represents the precheck results on the cluster, if any one host in the cluster needs to be put in maintenance mode or to be rebooted.
`void`	`setRemediationNotes(java.util.List<LocalizableMessage> remediationNotes)` Static notes to the user describing steps that will be taken during remediation.
`void`	`setRemediationSummary(java.util.List<LocalizableMessage> remediationSummary)` Summarizing remediation stating number of hosts needing reboot and maintenance mode during remediation and number of precheck errors on host and cluster.
`void`	`setSkippedHosts(java.util.Set<java.lang.String> skippedHosts)` Hosts in this cluster where the precheck was not tried because the host was disconnected.
`void`	`setSoftwareCommit(java.lang.String softwareCommit)` The current commit ID for the software associated with the cluster.
`void`	`setStatus(ClusterPrecheckResult.Status status)` Overall status of precheck on the cluster.
`void`	`setSuccessfulHosts(java.util.Set<java.lang.String> successfulHosts)` Hosts in this cluster where the precheck was sucessfully run.
`void`	`setSummary(LocalizableMessage summary)` Summarizing precheck operation on the host and cluster.
`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
  - ClusterPrecheckResult
```
public ClusterPrecheckResult()
```
    Default constructor.
  - ClusterPrecheckResult
```
protected ClusterPrecheckResult(com.vmware.vapi.data.StructValue __dynamicStructureFields)
```
- Method Detail
  - getStatus
```
public ClusterPrecheckResult.Status getStatus()
```
    Overall status of precheck on the cluster. Operation is sucessfull when precheck is run on all hosts successfully and no validation or precheck errors are detected. This property was added in vSphere API 8.0.1.0.
    
    Returns:
    
    The current value of the property.
  - setStatus
```
public void setStatus(ClusterPrecheckResult.Status status)
```
    Overall status of precheck on the cluster. Operation is sucessfull when precheck is run on all hosts successfully and no validation or precheck errors are detected. This property was added in vSphere API 8.0.1.0.
    
    Parameters:
    
    status - New value for the property.
  - getCommit
```
public java.lang.String getCommit()
```
    This identifier refers to the commit action of importing the desired configuration document. This property was added in vSphere API 8.0.1.0. This field is s not set for a precheck of a draft configuration.
    
    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.esx.settings.commit. When methods return a value of this class as a return value, the property will be an identifier for the resource type: com.vmware.esx.settings.commit.
  - setCommit
```
public void setCommit(java.lang.String commit)
```
    This identifier refers to the commit action of importing the desired configuration document. This property was added in vSphere API 8.0.1.0. This field is s not set for a precheck of a draft configuration.
    
    Parameters:
    
    commit - 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.esx.settings.commit. When methods return a value of this class as a return value, the property will be an identifier for the resource type: com.vmware.esx.settings.commit.
  - getSoftwareCommit
```
public java.lang.String getSoftwareCommit()
```
    The current commit ID for the software associated with the cluster. This property was added in vSphere API 8.0.1.0.
    
    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.esx.settings.commit. When methods return a value of this class as a return value, the property will be an identifier for the resource type: com.vmware.esx.settings.commit.
  - setSoftwareCommit
```
public void setSoftwareCommit(java.lang.String softwareCommit)
```
    The current commit ID for the software associated with the cluster. This property was added in vSphere API 8.0.1.0.
    
    Parameters:
    
    softwareCommit - 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.esx.settings.commit. When methods return a value of this class as a return value, the property will be an identifier for the resource type: com.vmware.esx.settings.commit.
  - getEndTime
```
public java.util.Calendar getEndTime()
```
    Precheck completion time. This property was added in vSphere API 8.0.1.0.
    
    Returns:
    
    The current value of the property.
  - setEndTime
```
public void setEndTime(java.util.Calendar endTime)
```
    Precheck completion time. This property was added in vSphere API 8.0.1.0.
    
    Parameters:
    
    endTime - New value for the property.
  - getSummary
```
public LocalizableMessage getSummary()
```
    Summarizing precheck operation on the host and cluster. 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 and cluster. This property was added in vSphere API 8.0.1.0.
    
    Parameters:
    
    summary - New value for the property.
  - getRemediationSummary
```
public java.util.List<LocalizableMessage> getRemediationSummary()
```
    Summarizing remediation stating number of hosts needing reboot and maintenance mode during remediation and number of precheck errors on host and cluster. This property was added in vSphere API 8.0.1.0.
    
    Returns:
    
    The current value of the property.
  - setRemediationSummary
```
public void setRemediationSummary(java.util.List<LocalizableMessage> remediationSummary)
```
    Summarizing remediation stating number of hosts needing reboot and maintenance mode during remediation and number of precheck errors on host and cluster. This property was added in vSphere API 8.0.1.0.
    
    Parameters:
    
    remediationSummary - New value for the property.
  - getRemediationNotes
```
public java.util.List<LocalizableMessage> getRemediationNotes()
```
    Static notes to the user describing steps that will be taken during remediation. This property was added in vSphere API 8.0.1.0.
    
    Returns:
    
    The current value of the property.
  - setRemediationNotes
```
public void setRemediationNotes(java.util.List<LocalizableMessage> remediationNotes)
```
    Static notes to the user describing steps that will be taken during remediation. This property was added in vSphere API 8.0.1.0.
    
    Parameters:
    
    remediationNotes - 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.3.0. This field is Set if com.vmware.esx.settings.clusters.configuration.ClusterPrecheckResult#Status is ERROR due to 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.3.0. This field is Set if com.vmware.esx.settings.clusters.configuration.ClusterPrecheckResult#Status is ERROR due to validation errors.
    
    Parameters:
    
    validationErrors - New value for the property.
  - getHostInfo
```
public java.util.Map<java.lang.String,HostInfo> getHostInfo()
```
    Map of host IDs to hostname. This property was added in vSphere API 8.0.1.0.
    
    Returns:
    
    The current value of the property. When clients pass a value of this class as a parameter, the key in the property Map must be an identifier for the resource type: HostSystem. When methods return a value of this class as a return value, the key in the property Map will be an identifier for the resource type: HostSystem.
  - setHostInfo
```
public void setHostInfo(java.util.Map<java.lang.String,HostInfo> hostInfo)
```
    Map of host IDs to hostname. This property was added in vSphere API 8.0.1.0.
    
    Parameters:
    
    hostInfo - New value for the property. When clients pass a value of this class as a parameter, the key in the property Map must be an identifier for the resource type: HostSystem. When methods return a value of this class as a return value, the key in the property Map will be an identifier for the resource type: HostSystem.
  - getHostPrecheck
```
public java.util.Map<java.lang.String,HostPrecheckResult> getHostPrecheck()
```
    Map of host IDs to their precheck results. If getStatus() is ERROR, This field will contain Validation errors or Host Impact and Health Check errors. If getStatus() is OK, This field will contain Impact and Health Check information. This property was added in vSphere API 8.0.1.0.
    
    Returns:
    
    The current value of the property. When clients pass a value of this class as a parameter, the key in the property Map must be an identifier for the resource type: HostSystem. When methods return a value of this class as a return value, the key in the property Map will be an identifier for the resource type: HostSystem.
  - setHostPrecheck
```
public void setHostPrecheck(java.util.Map<java.lang.String,HostPrecheckResult> hostPrecheck)
```
    Map of host IDs to their precheck results. If getStatus() is ERROR, This field will contain Validation errors or Host Impact and Health Check errors. If getStatus() is OK, This field will contain Impact and Health Check information. This property was added in vSphere API 8.0.1.0.
    
    Parameters:
    
    hostPrecheck - New value for the property. When clients pass a value of this class as a parameter, the key in the property Map must be an identifier for the resource type: HostSystem. When methods return a value of this class as a return value, the key in the property Map will be an identifier for the resource type: HostSystem.
  - getPrecheckResult
```
public StatusInfo getPrecheckResult()
```
    This field represents the precheck results on the cluster, if any one host in the cluster 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 cluster prechecks are invoked.
    
    Returns:
    
    The current value of the property.
  - setPrecheckResult
```
public void setPrecheckResult(StatusInfo precheckResult)
```
    This field represents the precheck results on the cluster, if any one host in the cluster 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 cluster prechecks are invoked.
    
    Parameters:
    
    precheckResult - New value for the property.
  - getSuccessfulHosts
```
public java.util.Set<java.lang.String> getSuccessfulHosts()
```
    Hosts in this cluster where the precheck was sucessfully run. This property was added in vSphere API 8.0.1.0.
    
    Returns:
    
    The current value of the property. When clients pass a value of this class as a parameter, the property must contain identifiers for the resource type: HostSystem. When methods return a value of this class as a return value, the property will contain identifiers for the resource type: HostSystem.
  - setSuccessfulHosts
```
public void setSuccessfulHosts(java.util.Set<java.lang.String> successfulHosts)
```
    Hosts in this cluster where the precheck was sucessfully run. This property was added in vSphere API 8.0.1.0.
    
    Parameters:
    
    successfulHosts - New value for the property. When clients pass a value of this class as a parameter, the property must contain identifiers for the resource type: HostSystem. When methods return a value of this class as a return value, the property will contain identifiers for the resource type: HostSystem.
  - getFailedHosts
```
public java.util.Set<java.lang.String> getFailedHosts()
```
    Hosts in this cluster where the precheck failed to run. This property was added in vSphere API 8.0.1.0.
    
    Returns:
    
    The current value of the property. When clients pass a value of this class as a parameter, the property must contain identifiers for the resource type: HostSystem. When methods return a value of this class as a return value, the property will contain identifiers for the resource type: HostSystem.
  - setFailedHosts
```
public void setFailedHosts(java.util.Set<java.lang.String> failedHosts)
```
    Hosts in this cluster where the precheck failed to run. This property was added in vSphere API 8.0.1.0.
    
    Parameters:
    
    failedHosts - New value for the property. When clients pass a value of this class as a parameter, the property must contain identifiers for the resource type: HostSystem. When methods return a value of this class as a return value, the property will contain identifiers for the resource type: HostSystem.
  - getSkippedHosts
```
public java.util.Set<java.lang.String> getSkippedHosts()
```
    Hosts in this cluster where the precheck was not tried because the host was disconnected. This property was added in vSphere API 8.0.1.0.
    
    Returns:
    
    The current value of the property. When clients pass a value of this class as a parameter, the property must contain identifiers for the resource type: HostSystem. When methods return a value of this class as a return value, the property will contain identifiers for the resource type: HostSystem.
  - setSkippedHosts
```
public void setSkippedHosts(java.util.Set<java.lang.String> skippedHosts)
```
    Hosts in this cluster where the precheck was not tried because the host was disconnected. This property was added in vSphere API 8.0.1.0.
    
    Parameters:
    
    skippedHosts - New value for the property. When clients pass a value of this class as a parameter, the property must contain identifiers for the resource type: HostSystem. When methods return a value of this class as a return value, the property will contain identifiers for the resource type: HostSystem.
  - _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 ClusterPrecheckResult _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 ClusterPrecheckResult _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class ClusterPrecheckResult

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

__dynamicStructureFields

Constructor Detail

ClusterPrecheckResult

ClusterPrecheckResult

Method Detail

getStatus

setStatus

getCommit

setCommit

getSoftwareCommit

setSoftwareCommit

getEndTime

setEndTime

getSummary

setSummary

getRemediationSummary

setRemediationSummary

getRemediationNotes

setRemediationNotes

getValidationErrors

setValidationErrors

getHostInfo

setHostInfo

getHostPrecheck

setHostPrecheck

getPrecheckResult

setPrecheckResult

getSuccessfulHosts

setSuccessfulHosts

getFailedHosts

setFailedHosts

getSkippedHosts

setSkippedHosts

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2