com.vmware.esx.settings

Class Notification

java.lang.Object

com.vmware.esx.settings.Notification

All Implemented Interfaces:

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

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

The Notification class contains properties to describe any info/warning/error messages that Tasks can raise.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Notification.Builder Builder class for Notification.
static class	Notification.Type The (@name Type} enumeration class contains the possible different types of notification.

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	Notification() Default constructor.
protected	Notification(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 Notification	_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 Notification	_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	getId() The notification id.
LocalizableMessage	getMessage() The notification message.
java.lang.String	getOriginator() The originator of the notification.
LocalizableMessage	getResolution() The resolution message, if any.
java.lang.Boolean	getRetriable() Indicates whether the error is retriable.
java.util.Calendar	getTime() The time the notification was raised/found.
Notification.Type	getType() Type of the notification.
int	hashCode()
void	setId(java.lang.String id) The notification id.
void	setMessage(LocalizableMessage message) The notification message.
void	setOriginator(java.lang.String originator) The originator of the notification.
void	setResolution(LocalizableMessage resolution) The resolution message, if any.
void	setRetriable(java.lang.Boolean retriable) Indicates whether the error is retriable.
void	setTime(java.util.Calendar time) The time the notification was raised/found.
void	setType(Notification.Type type) Type of the notification.
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

Notification

public Notification()

Default constructor.

Notification

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

Method Detail

getType

public Notification.Type getType()

Type of the notification. This property was added in vSphere API 7.0.2.0. This property is optional because it was added in a newer version than its parent node.

Returns:

The current value of the property.

setType

public void setType(Notification.Type type)

Type of the notification. This property was added in vSphere API 7.0.2.0. This property is optional because it was added in a newer version than its parent node.

Parameters:

type - New value for the property.

getId

public java.lang.String getId()

The notification id.

Returns:

The current value of the property.

setId

public void setId(java.lang.String id)

The notification id.

Parameters:

id - New value for the property.

getTime

public java.util.Calendar getTime()

The time the notification was raised/found.

Returns:

The current value of the property.

setTime

public void setTime(java.util.Calendar time)

The time the notification was raised/found.

Parameters:

time - New value for the property.

getMessage

public LocalizableMessage getMessage()

The notification message.

Returns:

The current value of the property.

setMessage

public void setMessage(LocalizableMessage message)

The notification message.

Parameters:

message - New value for the property.

getResolution

public LocalizableMessage getResolution()

The resolution message, if any. Only Set if there is a resolution available for this notification.

Returns:

The current value of the property.

setResolution

public void setResolution(LocalizableMessage resolution)

The resolution message, if any. Only Set if there is a resolution available for this notification.

Parameters:

resolution - New value for the property.

getOriginator

public java.lang.String getOriginator()

The originator of the notification. This property was added in vSphere API 7.0.2.0. Only Set if there is an originator available for this notification.

Returns:

The current value of the property.

setOriginator

public void setOriginator(java.lang.String originator)

The originator of the notification. This property was added in vSphere API 7.0.2.0. Only Set if there is an originator available for this notification.

Parameters:

originator - New value for the property.

getRetriable

public java.lang.Boolean getRetriable()

Indicates whether the error is retriable. This property was added in vSphere API 7.0.2.0. Only Set for the notification when a retriable error was reported by the task.

Returns:

The current value of the property.

setRetriable

public void setRetriable(java.lang.Boolean retriable)

Indicates whether the error is retriable. This property was added in vSphere API 7.0.2.0. Only Set for the notification when a retriable error was reported by the task.

Parameters:

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

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