com.vmware.vapi.std.introspection

Class OperationTypes.DataDefinition.DataType

java.lang.Object

com.vmware.vapi.bindings.ApiEnumeration<OperationTypes.DataDefinition.DataType>

com.vmware.vapi.std.introspection.OperationTypes.DataDefinition.DataType

All Implemented Interfaces:

Serializable

Enclosing class:

OperationTypes.DataDefinition

public static final class OperationTypes.DataDefinition.DataType
extends ApiEnumeration<OperationTypes.DataDefinition.DataType>

The OperationTypes.DataDefinition.DataType enumeration provides values representing the data types supported by the vAPI infrastructure.

See enumerated types description.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OperationTypes.DataDefinition.DataType.Values Native Java enum representing this enumeration class.

Field Summary

Fields

Modifier and Type	Field and Description
static OperationTypes.DataDefinition.DataType	ANY_ERROR Indicates the value is arbitrary error type.
static OperationTypes.DataDefinition.DataType	BINARY Indicates the value is a binary type.
static OperationTypes.DataDefinition.DataType	BOOLEAN Indicates the value is a boolean type.
static OperationTypes.DataDefinition.DataType	DOUBLE Indicates the value is a double type.
static OperationTypes.DataDefinition.DataType	DYNAMIC_STRUCTURE Indicates the value is a dynamic structure.
static OperationTypes.DataDefinition.DataType	ERROR Indicates the value is a specific error type.
static OperationTypes.DataDefinition.DataType	LIST Indicates the value is a list data type.
static OperationTypes.DataDefinition.DataType	LONG Indicates the value is a long data type.
static OperationTypes.DataDefinition.DataType	OPAQUE Indicates the value is an opaque type.
static OperationTypes.DataDefinition.DataType	OPTIONAL Indicates the value is an optional data type.
static OperationTypes.DataDefinition.DataType	SECRET Indicates the value is a secret data type.
static OperationTypes.DataDefinition.DataType	STRING Indicates the value is a string data type.
static OperationTypes.DataDefinition.DataType	STRUCTURE Indicates the value is a structure data type.
static OperationTypes.DataDefinition.DataType	STRUCTURE_REF Indicates the value is a structure reference.
static OperationTypes.DataDefinition.DataType	VOID Indicates the value is a void data type.

Method Summary

Modifier and Type	Method and Description
OperationTypes.DataDefinition.DataType.Values	getEnumValue() Returns a native Java enum constant representing this enumeration constant.
boolean	isUnknown() Checks if this enumeration constant is unknown.
static OperationTypes.DataDefinition.DataType	valueOf(String name) Returns the enumeration constant for the specified name.
static OperationTypes.DataDefinition.DataType[]	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

BINARY

public static final OperationTypes.DataDefinition.DataType BINARY

Indicates the value is a binary type.

BOOLEAN

public static final OperationTypes.DataDefinition.DataType BOOLEAN

Indicates the value is a boolean type. The possible values are True and False equivalent of the language used to invoke this operation.

DOUBLE

public static final OperationTypes.DataDefinition.DataType DOUBLE

Indicates the value is a double type. It is a 64 bit floating point number.

DYNAMIC_STRUCTURE

public static final OperationTypes.DataDefinition.DataType DYNAMIC_STRUCTURE

Indicates the value is a dynamic structure. This means, any data of type STRUCTURE can be used.

ERROR

public static final OperationTypes.DataDefinition.DataType ERROR

Indicates the value is a specific error type.

ANY_ERROR

public static final OperationTypes.DataDefinition.DataType ANY_ERROR

Indicates the value is arbitrary error type. This means, any data of type ERROR can be used.

LIST

public static final OperationTypes.DataDefinition.DataType LIST

Indicates the value is a list data type. Any value of this type can have zero or more elements in the list.

LONG

public static final OperationTypes.DataDefinition.DataType LONG

Indicates the value is a long data type. It is a 64 bit signed integer number.

OPAQUE

public static final OperationTypes.DataDefinition.DataType OPAQUE

Indicates the value is an opaque type. This means, data of any OperationTypes.DataDefinition.DataType can be used.

OPTIONAL

public static final OperationTypes.DataDefinition.DataType OPTIONAL

Indicates the value is an optional data type. Any value of this type can be null.

SECRET

public static final OperationTypes.DataDefinition.DataType SECRET

Indicates the value is a secret data type. This is used for sensitive information. The server will not log any data of this type and if possible wipe the data from the memory after usage.

STRING

public static final OperationTypes.DataDefinition.DataType STRING

Indicates the value is a string data type. This is a unicode string.

STRUCTURE

public static final OperationTypes.DataDefinition.DataType STRUCTURE

Indicates the value is a structure data type. A structure has string identifier and a set of fields with corresponding values.

STRUCTURE_REF

public static final OperationTypes.DataDefinition.DataType STRUCTURE_REF

Indicates the value is a structure reference. This is used to break circular dependencies in the type references. This just has a string identifier of the structure. Clients have to maintain a list of structures already visited and use that to resolve this reference.

VOID

public static final OperationTypes.DataDefinition.DataType VOID

Indicates the value is a void data type.

Method Detail

values

public static OperationTypes.DataDefinition.DataType[] 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 OperationTypes.DataDefinition.DataType but is not pre-defined.

Returns:

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

valueOf

public static OperationTypes.DataDefinition.DataType valueOf(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 OperationTypes.DataDefinition.DataType will be returned for the specified name, which will not be one of the pre-defined constant instances. Such new instance maps to the OperationTypes.DataDefinition.DataType.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 OperationTypes.DataDefinition.DataType.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 OperationTypes.DataDefinition.DataType.Values._UNKNOWN enum constant is returned.

The native Java enum is OperationTypes.DataDefinition.DataType.Values.

Returns:

The Java enum constant. Never null.