com.vmware.vcenter.lcm.update

Class PendingTypes.Summary

java.lang.Object

com.vmware.vcenter.lcm.update.PendingTypes.Summary

All Implemented Interfaces:

StaticStructure, Structure, java.io.Serializable

Enclosing interface:

PendingTypes

public static final class PendingTypes.Summary
extends java.lang.Object
implements java.io.Serializable, StaticStructure

The Summary class contains basic information about the vCenter patch/update/upgrade

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PendingTypes.Summary.Builder Builder class for PendingTypes.Summary.

Field Summary

Fields

Modifier and Type	Field and Description
protected StructValue	__dynamicStructureFields

Constructor Summary

Constructors

Modifier	Constructor and Description
	Summary() Default constructor.
protected	Summary(StructValue __dynamicStructureFields)

Method Summary

Modifier and Type	Method and Description
<T extends Structure> T	_convertTo(java.lang.Class<T> clazz) Converts this structure into an instance of the provided class structure if possible.
java.lang.String	_getCanonicalName() Returns the canonical name of the structure.
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.
StructValue	_getDataValue() Returns this Structure represented in the dynamic DataValue model.
DataValue	_getDynamicField(java.lang.String fieldName) Get dynamic filed value.
java.util.Set<java.lang.String>	_getDynamicFieldNames() Get the names of the dynamic fields in the structure.
com.vmware.vapi.bindings.type.StructType	_getType() WARNING: Internal method, subject to change in future versions.
boolean	_hasTypeNameOf(java.lang.Class<? extends Structure> clazz) Checks if the runtime type name of this structure matches the type represented by the specified binding class.
static PendingTypes.Summary	_newInstance(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 PendingTypes.Summary	_newInstance2(StructValue structValue) WARNING: Internal method, subject to change in future versions. Serves as a versioning mechanism.
void	_setDynamicField(java.lang.String fieldName, DataValue fieldValue) Sets a dynamic field value.
protected void	_updateDataValue(StructValue structValue)
void	_validate() Validates the state of the discriminated unions and HasFieldsOf restrictions (if any) in this Java language binding Structure.
boolean	equals(java.lang.Object obj)
java.lang.String	getBuild() Build number of the vCenter Release
PendingTypes.Category	getCategory() Category of the release based on features bundled on top of previous release
java.net.URI	getExecuteURL() VAMI or ISO URL for update or upgrade execute phase redirection
java.lang.String	getPendingUpdate() Identifier of the given vSphere update
boolean	getRebootRequired() Flag to suggest a reboot after the release is applied
java.util.Calendar	getReleaseDate() Release date of the vSphere update or patch
java.util.List<java.net.URI>	getReleaseNotes() List of URI pointing to patch or update release notes
PendingTypes.SeverityType	getSeverity() Severity of the issues fixed in the vSphere update or patch
PendingTypes.UpdateType	getUpdateType() Type of the Release based on the current vCenter version
java.lang.String	getVersion() Version of the vSphere update or patch
int	hashCode()
void	setBuild(java.lang.String build) Build number of the vCenter Release
void	setCategory(PendingTypes.Category category) Category of the release based on features bundled on top of previous release
void	setExecuteURL(java.net.URI executeURL) VAMI or ISO URL for update or upgrade execute phase redirection
void	setPendingUpdate(java.lang.String pendingUpdate) Identifier of the given vSphere update
void	setRebootRequired(boolean rebootRequired) Flag to suggest a reboot after the release is applied
void	setReleaseDate(java.util.Calendar releaseDate) Release date of the vSphere update or patch
void	setReleaseNotes(java.util.List<java.net.URI> releaseNotes) List of URI pointing to patch or update release notes
void	setSeverity(PendingTypes.SeverityType severity) Severity of the issues fixed in the vSphere update or patch
void	setUpdateType(PendingTypes.UpdateType updateType) Type of the Release based on the current vCenter version
void	setVersion(java.lang.String version) Version of the vSphere update or patch
java.lang.String	toString() Returns a string representation of this structure.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

__dynamicStructureFields

protected StructValue __dynamicStructureFields

Constructor Detail

Summary

public Summary()

Default constructor.

Summary

protected Summary(StructValue __dynamicStructureFields)

Method Detail

getPendingUpdate

public java.lang.String getPendingUpdate()

Identifier of the given vSphere update

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.vcenter.lcm.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.vcenter.lcm.update.pending.

setPendingUpdate

public void setPendingUpdate(java.lang.String pendingUpdate)

Identifier of the given vSphere update

Parameters:

pendingUpdate - 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.vcenter.lcm.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.vcenter.lcm.update.pending.

getVersion

public java.lang.String getVersion()

Version of the vSphere update or patch

Returns:

The current value of the property.

setVersion

public void setVersion(java.lang.String version)

Version of the vSphere update or patch

Parameters:

version - New value for the property.

getReleaseDate

public java.util.Calendar getReleaseDate()

Release date of the vSphere update or patch

Returns:

The current value of the property.

setReleaseDate

public void setReleaseDate(java.util.Calendar releaseDate)

Release date of the vSphere update or patch

Parameters:

releaseDate - New value for the property.

getSeverity

public PendingTypes.SeverityType getSeverity()

Severity of the issues fixed in the vSphere update or patch

Returns:

The current value of the property.

setSeverity

public void setSeverity(PendingTypes.SeverityType severity)

Severity of the issues fixed in the vSphere update or patch

Parameters:

severity - New value for the property.

getBuild

public java.lang.String getBuild()

Build number of the vCenter Release

Returns:

The current value of the property.

setBuild

public void setBuild(java.lang.String build)

Build number of the vCenter Release

Parameters:

build - New value for the property.

getUpdateType

public PendingTypes.UpdateType getUpdateType()

Type of the Release based on the current vCenter version

Returns:

The current value of the property.

setUpdateType

public void setUpdateType(PendingTypes.UpdateType updateType)

Type of the Release based on the current vCenter version

Parameters:

updateType - New value for the property.

getCategory

public PendingTypes.Category getCategory()

Category of the release based on features bundled on top of previous release

Returns:

The current value of the property.

setCategory

public void setCategory(PendingTypes.Category category)

Category of the release based on features bundled on top of previous release

Parameters:

category - New value for the property.

getRebootRequired

public boolean getRebootRequired()

Flag to suggest a reboot after the release is applied

Returns:

The current value of the property.

setRebootRequired

public void setRebootRequired(boolean rebootRequired)

Flag to suggest a reboot after the release is applied

Parameters:

rebootRequired - New value for the property.

getExecuteURL

public java.net.URI getExecuteURL()

VAMI or ISO URL for update or upgrade execute phase redirection

Returns:

The current value of the property.

setExecuteURL

public void setExecuteURL(java.net.URI executeURL)

VAMI or ISO URL for update or upgrade execute phase redirection

Parameters:

executeURL - New value for the property.

getReleaseNotes

public java.util.List<java.net.URI> getReleaseNotes()

List of URI pointing to patch or update release notes

Returns:

The current value of the property.

setReleaseNotes

public void setReleaseNotes(java.util.List<java.net.URI> releaseNotes)

List of URI pointing to patch or update release notes

Parameters:

releaseNotes - New value for the property.

_getType

public com.vmware.vapi.bindings.type.StructType _getType()

Description copied from interface: StaticStructure

WARNING: Internal method, subject to change in future versions. Returns StructType instance representing the static bindings type for this Structure.

Specified by:

_getType in interface StaticStructure

Returns:

the static bindings StructType

_getDataValue

public StructValue _getDataValue()

Description copied from interface: Structure

Returns this Structure represented in the dynamic DataValue model.

Attempts to change the returned StructValue representation are not required to change the state of this structure. Actually the behavior is implementation dependent and is unspecified. In general the returned value shouldn't be changed.

Specified by:

_getDataValue in interface Structure

Returns:

StructValue representing this structure

_updateDataValue

protected void _updateDataValue(StructValue structValue)

_validate

public void _validate()

Description copied from interface: StaticStructure

Validates the state of the discriminated unions and HasFieldsOf restrictions (if any) in this Java language binding Structure.

More precisely, for each union: given value of the discriminant/tag field (@UnionTag in the IDL) of an union in this structure, validates that:

all fields of the union required for that value of the discriminant are set fields of the union that are not allowed for that value of the discriminant are not set any other fields of the structure (not participating in the union) do not affect the validation result

Specified by:

_validate in interface 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()

Description copied from interface: StaticStructure

Returns a string representation of this structure. The result is pretty printed in order to be easy to read. It is intended to be used for different debugging/tracing purposes, e.g. dumping structures into logging traces.

In general no code should depend on the format of the resulting string. E.g. there must be no attempts to parse for re-creation of the original instance.

Specified by:

toString in interface StaticStructure

Overrides:

toString in class java.lang.Object

Returns:

a string representation of this static structure instance

_hasTypeNameOf

public boolean _hasTypeNameOf(java.lang.Class<? extends Structure> clazz)

Description copied from interface: Structure

Checks if the runtime type name of this structure matches the type represented by the specified binding class.

This can be used as efficient check to determine if this instance can be successfully converted to the target type.

Specified by:

_hasTypeNameOf in interface Structure

Parameters:

clazz - bindings class for the target structure; must not be null

Returns:

true if this structures type name matches exactly the specified class' type name.

_convertTo

public <T extends Structure> T _convertTo(java.lang.Class<T> clazz)

Description copied from interface: Structure

Converts this structure into an instance of the provided class structure if possible. A conversion will be possible if the requested structure's fields are all present in this structure.

Specified by:

_convertTo in interface Structure

Parameters:

clazz - type of the result structure. cannot be null.

Returns:

an instance of the requested type if conversion is possible. CoreException is thrown otherwise.

_setDynamicField

public void _setDynamicField(java.lang.String fieldName,
                             DataValue fieldValue)

Description copied from interface: StaticStructure

Sets a dynamic field value. The dynamic filed is extra filed that is not part of the static fields of the structure.

Specified by:

_setDynamicField in interface StaticStructure

Parameters:

fieldName - canonical name of the dynamic field to set

fieldValue - the value of the field

_getDynamicField

public DataValue _getDynamicField(java.lang.String fieldName)

Description copied from interface: StaticStructure

Get dynamic filed value. Works only on dynamic fields.

Specified by:

_getDynamicField in interface StaticStructure

Parameters:

fieldName - the canonical name of the dynamic field

Returns:

the DataValue of the dynamic field

_getDynamicFieldNames

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

Description copied from interface: StaticStructure

Get the names of the dynamic fields in the structure.

Specified by:

_getDynamicFieldNames in interface StaticStructure

Returns:

set of the canonical field names for the dynamic fields

_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()

Description copied from interface: Structure

Returns the canonical name of the structure. By default the canonical name is derived from the fully-qualified IDL name by converting to lower case and inserting underscores between words. For example org.example.FooBar would turn into org.example.foo_bar.

Specified by:

_getCanonicalName in interface Structure

Returns:

canonical name

_getCanonicalTypeName

public static java.lang.String _getCanonicalTypeName()

Returns the canonical type name. See _getCanonicalName().

Returns:

canonical type name

_newInstance

public static PendingTypes.Summary _newInstance(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 PendingTypes.Summary _newInstance2(StructValue structValue)

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