com.vmware.vcenter.ovf

Class OvfMessage

java.lang.Object

com.vmware.vcenter.ovf.OvfMessage

All Implemented Interfaces:

StaticStructure, Structure, java.io.Serializable

public final class OvfMessage
extends java.lang.Object
implements java.io.Serializable, StaticStructure

The OvfMessage class describes a base OVF handling error message related to accessing, validating, deploying, or exporting an OVF package.

These messages fall into different categories defined in OvfMessage.Category:

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OvfMessage.Builder Builder class for OvfMessage.
static class	OvfMessage.Category The Category enumeration class defines the categories of messages (see OvfMessage).

Field Summary

Fields

Modifier and Type	Field and Description
protected StructValue	__dynamicStructureFields

Constructor Summary

Constructors

Modifier	Constructor and Description
	OvfMessage() Default constructor.
protected	OvfMessage(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 OvfMessage	_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 OvfMessage	_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)
OvfMessage.Category	getCategory() The message category.
Structure	getError() Represents a server Error.
java.util.List<ParseIssue>	getIssues() List of parse issues (see ParseIssue).
LocalizableMessage	getMessage() A localizable message.
java.lang.String	getName() The name of input parameter.
java.lang.String	getValue() The value of input parameter.
int	hashCode()
void	setCategory(OvfMessage.Category category) The message category.
void	setError(Structure error) Represents a server Error.
void	setIssues(java.util.List<ParseIssue> issues) List of parse issues (see ParseIssue).
void	setMessage(LocalizableMessage message) A localizable message.
void	setName(java.lang.String name) The name of input parameter.
void	setValue(java.lang.String value) The value of input parameter.
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

OvfMessage

public OvfMessage()

Default constructor.

OvfMessage

protected OvfMessage(StructValue __dynamicStructureFields)

Method Detail

getCategory

public OvfMessage.Category getCategory()

The message category.

Returns:

The current value of the property.

setCategory

public void setCategory(OvfMessage.Category category)

The message category.

Parameters:

category - New value for the property.

getIssues

public java.util.List<ParseIssue> getIssues()

List of parse issues (see ParseIssue). This property is optional and it is only relevant when the value of getCategory() is OvfMessage.Category.VALIDATION.

Returns:

The current value of the property.

setIssues

public void setIssues(java.util.List<ParseIssue> issues)

List of parse issues (see ParseIssue). This property is optional and it is only relevant when the value of getCategory() is OvfMessage.Category.VALIDATION.

Parameters:

issues - New value for the property.

getName

public java.lang.String getName()

The name of input parameter. This property is optional and it is only relevant when the value of getCategory() is OvfMessage.Category.INPUT.

Returns:

The current value of the property.

setName

public void setName(java.lang.String name)

The name of input parameter. This property is optional and it is only relevant when the value of getCategory() is OvfMessage.Category.INPUT.

Parameters:

name - New value for the property.

getValue

public java.lang.String getValue()

The value of input parameter. This property is optional and it is only relevant when the value of getCategory() is OvfMessage.Category.INPUT.

Returns:

The current value of the property.

setValue

public void setValue(java.lang.String value)

The value of input parameter. This property is optional and it is only relevant when the value of getCategory() is OvfMessage.Category.INPUT.

Parameters:

value - New value for the property.

getMessage

public LocalizableMessage getMessage()

A localizable message. This property is optional and it is only relevant when the value of getCategory() is OvfMessage.Category.INPUT.

Returns:

The current value of the property.

setMessage

public void setMessage(LocalizableMessage message)

A localizable message. This property is optional and it is only relevant when the value of getCategory() is OvfMessage.Category.INPUT.

Parameters:

message - New value for the property.

getError

public Structure getError()

Represents a server Error. This property is optional and it is only relevant when the value of getCategory() is OvfMessage.Category.SERVER.

Returns:

The current value of the property. When clients pass a value of this class as a parameter, the property must contain all the properties defined in Error. When methods return a value of this class as a return value, the property will contain all the properties defined in Error.

setError

public void setError(Structure error)

Represents a server Error. This property is optional and it is only relevant when the value of getCategory() is OvfMessage.Category.SERVER.

Parameters:

error - New value for the property. When clients pass a value of this class as a parameter, the property must contain all the properties defined in Error. When methods return a value of this class as a return value, the property will contain all the properties defined in Error.

_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 OvfMessage _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 OvfMessage _newInstance2(StructValue structValue)

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