ClusterCompliance

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

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
```
public final class ClusterCompliance
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
```
This ClusterCompliance class contains properties that describe the compliance result for each host in the cluster as well as overall cluster compliance status. 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`	`ClusterCompliance.Builder` Builder class for `ClusterCompliance`.
`static class`	`ClusterCompliance.Status` Consolidated compliance status of 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

ClusterCompliance()
Default constructor.

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

Constructors
Modifier	Constructor and Description
	`ClusterCompliance()` Default constructor.
`protected`	`ClusterCompliance(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 ClusterCompliance`	`_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 ClusterCompliance`	`_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)`
`ClusterCompliance.Status`	`getClusterStatus()` Consolidated status of all host compliance checks.
`java.lang.String`	`getCommit()` This identifier refers to the commit action of importing the desired configuration document.
`java.util.Set<java.lang.String>`	`getCompliantHosts()` Identifiers of compliant hosts.
`java.util.Calendar`	`getEndTime()` CheckCompliance completion time.
`java.util.Set<java.lang.String>`	`getFailedHosts()` Identifiers of hosts where the operation failed.
`java.util.Map<java.lang.String,HostInfo>`	`getHostInfo()` Map of host IDs to hostname.
`java.util.Map<java.lang.String,HostResult>`	`getHosts()` Map of host IDs to their compliance results.
`java.util.Set<java.lang.String>`	`getNonCompliantHosts()` Identifiers of non-compliant hosts.
`java.util.Set<java.lang.String>`	`getSkippedHosts()` Identifiers of hosts where the operation was skipped.
`java.lang.String`	`getSoftwareCommit()` The current commit ID for the software associated with the cluster.
`LocalizableMessage`	`getSummary()` Summarizing check compliance operation on the hosts in the cluster.
`java.util.List<ValidationError>`	`getValidationErrors()` This field represents the validation errors if the desired configuration specified is not valid.
`int`	`hashCode()`
`void`	`setClusterStatus(ClusterCompliance.Status clusterStatus)` Consolidated status of all host compliance checks.
`void`	`setCommit(java.lang.String commit)` This identifier refers to the commit action of importing the desired configuration document.
`void`	`setCompliantHosts(java.util.Set<java.lang.String> compliantHosts)` Identifiers of compliant hosts.
`void`	`setEndTime(java.util.Calendar endTime)` CheckCompliance completion time.
`void`	`setFailedHosts(java.util.Set<java.lang.String> failedHosts)` Identifiers of hosts where the operation failed.
`void`	`setHostInfo(java.util.Map<java.lang.String,HostInfo> hostInfo)` Map of host IDs to hostname.
`void`	`setHosts(java.util.Map<java.lang.String,HostResult> hosts)` Map of host IDs to their compliance results.
`void`	`setNonCompliantHosts(java.util.Set<java.lang.String> nonCompliantHosts)` Identifiers of non-compliant hosts.
`void`	`setSkippedHosts(java.util.Set<java.lang.String> skippedHosts)` Identifiers of hosts where the operation was skipped.
`void`	`setSoftwareCommit(java.lang.String softwareCommit)` The current commit ID for the software associated with the cluster.
`void`	`setSummary(LocalizableMessage summary)` Summarizing check compliance operation on the hosts in the 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
  - ClusterCompliance
```
public ClusterCompliance()
```
    Default constructor.
  - ClusterCompliance
```
protected ClusterCompliance(com.vmware.vapi.data.StructValue __dynamicStructureFields)
```
- Method Detail
  - getClusterStatus
```
public ClusterCompliance.Status getClusterStatus()
```
    Consolidated status of all host compliance checks. This property was added in vSphere API 8.0.1.0.
    
    Returns:
    
    The current value of the property.
  - setClusterStatus
```
public void setClusterStatus(ClusterCompliance.Status clusterStatus)
```
    Consolidated status of all host compliance checks. This property was added in vSphere API 8.0.1.0.
    
    Parameters:
    
    clusterStatus - New value for the property.
  - getCommit
```
public java.lang.String getCommit()
```
    This identifier refers to the commit action of importing the desired configuration document. It will not be set for a draft execution of check compliance. 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.
  - setCommit
```
public void setCommit(java.lang.String commit)
```
    This identifier refers to the commit action of importing the desired configuration document. It will not be set for a draft execution of check compliance. This property was added in vSphere API 8.0.1.0.
    
    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.
  - getSummary
```
public LocalizableMessage getSummary()
```
    Summarizing check compliance operation on the hosts in the 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 check compliance operation on the hosts in the cluster. 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.3.0. This field may be Set if getClusterStatus() is NOT_COMPLIANT 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 may be Set if getClusterStatus() is NOT_COMPLIANT 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.
  - getHosts
```
public java.util.Map<java.lang.String,HostResult> getHosts()
```
    Map of host IDs to their compliance results. 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.
  - setHosts
```
public void setHosts(java.util.Map<java.lang.String,HostResult> hosts)
```
    Map of host IDs to their compliance results. This property was added in vSphere API 8.0.1.0.
    
    Parameters:
    
    hosts - 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.
  - getCompliantHosts
```
public java.util.Set<java.lang.String> getCompliantHosts()
```
    Identifiers of compliant hosts. 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.
  - setCompliantHosts
```
public void setCompliantHosts(java.util.Set<java.lang.String> compliantHosts)
```
    Identifiers of compliant hosts. This property was added in vSphere API 8.0.1.0.
    
    Parameters:
    
    compliantHosts - 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.
  - getNonCompliantHosts
```
public java.util.Set<java.lang.String> getNonCompliantHosts()
```
    Identifiers of non-compliant hosts. 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.
  - setNonCompliantHosts
```
public void setNonCompliantHosts(java.util.Set<java.lang.String> nonCompliantHosts)
```
    Identifiers of non-compliant hosts. This property was added in vSphere API 8.0.1.0.
    
    Parameters:
    
    nonCompliantHosts - 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()
```
    Identifiers of hosts where the operation failed. 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)
```
    Identifiers of hosts where the operation failed. 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()
```
    Identifiers of hosts where the operation was skipped. i.e disconnected hosts. 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)
```
    Identifiers of hosts where the operation was skipped. i.e disconnected hosts. 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.
  - getEndTime
```
public java.util.Calendar getEndTime()
```
    CheckCompliance 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)
```
    CheckCompliance completion time. This property was added in vSphere API 8.0.1.0.
    
    Parameters:
    
    endTime - 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 ClusterCompliance _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 ClusterCompliance _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class ClusterCompliance

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

__dynamicStructureFields

Constructor Detail

ClusterCompliance

ClusterCompliance

Method Detail

getClusterStatus

setClusterStatus

getCommit

setCommit

getSoftwareCommit

setSoftwareCommit

getSummary

setSummary

getValidationErrors

setValidationErrors

getHostInfo

setHostInfo

getHosts

setHosts

getCompliantHosts

setCompliantHosts

getNonCompliantHosts

setNonCompliantHosts

getFailedHosts

setFailedHosts

getSkippedHosts

setSkippedHosts

getEndTime

setEndTime

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2