com.vmware.esx.settings

Class SoftwareSpec

java.lang.Object

com.vmware.esx.settings.SoftwareSpec

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable

public final class SoftwareSpec
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure

The SoftwareSpec class contains properties that describe desired software specification for an ESX host.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SoftwareSpec.Builder Builder class for SoftwareSpec.

Field Summary

Fields

Modifier and Type	Field and Description
protected com.vmware.vapi.data.StructValue	__dynamicStructureFields

Constructor Summary

Constructors

Modifier	Constructor and Description
	SoftwareSpec() Default constructor.
protected	SoftwareSpec(com.vmware.vapi.data.StructValue __dynamicStructureFields)

Method Summary

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 SoftwareSpec	_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 SoftwareSpec	_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)
AddOnSpec	getAddOn() OEM customization on top of given base-image.
BaseImageSpec	getBaseImage() Base image of the ESX.
java.util.Map<java.lang.String,java.lang.String>	getComponents() Additional components which should be part of the software specification.
HardwareSupportSpec	getHardwareSupport() Information about the Hardware Support Package (HSP) configured in the software specification.
java.util.Set<java.lang.String>	getRemovedComponents() Components to be removed from the software specification.
java.util.Map<java.lang.String,SolutionSpec>	getSolutions() Mapping from solution identifier to the solution specification.
int	hashCode()
void	setAddOn(AddOnSpec addOn) OEM customization on top of given base-image.
void	setBaseImage(BaseImageSpec baseImage) Base image of the ESX.
void	setComponents(java.util.Map<java.lang.String,java.lang.String> components) Additional components which should be part of the software specification.
void	setHardwareSupport(HardwareSupportSpec hardwareSupport) Information about the Hardware Support Package (HSP) configured in the software specification.
void	setRemovedComponents(java.util.Set<java.lang.String> removedComponents) Components to be removed from the software specification.
void	setSolutions(java.util.Map<java.lang.String,SolutionSpec> solutions) Mapping from solution identifier to the solution specification.
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

SoftwareSpec

public SoftwareSpec()

Default constructor.

SoftwareSpec

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

Method Detail

getBaseImage

public BaseImageSpec getBaseImage()

Base image of the ESX.

Returns:

The current value of the property.

setBaseImage

public void setBaseImage(BaseImageSpec baseImage)

Base image of the ESX.

Parameters:

baseImage - New value for the property.

getAddOn

public AddOnSpec getAddOn()

OEM customization on top of given base-image. The components in this customization override the components in the base base-image. If null, no OEM customization will be applied.

Returns:

The current value of the property.

setAddOn

public void setAddOn(AddOnSpec addOn)

OEM customization on top of given base-image. The components in this customization override the components in the base base-image. If null, no OEM customization will be applied.

Parameters:

addOn - New value for the property.

getComponents

public java.util.Map<java.lang.String,java.lang.String> getComponents()

Additional components which should be part of the software specification. If value is not given for a particular component then version for that component will be picked from the constraints. These override the components present in getAddOn() and getBaseImage(). If null, no additional components will be installed.

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,java.lang.String> components)

Additional components which should be part of the software specification. If value is not given for a particular component then version for that component will be picked from the constraints. These override the components present in getAddOn() and getBaseImage(). If null, no additional components will be installed.

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,SolutionSpec> getSolutions()

Mapping from solution identifier to the solution specification. The key is the solution name and the value is the specification detailing components registered by that solution. If null, no solutions will be part of the software specification.

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,SolutionSpec> solutions)

Mapping from solution identifier to the solution specification. The key is the solution name and the value is the specification detailing components registered by that solution. If null, no solutions will be part of the software specification.

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.

getHardwareSupport

public HardwareSupportSpec getHardwareSupport()

Information about the Hardware Support Package (HSP) configured in the software specification. If null or empty, no firmware compliance checking or remediation will be done.

Returns:

The current value of the property.

setHardwareSupport

public void setHardwareSupport(HardwareSupportSpec hardwareSupport)

Information about the Hardware Support Package (HSP) configured in the software specification. If null or empty, no firmware compliance checking or remediation will be done.

Parameters:

hardwareSupport - New value for the property.

getRemovedComponents

public java.util.Set<java.lang.String> getRemovedComponents()

Components to be removed from the software specification. This property was added in vSphere API 8.0.3.0. If null no component will be removed.

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: com.vmware.esx.settings.component. When methods return a value of this class as a return value, the property will contain identifiers for the resource type: com.vmware.esx.settings.component.

setRemovedComponents

public void setRemovedComponents(java.util.Set<java.lang.String> removedComponents)

Components to be removed from the software specification. This property was added in vSphere API 8.0.3.0. If null no component will be removed.

Parameters:

removedComponents - 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: com.vmware.esx.settings.component. When methods return a value of this class as a return value, the property will contain identifiers for the resource type: com.vmware.esx.settings.component.

_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 SoftwareSpec _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 SoftwareSpec _newInstance2(com.vmware.vapi.data.StructValue structValue)

WARNING: Internal method, subject to change in future versions.
Serves as a versioning mechanism.