com.vmware.esx.settings

Class EffectiveComponentDetails

java.lang.Object

com.vmware.esx.settings.EffectiveComponentDetails

All Implemented Interfaces:

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

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

The EffectiveComponentDetails class contains information that provide more details about the component from the depot.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	EffectiveComponentDetails() Default constructor.
protected	EffectiveComponentDetails(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 EffectiveComponentDetails	_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 EffectiveComponentDetails	_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	getDisplayName() Display name of the component.
java.lang.String	getDisplayVersion() Human readable version of the component.
ImageCustomizationAction	getImageCustomizationAction() Image customization status for the current component.
LocalizableMessage	getImageCustomizationDescription() Localized text describing the imageCustomizationAction.
LocalizableMessage	getNote() Note assosicated with this component.
java.util.List<ComponentOverrideInfo>	getOverriddenComponents() List of other component versions present in base image, add-ons or solutions that this component is overriding.
java.lang.Boolean	getRemovable() Flag to indicate if the component can be removed by specifying its name in the removed components section of the software specification.
ComponentSource	getSource() Final effective source of the component.
java.lang.String	getVendor() Vendor of the component.
int	hashCode()
void	setDisplayName(java.lang.String displayName) Display name of the component.
void	setDisplayVersion(java.lang.String displayVersion) Human readable version of the component.
void	setImageCustomizationAction(ImageCustomizationAction imageCustomizationAction) Image customization status for the current component.
void	setImageCustomizationDescription(LocalizableMessage imageCustomizationDescription) Localized text describing the imageCustomizationAction.
void	setNote(LocalizableMessage note) Note assosicated with this component.
void	setOverriddenComponents(java.util.List<ComponentOverrideInfo> overriddenComponents) List of other component versions present in base image, add-ons or solutions that this component is overriding.
void	setRemovable(java.lang.Boolean removable) Flag to indicate if the component can be removed by specifying its name in the removed components section of the software specification.
void	setSource(ComponentSource source) Final effective source of the component.
void	setVendor(java.lang.String vendor) Vendor of the component.
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

EffectiveComponentDetails

public EffectiveComponentDetails()

Default constructor.

EffectiveComponentDetails

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

Method Detail

getDisplayName

public java.lang.String getDisplayName()

Display name of the component.

Returns:

The current value of the property.

setDisplayName

public void setDisplayName(java.lang.String displayName)

Display name of the component.

Parameters:

displayName - New value for the property.

getDisplayVersion

public java.lang.String getDisplayVersion()

Human readable version of the component.

Returns:

The current value of the property.

setDisplayVersion

public void setDisplayVersion(java.lang.String displayVersion)

Human readable version of the component.

Parameters:

displayVersion - New value for the property.

getVendor

public java.lang.String getVendor()

Vendor of the component.

Returns:

The current value of the property.

setVendor

public void setVendor(java.lang.String vendor)

Vendor of the component.

Parameters:

vendor - New value for the property.

getSource

public ComponentSource getSource()

Final effective source of the component.

Returns:

The current value of the property.

setSource

public void setSource(ComponentSource source)

Final effective source of the component.

Parameters:

source - New value for the property.

getNote

public LocalizableMessage getNote()

Note assosicated with this component. If null, note is present for this component.

Returns:

The current value of the property.

setNote

public void setNote(LocalizableMessage note)

Note assosicated with this component. If null, note is present for this component.

Parameters:

note - New value for the property.

getOverriddenComponents

public java.util.List<ComponentOverrideInfo> getOverriddenComponents()

List of other component versions present in base image, add-ons or solutions that this component is overriding. For example, if a component version-1 was implicitly present in the base image, but user wants it to be changed to version-2. In that case, getSource() would be USER and there will be one entry in this list indicating base image component version-1 is being overridden.

Returns:

The current value of the property.

setOverriddenComponents

public void setOverriddenComponents(java.util.List<ComponentOverrideInfo> overriddenComponents)

List of other component versions present in base image, add-ons or solutions that this component is overriding. For example, if a component version-1 was implicitly present in the base image, but user wants it to be changed to version-2. In that case, getSource() would be USER and there will be one entry in this list indicating base image component version-1 is being overridden.

Parameters:

overriddenComponents - New value for the property.

getRemovable

public java.lang.Boolean getRemovable()

Flag to indicate if the component can be removed by specifying its name in the removed components section of the software specification. 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.

setRemovable

public void setRemovable(java.lang.Boolean removable)

Flag to indicate if the component can be removed by specifying its name in the removed components section of the software specification. 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:

removable - New value for the property.

getImageCustomizationAction

public ImageCustomizationAction getImageCustomizationAction()

Image customization status for the current component. This property was added in vSphere API 8.0.3.0. if null the component is not customized.

Returns:

The current value of the property.

setImageCustomizationAction

public void setImageCustomizationAction(ImageCustomizationAction imageCustomizationAction)

Image customization status for the current component. This property was added in vSphere API 8.0.3.0. if null the component is not customized.

Parameters:

imageCustomizationAction - New value for the property.

getImageCustomizationDescription

public LocalizableMessage getImageCustomizationDescription()

Localized text describing the imageCustomizationAction. This property was added in vSphere API 8.0.3.0. if null the component is not customized.

Returns:

The current value of the property.

setImageCustomizationDescription

public void setImageCustomizationDescription(LocalizableMessage imageCustomizationDescription)

Localized text describing the imageCustomizationAction. This property was added in vSphere API 8.0.3.0. if null the component is not customized.

Parameters:

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

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