HostCompliance

java.lang.Object
- com.vmware.esx.settings.HostCompliance

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
```
public final class HostCompliance
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
```
The HostCompliance class contains information to describe the compliance result of a host with respect to given target software specification. DataProcessingUnitCompliance is mirror of this class. Any future changes in either of them should reflect in both.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class HostCompliance.Builder
Builder class for HostCompliance.

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

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

HostCompliance()
Default constructor.

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

Constructors
Modifier	Constructor and Description
	`HostCompliance()` Default constructor.
`protected`	`HostCompliance(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 HostCompliance`	`_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 HostCompliance`	`_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)`
`AddOnCompliance`	`getAddOn()` Compliance result for the OEM add-on.
`BaseImageCompliance`	`getBaseImage()` Compliance result for the base image.
`java.lang.String`	`getCommit()` Identifier of the commit on which the scan is run to generate this result.
`Notification`	`getComplianceStatusDetails()` User-friendly notification to describe the compliance status in detail.
`java.util.Map<java.lang.String,ComponentCompliance>`	`getComponents()` Compliance result for all the effective components and all the components present on the host.
`DataProcessingUnitsCompliance`	`getDataProcessingUnitsCompliance()` Compliance results of all data processing units on the host.
`java.util.Map<java.lang.String,HardwareSupportPackageCompliance>`	`getHardwareSupport()` Compliance result for hardware support (both Hardware Support Package or HSP and individual hardware module firmware) for every HSP configured, keyed by Hardware Support Manager (HSM).
`ComplianceImpact`	`getImpact()` Overall impact.
`ImpactDetails`	`getImpactDetails()` Details about compliance impact.
`Notifications`	`getNotifications()` Notifications returned by the scan operation.
`RemediationDetails`	`getRemediationDetails()` Details about remediation actions, including a list of pending remediation actions.
`java.util.Map<java.lang.String,ComponentCompliance>`	`getRemovedComponents()` Compliance result for all removed components present on the host and in the software specification.
`java.util.Calendar`	`getScanTime()` Scan completion time.
`java.util.Map<java.lang.String,SolutionCompliance>`	`getSolutions()` Compliance result for solutions.
`StageStatus`	`getStageStatus()` Overall stage status of the host.
`ComplianceStatus`	`getStatus()` Overall compliance status of the host.
`int`	`hashCode()`
`void`	`setAddOn(AddOnCompliance addOn)` Compliance result for the OEM add-on.
`void`	`setBaseImage(BaseImageCompliance baseImage)` Compliance result for the base image.
`void`	`setCommit(java.lang.String commit)` Identifier of the commit on which the scan is run to generate this result.
`void`	`setComplianceStatusDetails(Notification complianceStatusDetails)` User-friendly notification to describe the compliance status in detail.
`void`	`setComponents(java.util.Map<java.lang.String,ComponentCompliance> components)` Compliance result for all the effective components and all the components present on the host.
`void`	`setDataProcessingUnitsCompliance(DataProcessingUnitsCompliance dataProcessingUnitsCompliance)` Compliance results of all data processing units on the host.
`void`	`setHardwareSupport(java.util.Map<java.lang.String,HardwareSupportPackageCompliance> hardwareSupport)` Compliance result for hardware support (both Hardware Support Package or HSP and individual hardware module firmware) for every HSP configured, keyed by Hardware Support Manager (HSM).
`void`	`setImpact(ComplianceImpact impact)` Overall impact.
`void`	`setImpactDetails(ImpactDetails impactDetails)` Details about compliance impact.
`void`	`setNotifications(Notifications notifications)` Notifications returned by the scan operation.
`void`	`setRemediationDetails(RemediationDetails remediationDetails)` Details about remediation actions, including a list of pending remediation actions.
`void`	`setRemovedComponents(java.util.Map<java.lang.String,ComponentCompliance> removedComponents)` Compliance result for all removed components present on the host and in the software specification.
`void`	`setScanTime(java.util.Calendar scanTime)` Scan completion time.
`void`	`setSolutions(java.util.Map<java.lang.String,SolutionCompliance> solutions)` Compliance result for solutions.
`void`	`setStageStatus(StageStatus stageStatus)` Overall stage status of the host.
`void`	`setStatus(ComplianceStatus status)` Overall compliance status of 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
  - HostCompliance
```
public HostCompliance()
```
    Default constructor.
  - HostCompliance
```
protected HostCompliance(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 host.
    
    Returns:
    
    The current value of the property.
  - setStatus
```
public void setStatus(ComplianceStatus status)
```
    Overall compliance status of the host.
    
    Parameters:
    
    status - New value for the property.
  - getStageStatus
```
public StageStatus getStageStatus()
```
    Overall stage status of the host. 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 host. 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 working copy document.
    
    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 working copy document.
    
    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.
  - getBaseImage
```
public BaseImageCompliance getBaseImage()
```
    Compliance result for the base image.
    
    Returns:
    
    The current value of the property.
  - setBaseImage
```
public void setBaseImage(BaseImageCompliance baseImage)
```
    Compliance result for the base image.
    
    Parameters:
    
    baseImage - New value for the property.
  - getAddOn
```
public AddOnCompliance getAddOn()
```
    Compliance result for the OEM add-on.
    
    Returns:
    
    The current value of the property.
  - setAddOn
```
public void setAddOn(AddOnCompliance addOn)
```
    Compliance result for the OEM add-on.
    
    Parameters:
    
    addOn - New value for the property.
  - getHardwareSupport
```
public java.util.Map<java.lang.String,HardwareSupportPackageCompliance> getHardwareSupport()
```
    Compliance result for hardware support (both Hardware Support Package or HSP and individual hardware module firmware) for every HSP configured, keyed by Hardware Support Manager (HSM). This property will be null or contain an empty map if operation is performed on an image whose SoftwareSpec does not have a value for its hardwareSupport property.
    
    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: com.vmware.esx.setting.hardware_support.manager. 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: com.vmware.esx.setting.hardware_support.manager.
  - setHardwareSupport
```
public void setHardwareSupport(java.util.Map<java.lang.String,HardwareSupportPackageCompliance> hardwareSupport)
```
    Compliance result for hardware support (both Hardware Support Package or HSP and individual hardware module firmware) for every HSP configured, keyed by Hardware Support Manager (HSM). This property will be null or contain an empty map if operation is performed on an image whose SoftwareSpec does not have a value for its hardwareSupport property.
    
    Parameters:
    
    hardwareSupport - 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: com.vmware.esx.setting.hardware_support.manager. 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: com.vmware.esx.setting.hardware_support.manager.
  - getComponents
```
public java.util.Map<java.lang.String,ComponentCompliance> getComponents()
```
    Compliance result for all the effective components and all the components present on the host. The key is the component name and value is the ComponentCompliance.
    
    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: com.vmware.esx.settings.component. 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: com.vmware.esx.settings.component.
  - setComponents
```
public void setComponents(java.util.Map<java.lang.String,ComponentCompliance> components)
```
    Compliance result for all the effective components and all the components present on the host. The key is the component name and value is the ComponentCompliance.
    
    Parameters:
    
    components - 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: com.vmware.esx.settings.component. 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: com.vmware.esx.settings.component.
  - getSolutions
```
public java.util.Map<java.lang.String,SolutionCompliance> getSolutions()
```
    Compliance result for solutions. The key is the solution name and value is the SolutionCompliance.
    
    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: com.vmware.esx.settings.solution. 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: com.vmware.esx.settings.solution.
  - setSolutions
```
public void setSolutions(java.util.Map<java.lang.String,SolutionCompliance> solutions)
```
    Compliance result for solutions. The key is the solution name and value is the SolutionCompliance.
    
    Parameters:
    
    solutions - 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: com.vmware.esx.settings.solution. 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: com.vmware.esx.settings.solution.
  - getRemovedComponents
```
public java.util.Map<java.lang.String,ComponentCompliance> getRemovedComponents()
```
    Compliance result for all removed components present on the host and in the software specification. The key is the component name and value is the ComponentCompliance object. This property was added in vSphere API 8.0.3.0. This property is optional because it was added in a newer version than its parent node.
    
    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: com.vmware.esx.settings.component. 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: com.vmware.esx.settings.component.
  - setRemovedComponents
```
public void setRemovedComponents(java.util.Map<java.lang.String,ComponentCompliance> removedComponents)
```
    Compliance result for all removed components present on the host and in the software specification. The key is the component name and value is the ComponentCompliance object. This property was added in vSphere API 8.0.3.0. This property is optional because it was added in a newer version than its parent node.
    
    Parameters:
    
    removedComponents - 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: com.vmware.esx.settings.component. 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: com.vmware.esx.settings.component.
  - getImpactDetails
```
public ImpactDetails getImpactDetails()
```
    Details about compliance impact. This property was added in vSphere API 8.0.3.0. This property is optional because it was added in a newer version than its parent node.
    
    Returns:
    
    The current value of the property.
  - setImpactDetails
```
public void setImpactDetails(ImpactDetails impactDetails)
```
    Details about compliance impact. This property was added in vSphere API 8.0.3.0. This property is optional because it was added in a newer version than its parent node.
    
    Parameters:
    
    impactDetails - New value for the property.
  - getDataProcessingUnitsCompliance
```
public DataProcessingUnitsCompliance getDataProcessingUnitsCompliance()
```
    Compliance results of all data processing units on the host. This property was added in vSphere API 8.0.0.1. This property will be null if host doesn't have any data processing units.
    
    Returns:
    
    The current value of the property.
  - setDataProcessingUnitsCompliance
```
public void setDataProcessingUnitsCompliance(DataProcessingUnitsCompliance dataProcessingUnitsCompliance)
```
    Compliance results of all data processing units on the host. This property was added in vSphere API 8.0.0.1. This property will be null if host doesn't have any data processing units.
    
    Parameters:
    
    dataProcessingUnitsCompliance - New value for the property.
  - getComplianceStatusDetails
```
public Notification getComplianceStatusDetails()
```
    User-friendly notification to describe the compliance status in detail. This property was added in vSphere API 8.0.3.0. If null, the default compliance status message will be shown.
    
    Returns:
    
    The current value of the property.
  - setComplianceStatusDetails
```
public void setComplianceStatusDetails(Notification complianceStatusDetails)
```
    User-friendly notification to describe the compliance status in detail. This property was added in vSphere API 8.0.3.0. If null, the default compliance status message will be shown.
    
    Parameters:
    
    complianceStatusDetails - New value for the property.
  - getRemediationDetails
```
public RemediationDetails getRemediationDetails()
```
    Details about remediation actions, including a list of pending remediation actions. This property was added in vSphere API 8.0.3.0. for now, Set only when Quick Patch is supported and the Quick Patch remediation policy is enforced.
    
    Returns:
    
    The current value of the property.
  - setRemediationDetails
```
public void setRemediationDetails(RemediationDetails remediationDetails)
```
    Details about remediation actions, including a list of pending remediation actions. This property was added in vSphere API 8.0.3.0. for now, Set only when Quick Patch is supported and the Quick Patch remediation policy is enforced.
    
    Parameters:
    
    remediationDetails - 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 HostCompliance _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 HostCompliance _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class HostCompliance

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

__dynamicStructureFields

Constructor Detail

HostCompliance

HostCompliance

Method Detail

getImpact

setImpact

getStatus

setStatus

getStageStatus

setStageStatus

getNotifications

setNotifications

getScanTime

setScanTime

getCommit

setCommit

getBaseImage

setBaseImage

getAddOn

setAddOn

getHardwareSupport

setHardwareSupport

getComponents

setComponents

getSolutions

setSolutions

getRemovedComponents

setRemovedComponents

getImpactDetails

setImpactDetails

getDataProcessingUnitsCompliance

setDataProcessingUnitsCompliance

getComplianceStatusDetails

setComplianceStatusDetails

getRemediationDetails

setRemediationDetails

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2