ClusterCompliance

java.lang.Object
- com.vmware.esx.settings.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
```
The ClusterCompliance class contains properties to describe the compliance result of a cluster.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ClusterCompliance.Builder
Builder class for ClusterCompliance.

Nested Classes
Modifier and Type	Class and Description
`static class`	`ClusterCompliance.Builder` Builder class for `ClusterCompliance`.

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)`
`java.lang.String`	`getCommit()` Identifier of the commit on which the scan is run to generate this result.
`java.util.Set<java.lang.String>`	`getCompliantHosts()` Identifiers of compliant hosts.
`java.util.Map<java.lang.String,HostInfo>`	`getHostInfo()` Auxillary information about the hosts.
`java.util.Map<java.lang.String,HostCompliance>`	`getHosts()` Mapping from host identifier to the compliance information for the host.
`ComplianceImpact`	`getImpact()` Overall impact.
`java.util.Set<java.lang.String>`	`getIncompatibleHosts()` Identifiers of incompatible hosts.
`java.util.Set<java.lang.String>`	`getNonCompliantHosts()` Identifiers of non-compliant hosts.
`Notifications`	`getNotifications()` Notifications returned by the scan operation.
`java.util.Calendar`	`getScanTime()` Scan completion time.
`StageStatus`	`getStageStatus()` Overall stage status of the cluster.
`ComplianceStatus`	`getStatus()` Overall compliance status of the cluster.
`java.util.Set<java.lang.String>`	`getUnavailableHosts()` Identifiers of unavailable hosts.
`int`	`hashCode()`
`void`	`setCommit(java.lang.String commit)` Identifier of the commit on which the scan is run to generate this result.
`void`	`setCompliantHosts(java.util.Set<java.lang.String> compliantHosts)` Identifiers of compliant hosts.
`void`	`setHostInfo(java.util.Map<java.lang.String,HostInfo> hostInfo)` Auxillary information about the hosts.
`void`	`setHosts(java.util.Map<java.lang.String,HostCompliance> hosts)` Mapping from host identifier to the compliance information for the host.
`void`	`setImpact(ComplianceImpact impact)` Overall impact.
`void`	`setIncompatibleHosts(java.util.Set<java.lang.String> incompatibleHosts)` Identifiers of incompatible hosts.
`void`	`setNonCompliantHosts(java.util.Set<java.lang.String> nonCompliantHosts)` Identifiers of non-compliant hosts.
`void`	`setNotifications(Notifications notifications)` Notifications returned by the scan operation.
`void`	`setScanTime(java.util.Calendar scanTime)` Scan completion time.
`void`	`setStageStatus(StageStatus stageStatus)` Overall stage status of the cluster.
`void`	`setStatus(ComplianceStatus status)` Overall compliance status of the cluster.
`void`	`setUnavailableHosts(java.util.Set<java.lang.String> unavailableHosts)` Identifiers of unavailable hosts.
`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
  - getImpact
```
public ComplianceImpact getImpact()
```
    Overall impact.
    
    Returns:
    
    The current value of the property.
  - setImpact
```
public void setImpact(ComplianceImpact impact)
```
    Overall impact.
    
    Parameters:
    
    impact - New value for the property.
  - getStatus
```
public ComplianceStatus getStatus()
```
    Overall compliance status of the cluster.
    
    Returns:
    
    The current value of the property.
  - setStatus
```
public void setStatus(ComplianceStatus status)
```
    Overall compliance status of the cluster.
    
    Parameters:
    
    status - New value for the property.
  - getStageStatus
```
public StageStatus getStageStatus()
```
    Overall stage status of the cluster. This is only relevant when the value of getStatus() is ComplianceStatus.NON_COMPLIANT. This property was added in vSphere API 8.0.0.1. If null the staging status is unknown - the contents may or may not be staged. This can happen, for instance, if the stage check failed, has not been done yet, or the target uses an older interface that does not include support for returning the staged status.
    
    Returns:
    
    The current value of the property.
  - setStageStatus
```
public void setStageStatus(StageStatus stageStatus)
```
    Overall stage status of the cluster. This is only relevant when the value of getStatus() is ComplianceStatus.NON_COMPLIANT. This property was added in vSphere API 8.0.0.1. If null the staging status is unknown - the contents may or may not be staged. This can happen, for instance, if the stage check failed, has not been done yet, or the target uses an older interface that does not include support for returning the staged status.
    
    Parameters:
    
    stageStatus - New value for the property.
  - getNotifications
```
public Notifications getNotifications()
```
    Notifications returned by the scan operation.
    
    Returns:
    
    The current value of the property.
  - setNotifications
```
public void setNotifications(Notifications notifications)
```
    Notifications returned by the scan operation.
    
    Parameters:
    
    notifications - New value for the property.
  - getScanTime
```
public java.util.Calendar getScanTime()
```
    Scan completion time.
    
    Returns:
    
    The current value of the property.
  - setScanTime
```
public void setScanTime(java.util.Calendar scanTime)
```
    Scan completion time.
    
    Parameters:
    
    scanTime - New value for the property.
  - getCommit
```
public java.lang.String getCommit()
```
    Identifier of the commit on which the scan is run to generate this result. null if operation is performed on a draft.
    
    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)
```
    Identifier of the commit on which the scan is run to generate this result. null if operation is performed on a draft.
    
    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.
  - getCompliantHosts
```
public java.util.Set<java.lang.String> getCompliantHosts()
```
    Identifiers of compliant hosts.
    
    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.
    
    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.
    
    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.
    
    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.
  - getIncompatibleHosts
```
public java.util.Set<java.lang.String> getIncompatibleHosts()
```
    Identifiers of incompatible hosts.
    
    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.
  - setIncompatibleHosts
```
public void setIncompatibleHosts(java.util.Set<java.lang.String> incompatibleHosts)
```
    Identifiers of incompatible hosts.
    
    Parameters:
    
    incompatibleHosts - 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.
  - getUnavailableHosts
```
public java.util.Set<java.lang.String> getUnavailableHosts()
```
    Identifiers of unavailable hosts. There will not be compliance details for these hosts in getHosts().
    
    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.
  - setUnavailableHosts
```
public void setUnavailableHosts(java.util.Set<java.lang.String> unavailableHosts)
```
    Identifiers of unavailable hosts. There will not be compliance details for these hosts in getHosts().
    
    Parameters:
    
    unavailableHosts - 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.
  - getHosts
```
public java.util.Map<java.lang.String,HostCompliance> getHosts()
```
    Mapping from host identifier to the compliance information for the host.
    
    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,HostCompliance> hosts)
```
    Mapping from host identifier to the compliance information for the host.
    
    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.
  - getHostInfo
```
public java.util.Map<java.lang.String,HostInfo> getHostInfo()
```
    Auxillary information about the hosts. This gives some additional information about the hosts referenced in this result.
    
    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)
```
    Auxillary information about the hosts. This gives some additional information about the hosts referenced in this result.
    
    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.
  - _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

getImpact

setImpact

getStatus

setStatus

getStageStatus

setStageStatus

getNotifications

setNotifications

getScanTime

setScanTime

getCommit

setCommit

getCompliantHosts

setCompliantHosts

getNonCompliantHosts

setNonCompliantHosts

getIncompatibleHosts

setIncompatibleHosts

getUnavailableHosts

setUnavailableHosts

getHosts

setHosts

getHostInfo

setHostInfo

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2