com.vmware.vcenter.ovf

Class ParseIssue.Category

java.lang.Object

com.vmware.vapi.bindings.ApiEnumeration<ParseIssue.Category>

com.vmware.vcenter.ovf.ParseIssue.Category

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

ParseIssue

public static final class ParseIssue.Category
extends ApiEnumeration<ParseIssue.Category>

The Category enumeration class defines the categories of issues that can be found when parsing files inside an OVF package (see ParseIssue) including OVF descriptor (which is an XML document), manifest and certificate files, or exporting an OVF package.

See enumerated types description.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ParseIssue.Category.Values Native Java enum representing this enumeration class.

Field Summary

Fields

Modifier and Type	Field and Description
static ParseIssue.Category	ATTRIBUTE_ILLEGAL Illegal attribute error.
static ParseIssue.Category	ATTRIBUTE_REQUIRED Required attribute error.
static ParseIssue.Category	ELEMENT_ILLEGAL Illegal element error.
static ParseIssue.Category	ELEMENT_REQUIRED Required element error.
static ParseIssue.Category	ELEMENT_UNKNOWN Unknown element error.
static ParseIssue.Category	EXPORT_ERROR Issue during OVF export, for example, malformed deviceId, controller not found, or file backing for a device not found.
static ParseIssue.Category	GENERATE_ERROR OVF descriptor (which is an XML document) generating error, for example, well-formedness errors as well as unexpected processing conditions.
static ParseIssue.Category	INTERNAL_ERROR Server encountered an unexpected error which prevented it from fulfilling the request.
static ParseIssue.Category	PARSE_ERROR OVF package parsing error, including: OVF descriptor parsing errors, for example, syntax errors or schema errors.
static ParseIssue.Category	SECTION_RESTRICTION Section restriction error.
static ParseIssue.Category	SECTION_UNKNOWN Section unknown error.
static ParseIssue.Category	VALIDATION_ERROR An issue with the manifest and signing.
static ParseIssue.Category	VALUE_ILLEGAL Illegal value error.

Method Summary

Modifier and Type	Method and Description
ParseIssue.Category.Values	getEnumValue() Returns a native Java enum constant representing this enumeration constant.
boolean	isUnknown() Checks if this enumeration constant is unknown.
static ParseIssue.Category	valueOf(java.lang.String name) Returns the enumeration constant for the specified name.
static ParseIssue.Category[]	values() Retrieve all enumeration constants pre-defined by this enumeration class.

Methods inherited from class com.vmware.vapi.bindings.ApiEnumeration

buildNameMap, equals, hashCode, name, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

VALUE_ILLEGAL

public static final ParseIssue.Category VALUE_ILLEGAL

Illegal value error. For example, the value is malformed, not a number, or outside of the given range, and so on.

ATTRIBUTE_REQUIRED

public static final ParseIssue.Category ATTRIBUTE_REQUIRED

Required attribute error. It indicates that a required attribute is missing from an element in the OVF descriptor.

ATTRIBUTE_ILLEGAL

public static final ParseIssue.Category ATTRIBUTE_ILLEGAL

Illegal attribute error. It indicates that an illegal attribute is set for an element in the OVF descriptor. For example, empty disks do not use format, parentRef, and populatedSize attributes, if these attributes are present in an empty disk element then will get this pasrse issue.

ELEMENT_REQUIRED

public static final ParseIssue.Category ELEMENT_REQUIRED

Required element error. It indicates that a required element is missing from the OVF descriptor.

ELEMENT_ILLEGAL

public static final ParseIssue.Category ELEMENT_ILLEGAL

Illegal element error. It indicates that an element is present in a location which is not allowed, or found multiple elements but only one is allowed at the location in the OVF descriptor.

ELEMENT_UNKNOWN

public static final ParseIssue.Category ELEMENT_UNKNOWN

Unknown element error. It indicates that an element is unsupported when parsing an OVF descriptor.

SECTION_UNKNOWN

public static final ParseIssue.Category SECTION_UNKNOWN

Section unknown error. It indicates that a section is unsupported when parsing an OVF descriptor.

SECTION_RESTRICTION

public static final ParseIssue.Category SECTION_RESTRICTION

Section restriction error. It indicates that a section appears in place in the OVF descriptor where it is not allowed, a section appears fewer times than is required, or a section appears more times than is allowed.

PARSE_ERROR

public static final ParseIssue.Category PARSE_ERROR

OVF package parsing error, including:

• OVF descriptor parsing errors, for example, syntax errors or schema errors.
• Manifest file parsing and verification errors.
• Certificate file parsing and verification errors.

GENERATE_ERROR

public static final ParseIssue.Category GENERATE_ERROR

OVF descriptor (which is an XML document) generating error, for example, well-formedness errors as well as unexpected processing conditions.

VALIDATION_ERROR

public static final ParseIssue.Category VALIDATION_ERROR

An issue with the manifest and signing.

EXPORT_ERROR

public static final ParseIssue.Category EXPORT_ERROR

Issue during OVF export, for example, malformed deviceId, controller not found, or file backing for a device not found.

INTERNAL_ERROR

public static final ParseIssue.Category INTERNAL_ERROR

Server encountered an unexpected error which prevented it from fulfilling the request.

Method Detail

values

public static ParseIssue.Category[] values()

Retrieve all enumeration constants pre-defined by this enumeration class.

Additional instances might exist at runtime, for example to represent a new constant added to this enumeration class in subsequent version of the API. Such new constant is represented as instance of ParseIssue.Category but is not pre-defined.

Returns:

Array of all pre-defined enumeration constants. Never null.

valueOf

public static ParseIssue.Category valueOf(java.lang.String name)

Returns the enumeration constant for the specified name.

If the name matches exactly the identifier used to declare an enumeration constant from this enumeration class, the constant in question will be returned.

Otherwise, a new instance of ParseIssue.Category will be returned for the specified name, which will not be one of the pre-defined constant instances. Such new instance maps to the ParseIssue.Category.Values._UNKNOWN enum constant from the native Java enum.

Parameters:

name - The name of the constant to return. Must not be null.

Returns:

Enumeration constant for the specified name. Never null.

isUnknown

public boolean isUnknown()

Checks if this enumeration constant is unknown. Unknown is a constant that is not one of the pre-defined ones for this enumeration class. Also see valueOf(java.lang.String) and values().

Returns:

true if this constant is unknown, and false otherwise.

getEnumValue

public ParseIssue.Category.Values getEnumValue()

Returns a native Java enum constant representing this enumeration constant. The result is useful for usual handling of Java enum, for example it can be used in switch statements.

If this enumeration constant is unknown, then ParseIssue.Category.Values._UNKNOWN enum constant is returned.

The native Java enum is ParseIssue.Category.Values.

Returns:

The Java enum constant. Never null.