ovf_message
structure 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 com.vmware.vcenter.ovf.ovf_message.category:
{
"category": "VALIDATION", "error": { "@class": "com.vmware.vapi.std.errors.error", "data": { "@class": "dynamic_structure" }, "messages": [ { "args": [ "string", "string" ], "default_message": "string", "id": "string" }, { "args": [ "string", "string" ], "default_message": "string", "id": "string" } ] }, "issues": [ { "category": "VALUE_ILLEGAL", "column_number": 10, "file": "string", "line_number": 10, "message": { "args": [ "string", "string" ], "default_message": "string", "id": "string" } }, { "category": "VALUE_ILLEGAL", "column_number": 10, "file": "string", "line_number": 10, "message": { "args": [ "string", "string" ], "default_message": "string", "id": "string" } } ], "message": { "args": [ "string", "string" ], "default_message": "string", "id": "string" }, "name": "string", "value": "string" }
<?xml version="1.0" ?>
<ns0:OvfMessage xmlns:ns0="http://vmware.com/vcenter/ovf" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <message> <default_message>string</default_message> <id>string</id> <args-array> <array-item>string</array-item> <array-item>string</array-item> </args-array> </message> <category>VALIDATION</category> <error class="com.vmware.vapi.std.errors.error"> <data class="dynamic_structure"> </data> <messages-array> <array-item> <default_message>string</default_message> <id>string</id> <args-array> <array-item>string</array-item> <array-item>string</array-item> </args-array> </array-item> <array-item> <default_message>string</default_message> <id>string</id> <args-array> <array-item>string</array-item> <array-item>string</array-item> </args-array> </array-item> </messages-array> </error> <name>string</name> <issues-array> <array-item> <message> <default_message>string</default_message> <id>string</id> <args-array> <array-item>string</array-item> <array-item>string</array-item> </args-array> </message> <category>VALUE_ILLEGAL</category> <file>string</file> <line_number>10</line_number> <column_number>10</column_number> </array-item> <array-item> <message> <default_message>string</default_message> <id>string</id> <args-array> <array-item>string</array-item> <array-item>string</array-item> </args-array> </message> <category>VALUE_ILLEGAL</category> <file>string</file> <line_number>10</line_number> <column_number>10</column_number> </array-item> </issues-array> <value>string</value> </ns0:OvfMessage> |
Name | Type | Required | Description |
---|---|---|---|
category* |
com.vmware.vcenter.ovf.ovf_message.category | Yes | The message category. The category enumerated type defines the categories of messages (see com.vmware.vcenter.ovf.ovf_message).Values one of VALIDATION: The OVF descriptor is invalid, for example, syntax errors or schema errors. INPUT: The user provided input parameters are invalid. SERVER: Server error. |
issues | List<parse_issue> | No. This field is optional and it is only relevant when the value of category is VALIDATION. |
Array of parse issues (see com.vmware.vcenter.ovf.parse_issue). Required if category has value VALIDATION. |
name | string | No. This field is optional and it is only relevant when the value of category is INPUT. |
The name of input parameter. Required if category has value INPUT. |
value | string | No. This field is optional and it is only relevant when the value of category is INPUT. |
The value of input parameter. Required if category has value INPUT. |
message | localizable_message | No. This field is optional and it is only relevant when the value of category is INPUT. |
A localizable message. Required if category has value INPUT. |
error | dynamic_structure | No. This field is optional and it is only relevant when the value of category is SERVER. |
Represents a server com.vmware.vapi.std.errors.error. Has the fields of error. Required if category has value SERVER. |
Copyright © 2014. All Rights Reserved.