OvfMessage

java.lang.Object
- com.vmware.vcenter.ovf.OvfMessage

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
```
public final class OvfMessage
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.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 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

OvfMessage()
Default constructor.

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

Constructors
Modifier	Constructor and Description
	`OvfMessage()` Default constructor.
`protected`	`OvfMessage(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 OvfMessage`	`_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 OvfMessage`	`_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)`
`OvfMessage.Category`	`getCategory()` The message category.
`com.vmware.vapi.bindings.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(com.vmware.vapi.bindings.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()`

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
  - OvfMessage
```
public OvfMessage()
```
    Default constructor.
  - OvfMessage
```
protected OvfMessage(com.vmware.vapi.data.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 com.vmware.vapi.bindings.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(com.vmware.vapi.bindings.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()
```
    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 OvfMessage _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 OvfMessage _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class OvfMessage

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

__dynamicStructureFields

Constructor Detail

OvfMessage

OvfMessage

Method Detail

getCategory

setCategory

getIssues

setIssues

getName

setName

getValue

setValue

getMessage

setMessage

getError

setError

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2