AffectedDesiredStateInfo

java.lang.Object
- com.vmware.esx.settings.depots.AffectedDesiredStateInfo

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
```
public final class AffectedDesiredStateInfo
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
```
The AffectedDesiredStateInfo class contains the fields that describe which release units in the desired state will be affected by the depot to be deleted or disabled. This class was added in vSphere API 7.0.3.0.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class AffectedDesiredStateInfo.Builder
Builder class for AffectedDesiredStateInfo.

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

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
	`AffectedDesiredStateInfo()` Default constructor.
`protected`	`AffectedDesiredStateInfo(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 AffectedDesiredStateInfo`	`_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 AffectedDesiredStateInfo`	`_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.util.Map<java.lang.String,AddonSummary>`	`getAffectedAddon()` Affected addon of the desired state.
`BaseImageVersion`	`getAffectedBaseImage()` Affected base image of the desired state.
`java.util.Map<java.lang.String,HardwareSupportManagerSummary>`	`getAffectedHardwareSupport()` Affected hardware support of the desired state.
`java.util.Map<java.lang.String,ComponentSummary>`	`getAffectedIndependentComponents()` Affected independent components of the desired state.
`java.util.Map<java.lang.String,SolutionSummary>`	`getAffectedSolutions()` Affected solutions of the desired state.
`java.lang.String`	`getClusterId()` Identified of the cluster the affected desired state belongs to.
`java.lang.String`	`getClusterName()` Since now we have standalone host, we use entityName/entityId to better describe name/id of either cluster or standalone host.
`int`	`hashCode()`
`void`	`setAffectedAddon(java.util.Map<java.lang.String,AddonSummary> affectedAddon)` Affected addon of the desired state.
`void`	`setAffectedBaseImage(BaseImageVersion affectedBaseImage)` Affected base image of the desired state.
`void`	`setAffectedHardwareSupport(java.util.Map<java.lang.String,HardwareSupportManagerSummary> affectedHardwareSupport)` Affected hardware support of the desired state.
`void`	`setAffectedIndependentComponents(java.util.Map<java.lang.String,ComponentSummary> affectedIndependentComponents)` Affected independent components of the desired state.
`void`	`setAffectedSolutions(java.util.Map<java.lang.String,SolutionSummary> affectedSolutions)` Affected solutions of the desired state.
`void`	`setClusterId(java.lang.String clusterId)` Identified of the cluster the affected desired state belongs to.
`void`	`setClusterName(java.lang.String clusterName)` Since now we have standalone host, we use entityName/entityId to better describe name/id of either cluster or standalone 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
  - AffectedDesiredStateInfo
```
public AffectedDesiredStateInfo()
```
    Default constructor.
  - AffectedDesiredStateInfo
```
protected AffectedDesiredStateInfo(com.vmware.vapi.data.StructValue __dynamicStructureFields)
```
- Method Detail
  - getClusterName
```
public java.lang.String getClusterName()
```
    Since now we have standalone host, we use entityName/entityId to better describe name/id of either cluster or standalone host. Name of the cluster the affected desired state belongs to. This property was added in vSphere API 7.0.3.0.
    
    Returns:
    
    The current value of the property.
  - setClusterName
```
public void setClusterName(java.lang.String clusterName)
```
    Since now we have standalone host, we use entityName/entityId to better describe name/id of either cluster or standalone host. Name of the cluster the affected desired state belongs to. This property was added in vSphere API 7.0.3.0.
    
    Parameters:
    
    clusterName - New value for the property.
  - getClusterId
```
public java.lang.String getClusterId()
```
    Identified of the cluster the affected desired state belongs to. This property was added in vSphere API 7.0.3.0.
    
    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: ClusterComputeResource. When methods return a value of this class as a return value, the property will be an identifier for the resource type: ClusterComputeResource.
  - setClusterId
```
public void setClusterId(java.lang.String clusterId)
```
    Identified of the cluster the affected desired state belongs to. This property was added in vSphere API 7.0.3.0.
    
    Parameters:
    
    clusterId - 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: ClusterComputeResource. When methods return a value of this class as a return value, the property will be an identifier for the resource type: ClusterComputeResource.
  - getAffectedBaseImage
```
public BaseImageVersion getAffectedBaseImage()
```
    Affected base image of the desired state. This property was added in vSphere API 7.0.3.0. If null, no base image of the desired state will be affected.
    
    Returns:
    
    The current value of the property.
  - setAffectedBaseImage
```
public void setAffectedBaseImage(BaseImageVersion affectedBaseImage)
```
    Affected base image of the desired state. This property was added in vSphere API 7.0.3.0. If null, no base image of the desired state will be affected.
    
    Parameters:
    
    affectedBaseImage - New value for the property.
  - getAffectedAddon
```
public java.util.Map<java.lang.String,AddonSummary> getAffectedAddon()
```
    Affected addon of the desired state. The key is name of addon. Note: there is at most one addon affected. This property was added in vSphere API 7.0.3.0. If null, no addon of the desired state will be affected.
    
    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.add_on. 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.add_on.
  - setAffectedAddon
```
public void setAffectedAddon(java.util.Map<java.lang.String,AddonSummary> affectedAddon)
```
    Affected addon of the desired state. The key is name of addon. Note: there is at most one addon affected. This property was added in vSphere API 7.0.3.0. If null, no addon of the desired state will be affected.
    
    Parameters:
    
    affectedAddon - 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.add_on. 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.add_on.
  - getAffectedSolutions
```
public java.util.Map<java.lang.String,SolutionSummary> getAffectedSolutions()
```
    Affected solutions of the desired state. The key is name of solution. This property was added in vSphere API 7.0.3.0. If null, no solution of the desired state will be affected.
    
    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.
  - setAffectedSolutions
```
public void setAffectedSolutions(java.util.Map<java.lang.String,SolutionSummary> affectedSolutions)
```
    Affected solutions of the desired state. The key is name of solution. This property was added in vSphere API 7.0.3.0. If null, no solution of the desired state will be affected.
    
    Parameters:
    
    affectedSolutions - 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.
  - getAffectedHardwareSupport
```
public java.util.Map<java.lang.String,HardwareSupportManagerSummary> getAffectedHardwareSupport()
```
    Affected hardware support of the desired state. The key is HSM name. This property was added in vSphere API 7.0.3.0. If null, no hadrware support of the desired state will be affected.
    
    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.
  - setAffectedHardwareSupport
```
public void setAffectedHardwareSupport(java.util.Map<java.lang.String,HardwareSupportManagerSummary> affectedHardwareSupport)
```
    Affected hardware support of the desired state. The key is HSM name. This property was added in vSphere API 7.0.3.0. If null, no hadrware support of the desired state will be affected.
    
    Parameters:
    
    affectedHardwareSupport - 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.
  - getAffectedIndependentComponents
```
public java.util.Map<java.lang.String,ComponentSummary> getAffectedIndependentComponents()
```
    Affected independent components of the desired state. The components belongs to other base images, addons, solutions and hardware support packages are not counted. The key is name of component. This property was added in vSphere API 7.0.3.0. If null, no independent components of the desired state will be affected.
    
    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.
  - setAffectedIndependentComponents
```
public void setAffectedIndependentComponents(java.util.Map<java.lang.String,ComponentSummary> affectedIndependentComponents)
```
    Affected independent components of the desired state. The components belongs to other base images, addons, solutions and hardware support packages are not counted. The key is name of component. This property was added in vSphere API 7.0.3.0. If null, no independent components of the desired state will be affected.
    
    Parameters:
    
    affectedIndependentComponents - 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.
  - _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 AffectedDesiredStateInfo _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 AffectedDesiredStateInfo _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class AffectedDesiredStateInfo

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

__dynamicStructureFields

Constructor Detail

AffectedDesiredStateInfo

AffectedDesiredStateInfo

Method Detail

getClusterName

setClusterName

getClusterId

setClusterId

getAffectedBaseImage

setAffectedBaseImage

getAffectedAddon

setAffectedAddon

getAffectedSolutions

setAffectedSolutions

getAffectedHardwareSupport

setAffectedHardwareSupport

getAffectedIndependentComponents

setAffectedIndependentComponents

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2