com.vmware.esx.settings

Class HostCompliance.Builder

java.lang.Object

com.vmware.esx.settings.HostCompliance.Builder

Enclosing class:

HostCompliance

public static final class HostCompliance.Builder
extends java.lang.Object

Builder class for HostCompliance.

Constructor Summary

Constructors

Constructor and Description
Builder(ComplianceImpact impact, ComplianceStatus status, Notifications notifications, java.util.Calendar scanTime, BaseImageCompliance baseImage, AddOnCompliance addOn, java.util.Map<java.lang.String,ComponentCompliance> components, java.util.Map<java.lang.String,SolutionCompliance> solutions) Constructor with parameters for the required properties of HostCompliance.

Method Summary

Modifier and Type	Method and Description
HostCompliance	build()
HostCompliance.Builder	setCommit(java.lang.String commit) Identifier of the commit on which the scan is run to generate this result.
HostCompliance.Builder	setComplianceStatusDetails(Notification complianceStatusDetails) User-friendly notification to describe the compliance status in detail.
HostCompliance.Builder	setDataProcessingUnitsCompliance(DataProcessingUnitsCompliance dataProcessingUnitsCompliance) Compliance results of all data processing units on the host.
HostCompliance.Builder	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).
HostCompliance.Builder	setImpactDetails(ImpactDetails impactDetails) Details about compliance impact.
HostCompliance.Builder	setRemediationDetails(RemediationDetails remediationDetails) Details about remediation actions, including a list of pending remediation actions.
HostCompliance.Builder	setRemovedComponents(java.util.Map<java.lang.String,ComponentCompliance> removedComponents) Compliance result for all removed components present on the host and in the software specification.
HostCompliance.Builder	setStageStatus(StageStatus stageStatus) Overall stage status of the host.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder(ComplianceImpact impact,
               ComplianceStatus status,
               Notifications notifications,
               java.util.Calendar scanTime,
               BaseImageCompliance baseImage,
               AddOnCompliance addOn,
               java.util.Map<java.lang.String,ComponentCompliance> components,
               java.util.Map<java.lang.String,SolutionCompliance> solutions)

Constructor with parameters for the required properties of HostCompliance.

Method Detail

setStageStatus

public HostCompliance.Builder setStageStatus(StageStatus stageStatus)

Overall stage status of the host. This is only relevant when the value of HostCompliance.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.

setCommit

public HostCompliance.Builder 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.

setHardwareSupport

public HostCompliance.Builder 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.

setRemovedComponents

public HostCompliance.Builder 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.

setImpactDetails

public HostCompliance.Builder 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.

setDataProcessingUnitsCompliance

public HostCompliance.Builder 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.

setComplianceStatusDetails

public HostCompliance.Builder 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.

setRemediationDetails

public HostCompliance.Builder 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.

build

public HostCompliance build()