com.vmware.vapi.metadata.metamodel

Class OperationInfo

java.lang.Object

com.vmware.vapi.metadata.metamodel.OperationInfo

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable

public final class OperationInfo
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure

The OperationInfo class contains metamodel information of an operation element.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OperationInfo.Builder Builder class for OperationInfo.

Field Summary

Fields

Modifier and Type	Field and Description
protected com.vmware.vapi.data.StructValue	__dynamicStructureFields

Constructor Summary

Constructors

Modifier	Constructor and Description
	OperationInfo() Default constructor.
protected	OperationInfo(com.vmware.vapi.data.StructValue __dynamicStructureFields)

Method Summary

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 OperationInfo	_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 OperationInfo	_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)
java.lang.String	getDocumentation() English language documentation for the operation element.
java.util.List<ErrorInfo>	getErrors() List of error elements that might be reported by the operation element.
java.util.Map<java.lang.String,ElementMap>	getMetadata() Generic metadata elements for the operation element.
java.lang.String	getName() Name of the operation element in a canonical format.
OperationResultInfo	getOutput() Metamodel type for the output element.
java.util.List<FieldInfo>	getParams() Metamodel information for the parameter elements.
int	hashCode()
void	setDocumentation(java.lang.String documentation) English language documentation for the operation element.
void	setErrors(java.util.List<ErrorInfo> errors) List of error elements that might be reported by the operation element.
void	setMetadata(java.util.Map<java.lang.String,ElementMap> metadata) Generic metadata elements for the operation element.
void	setName(java.lang.String name) Name of the operation element in a canonical format.
void	setOutput(OperationResultInfo output) Metamodel type for the output element.
void	setParams(java.util.List<FieldInfo> params) Metamodel information for the parameter elements.
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

OperationInfo

public OperationInfo()

Default constructor.

OperationInfo

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

Method Detail

getName

public java.lang.String getName()

Name of the operation element in a canonical format. The format is lower case with underscores. Each underscore represents a word boundary. If there are acronyms in the word, the capitalization is preserved. This format makes it easy to translate the segment into a different naming convention.

Returns:

The current value of the property.

setName

public void setName(java.lang.String name)

Name of the operation element in a canonical format. The format is lower case with underscores. Each underscore represents a word boundary. If there are acronyms in the word, the capitalization is preserved. This format makes it easy to translate the segment into a different naming convention.

Parameters:

name - New value for the property.

getParams

public java.util.List<FieldInfo> getParams()

Metamodel information for the parameter elements. The order of the parameters elements in the list is same as the order of the parameters declared in the interface definition file.

Returns:

The current value of the property.

setParams

public void setParams(java.util.List<FieldInfo> params)

Metamodel information for the parameter elements. The order of the parameters elements in the list is same as the order of the parameters declared in the interface definition file.

Parameters:

params - New value for the property.

getOutput

public OperationResultInfo getOutput()

Metamodel type for the output element.

Returns:

The current value of the property.

setOutput

public void setOutput(OperationResultInfo output)

Metamodel type for the output element.

Parameters:

output - New value for the property.

getErrors

public java.util.List<ErrorInfo> getErrors()

List of error elements that might be reported by the operation element. If the operation reports the same error for more than one reason, the list contains the error element associated with the error more than once with different documentation elements.

Returns:

The current value of the property.

setErrors

public void setErrors(java.util.List<ErrorInfo> errors)

List of error elements that might be reported by the operation element. If the operation reports the same error for more than one reason, the list contains the error element associated with the error more than once with different documentation elements.

Parameters:

errors - New value for the property.

getMetadata

public java.util.Map<java.lang.String,ElementMap> getMetadata()

Generic metadata elements for the operation element. The key in the Map is the name of the metadata element and the value is the data associated with that metadata element.

The MetadataIdentifier contains possible string values for key in the Map.

Returns:

The current value of the property.

setMetadata

public void setMetadata(java.util.Map<java.lang.String,ElementMap> metadata)

Generic metadata elements for the operation element. The key in the Map is the name of the metadata element and the value is the data associated with that metadata element.

The MetadataIdentifier contains possible string values for key in the Map.

Parameters:

metadata - New value for the property.

getDocumentation

public java.lang.String getDocumentation()

English language documentation for the operation element. It can contain HTML markup and Javadoc tags.

Returns:

The current value of the property.

setDocumentation

public void setDocumentation(java.lang.String documentation)

English language documentation for the operation element. It can contain HTML markup and Javadoc tags.

Parameters:

documentation - New value for the property.

_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 OperationInfo _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 OperationInfo _newInstance2(com.vmware.vapi.data.StructValue structValue)

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