Summary

java.lang.Object
- com.vmware.appliance.update.Summary

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
```
public final class Summary
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
```
The Summary class contains the essential information about the update. This class was added in vSphere API 6.7.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Summary.Builder
Builder class for Summary.

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

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

Summary()
Default constructor.

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

Constructors
Modifier	Constructor and Description
	`Summary()` Default constructor.
`protected`	`Summary(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 Summary`	`_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 Summary`	`_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)`
`LocalizableMessage`	`getDescription()` Description of the update.
`java.lang.String`	`getName()` Name of the update.
`CommonInfo.Priority`	`getPriority()` Update priority.
`boolean`	`getRebootRequired()` Flag indicating whether reboot is required after update.
`java.util.Calendar`	`getReleaseDate()` Update release date.
`CommonInfo.Severity`	`getSeverity()` Update severity.
`long`	`getSize()` Download Size of update in Megabytes.
`CommonInfo.Category`	`getUpdateType()` Update category.
`java.lang.String`	`getVersion()` Version in form of X.Y.Z.P.
`int`	`hashCode()`
`void`	`setDescription(LocalizableMessage description)` Description of the update.
`void`	`setName(java.lang.String name)` Name of the update.
`void`	`setPriority(CommonInfo.Priority priority)` Update priority.
`void`	`setRebootRequired(boolean rebootRequired)` Flag indicating whether reboot is required after update.
`void`	`setReleaseDate(java.util.Calendar releaseDate)` Update release date.
`void`	`setSeverity(CommonInfo.Severity severity)` Update severity.
`void`	`setSize(long size)` Download Size of update in Megabytes.
`void`	`setUpdateType(CommonInfo.Category updateType)` Update category.
`void`	`setVersion(java.lang.String version)` Version in form of X.Y.Z.P.
`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
  - Summary
```
public Summary()
```
    Default constructor.
  - Summary
```
protected Summary(com.vmware.vapi.data.StructValue __dynamicStructureFields)
```
- Method Detail
  - getVersion
```
public java.lang.String getVersion()
```
    Version in form of X.Y.Z.P. e.g. 6.5.1.5400. This property was added in vSphere API 6.7.
    
    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.appliance.update.pending. When methods return a value of this class as a return value, the property will be an identifier for the resource type: com.vmware.appliance.update.pending.
  - setVersion
```
public void setVersion(java.lang.String version)
```
    Version in form of X.Y.Z.P. e.g. 6.5.1.5400. This property was added in vSphere API 6.7.
    
    Parameters:
    
    version - 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.appliance.update.pending. When methods return a value of this class as a return value, the property will be an identifier for the resource type: com.vmware.appliance.update.pending.
  - getName
```
public java.lang.String getName()
```
    Name of the update. This property was added in vSphere API 6.7.
    
    Returns:
    
    The current value of the property.
  - setName
```
public void setName(java.lang.String name)
```
    Name of the update. This property was added in vSphere API 6.7.
    
    Parameters:
    
    name - New value for the property.
  - getDescription
```
public LocalizableMessage getDescription()
```
    Description of the update. The short information what this update is. E.g. "Update2 for vCenter Server Appliance 6.5". This property was added in vSphere API 6.7.
    
    Returns:
    
    The current value of the property.
  - setDescription
```
public void setDescription(LocalizableMessage description)
```
    Description of the update. The short information what this update is. E.g. "Update2 for vCenter Server Appliance 6.5". This property was added in vSphere API 6.7.
    
    Parameters:
    
    description - New value for the property.
  - getPriority
```
public CommonInfo.Priority getPriority()
```
    Update priority. This property was added in vSphere API 6.7.
    
    Returns:
    
    The current value of the property.
  - setPriority
```
public void setPriority(CommonInfo.Priority priority)
```
    Update priority. This property was added in vSphere API 6.7.
    
    Parameters:
    
    priority - New value for the property.
  - getSeverity
```
public CommonInfo.Severity getSeverity()
```
    Update severity. This property was added in vSphere API 6.7.
    
    Returns:
    
    The current value of the property.
  - setSeverity
```
public void setSeverity(CommonInfo.Severity severity)
```
    Update severity. This property was added in vSphere API 6.7.
    
    Parameters:
    
    severity - New value for the property.
  - getUpdateType
```
public CommonInfo.Category getUpdateType()
```
    Update category. This property was added in vSphere API 6.7.
    
    Returns:
    
    The current value of the property.
  - setUpdateType
```
public void setUpdateType(CommonInfo.Category updateType)
```
    Update category. This property was added in vSphere API 6.7.
    
    Parameters:
    
    updateType - New value for the property.
  - getReleaseDate
```
public java.util.Calendar getReleaseDate()
```
    Update release date. This property was added in vSphere API 6.7.
    
    Returns:
    
    The current value of the property.
  - setReleaseDate
```
public void setReleaseDate(java.util.Calendar releaseDate)
```
    Update release date. This property was added in vSphere API 6.7.
    
    Parameters:
    
    releaseDate - New value for the property.
  - getRebootRequired
```
public boolean getRebootRequired()
```
    Flag indicating whether reboot is required after update. This property was added in vSphere API 6.7.
    
    Returns:
    
    The current value of the property.
  - setRebootRequired
```
public void setRebootRequired(boolean rebootRequired)
```
    Flag indicating whether reboot is required after update. This property was added in vSphere API 6.7.
    
    Parameters:
    
    rebootRequired - New value for the property.
  - getSize
```
public long getSize()
```
    Download Size of update in Megabytes. This property was added in vSphere API 6.7.
    
    Returns:
    
    The current value of the property.
  - setSize
```
public void setSize(long size)
```
    Download Size of update in Megabytes. This property was added in vSphere API 6.7.
    
    Parameters:
    
    size - 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 Summary _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 Summary _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class Summary

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

__dynamicStructureFields

Constructor Detail

Summary

Summary

Method Detail

getVersion

setVersion

getName

setName

getDescription

setDescription

getPriority

setPriority

getSeverity

setSeverity

getUpdateType

setUpdateType

getReleaseDate

setReleaseDate

getRebootRequired

setRebootRequired

getSize

setSize

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2