com.vmware.appliance.vmon

Class ServiceTypes.Info

java.lang.Object

com.vmware.appliance.vmon.ServiceTypes.Info

All Implemented Interfaces:

StaticStructure, Structure, Serializable

Enclosing interface:

ServiceTypes

public static final class ServiceTypes.Info
extends Object
implements Serializable, StaticStructure

The Info class contains information about a service.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ServiceTypes.Info.Builder Builder class for ServiceTypes.Info.

Constructor Summary

Constructors

Constructor and Description
ServiceTypes.Info() Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
<T extends Structure> T	_convertTo(Class<T> clazz) Converts this structure into an instance of the provided class structure if possible.
String	_getCanonicalName() Returns the canonical name of the structure.
static String	_getCanonicalTypeName() Returns the canonical type name.
static com.vmware.vapi.bindings.type.StructType	_getClassType() WARNING: Internal API, subject to change in future versions.
StructValue	_getDataValue() Returns this Structure represented in the dynamic DataValue model.
DataValue	_getDynamicField(String fieldName) Get dynamic filed value.
Set<String>	_getDynamicFieldNames() Get the names of the dynamic fields in the structure.
com.vmware.vapi.bindings.type.StructType	_getType() WARNING: Internal API, subject to change in future versions.
boolean	_hasTypeNameOf(Class<? extends Structure> clazz) Checks that the runtime type name matches the type name from the binding class.
static ServiceTypes.Info	_newInstance(StructValue structValue) WARNING: Internal API, 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.
void	_setDynamicField(String fieldName, DataValue fieldValue) Sets a dynamic field value.
void	_validate() Validates the state of the discriminated unions and HasFieldsOf restrictions (if any) in this Java language binding Structure.
boolean	equals(Object obj)
String	getDescriptionKey() Service description key.
ServiceTypes.Health	getHealth() Health of service.
List<LocalizableMessage>	getHealthMessages() Localizable messages associated with the health of the service This property is optional and it is only relevant when the value of getState() is ServiceTypes.State.STARTED.
String	getNameKey() Service name key.
ServiceTypes.StartupType	getStartupType() Startup Type.
ServiceTypes.State	getState() Running State.
int	hashCode()
void	setDescriptionKey(String descriptionKey) Service description key.
void	setHealth(ServiceTypes.Health health) Health of service.
void	setHealthMessages(List<LocalizableMessage> healthMessages) Localizable messages associated with the health of the service This property is optional and it is only relevant when the value of getState() is ServiceTypes.State.STARTED.
void	setNameKey(String nameKey) Service name key.
void	setStartupType(ServiceTypes.StartupType startupType) Startup Type.
void	setState(ServiceTypes.State state) Running State.
String	toString() Returns a string representation of this structure.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ServiceTypes.Info

public ServiceTypes.Info()

Default constructor.

Method Detail

getNameKey

public String getNameKey()

Service name key. Can be used to lookup resource bundle

Returns:

The current value of the property.

setNameKey

public void setNameKey(String nameKey)

Service name key. Can be used to lookup resource bundle

Parameters:

nameKey - New value for the property.

getDescriptionKey

public String getDescriptionKey()

Service description key. Can be used to lookup resource bundle

Returns:

The current value of the property.

setDescriptionKey

public void setDescriptionKey(String descriptionKey)

Service description key. Can be used to lookup resource bundle

Parameters:

descriptionKey - New value for the property.

getStartupType

public ServiceTypes.StartupType getStartupType()

Startup Type.

Returns:

The current value of the property.

setStartupType

public void setStartupType(ServiceTypes.StartupType startupType)

Startup Type.

Parameters:

startupType - New value for the property.

getState

public ServiceTypes.State getState()

Running State.

Returns:

The current value of the property.

setState

public void setState(ServiceTypes.State state)

Running State.

Parameters:

state - New value for the property.

getHealth

public ServiceTypes.Health getHealth()

Health of service. This property is optional and it is only relevant when the value of getState() is ServiceTypes.State.STARTED.

Returns:

The current value of the property.

setHealth

public void setHealth(ServiceTypes.Health health)

Health of service. This property is optional and it is only relevant when the value of getState() is ServiceTypes.State.STARTED.

Parameters:

health - New value for the property.

getHealthMessages

public List<LocalizableMessage> getHealthMessages()

Localizable messages associated with the health of the service This property is optional and it is only relevant when the value of getState() is ServiceTypes.State.STARTED.

Returns:

The current value of the property.

setHealthMessages

public void setHealthMessages(List<LocalizableMessage> healthMessages)

Localizable messages associated with the health of the service This property is optional and it is only relevant when the value of getState() is ServiceTypes.State.STARTED.

Parameters:

healthMessages - New value for the property.

_getType

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

Description copied from interface: StaticStructure

WARNING: Internal API, 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

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

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public 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 Object

Returns:

a string representation of this static structure instance

_hasTypeNameOf

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

Description copied from interface: Structure

Checks that the runtime type name matches the type name from the binding class.

Specified by:

_hasTypeNameOf in interface Structure

Parameters:

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

Returns:

true if this structures type name matches exactly the provided class type name.

_convertTo

public <T extends Structure> T _convertTo(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(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(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 Set<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 API, subject to change in future versions.

Returns:

StructType instance representing the static bindings type for this Structure.

_getCanonicalName

public 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 String _getCanonicalTypeName()

Returns the canonical type name. See _getCanonicalName().

Returns:

canonical type name

_newInstance

public static ServiceTypes.Info _newInstance(StructValue structValue)

WARNING: Internal API, 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