StructureInfo

java.lang.Object
- com.vmware.vapi.metadata.metamodel.StructureInfo

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
```
public final class StructureInfo
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
```
The StructureInfo class contains the metamodel information of all the field elements, constant elements and enumeration elements contained in the structure element.
In the interface definition language, API designers have the ability to include all the fields from one structure to another structure. This is done by using an annotation @Include on the structure in which we want to add the fields. If this annotation is present, the list of fields in the StructureInfo will also contain the fields that are being included. The annotation information is also retained in the getMetadata() element as well.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`StructureInfo.Builder` Builder class for `StructureInfo`.
`static class`	`StructureInfo.Type` The `Type` enumeration class defines the kind of this structure element.

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

StructureInfo()
Default constructor.

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

Constructors
Modifier	Constructor and Description
	`StructureInfo()` Default constructor.
`protected`	`StructureInfo(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 StructureInfo`	`_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 StructureInfo`	`_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.util.Map<java.lang.String,ConstantInfo>`	`getConstants()` Metamodel information of all the constant elements contained in the structure element.
`java.lang.String`	`getDocumentation()` English language documentation for a structure element.
`java.util.Map<java.lang.String,EnumerationInfo>`	`getEnumerations()` Metamodel information of all the enumeration elements contained in the structure element.
`java.util.List<FieldInfo>`	`getFields()` Metamodel information of all the field elements.
`java.util.Map<java.lang.String,ElementMap>`	`getMetadata()` Generic metadata elements for the structure element.
`java.lang.String`	`getName()` Dot separated name of the structure element.
`StructureInfo.Type`	`getType()` Type of the structure.
`int`	`hashCode()`
`void`	`setConstants(java.util.Map<java.lang.String,ConstantInfo> constants)` Metamodel information of all the constant elements contained in the structure element.
`void`	`setDocumentation(java.lang.String documentation)` English language documentation for a structure element.
`void`	`setEnumerations(java.util.Map<java.lang.String,EnumerationInfo> enumerations)` Metamodel information of all the enumeration elements contained in the structure element.
`void`	`setFields(java.util.List<FieldInfo> fields)` Metamodel information of all the field elements.
`void`	`setMetadata(java.util.Map<java.lang.String,ElementMap> metadata)` Generic metadata elements for the structure element.
`void`	`setName(java.lang.String name)` Dot separated name of the structure element.
`void`	`setType(StructureInfo.Type type)` Type of the structure.
`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
  - StructureInfo
```
public StructureInfo()
```
    Default constructor.
  - StructureInfo
```
protected StructureInfo(com.vmware.vapi.data.StructValue __dynamicStructureFields)
```
- Method Detail
  - getName
```
public java.lang.String getName()
```
    Dot separated name of the structure element. The segments in the name reflect the organization of the APIs. The format of each segment 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)
```
    Dot separated name of the structure element. The segments in the name reflect the organization of the APIs. The format of each segment 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.
  - getType
```
public StructureInfo.Type getType()
```
    Type of the structure.
    
    Returns:
    
    The current value of the property.
  - setType
```
public void setType(StructureInfo.Type type)
```
    Type of the structure.
    
    Parameters:
    
    type - New value for the property.
  - getEnumerations
```
public java.util.Map<java.lang.String,EnumerationInfo> getEnumerations()
```
    Metamodel information of all the enumeration elements contained in the structure element. The key in the Map is the identifier of the enumeration element and the value is the metamodel information of the enumeration element.
    
    Returns:
    
    The current value of the property. When clients pass a value of this class as a parameter, the key in the property Map must be an identifier for the resource type: com.vmware.vapi.enumeration. When methods return a value of this class as a return value, the key in the property Map will be an identifier for the resource type: com.vmware.vapi.enumeration.
  - setEnumerations
```
public void setEnumerations(java.util.Map<java.lang.String,EnumerationInfo> enumerations)
```
    Metamodel information of all the enumeration elements contained in the structure element. The key in the Map is the identifier of the enumeration element and the value is the metamodel information of the enumeration element.
    
    Parameters:
    
    enumerations - New value for the property. When clients pass a value of this class as a parameter, the key in the property Map must be an identifier for the resource type: com.vmware.vapi.enumeration. When methods return a value of this class as a return value, the key in the property Map will be an identifier for the resource type: com.vmware.vapi.enumeration.
  - getConstants
```
public java.util.Map<java.lang.String,ConstantInfo> getConstants()
```
    Metamodel information of all the constant elements contained in the structure element. The key in the Map is the name of the constant element and the value in the Map is the metamodel information for the constant element.
    
    Returns:
    
    The current value of the property.
  - setConstants
```
public void setConstants(java.util.Map<java.lang.String,ConstantInfo> constants)
```
    Metamodel information of all the constant elements contained in the structure element. The key in the Map is the name of the constant element and the value in the Map is the metamodel information for the constant element.
    
    Parameters:
    
    constants - New value for the property.
  - getFields
```
public java.util.List<FieldInfo> getFields()
```
    Metamodel information of all the field elements. The order of the field elements in the list matches the order in which the fields are defined in the service.
    
    Returns:
    
    The current value of the property.
  - setFields
```
public void setFields(java.util.List<FieldInfo> fields)
```
    Metamodel information of all the field elements. The order of the field elements in the list matches the order in which the fields are defined in the service.
    
    Parameters:
    
    fields - New value for the property.
  - getMetadata
```
public java.util.Map<java.lang.String,ElementMap> getMetadata()
```
    Generic metadata elements for the structure 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 keys 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 structure 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 keys in the Map.
    
    Parameters:
    
    metadata - New value for the property.
  - getDocumentation
```
public java.lang.String getDocumentation()
```
    English language documentation for a structure element. It can contain HTML markup and Javadoc tags. The first sentence of the structure documentation is a complete sentence that identifies the structure by name and summarizes the purpose of the structure.
    
    Returns:
    
    The current value of the property.
  - setDocumentation
```
public void setDocumentation(java.lang.String documentation)
```
    English language documentation for a structure element. It can contain HTML markup and Javadoc tags. The first sentence of the structure documentation is a complete sentence that identifies the structure by name and summarizes the purpose of the structure.
    
    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 StructureInfo _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 StructureInfo _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class StructureInfo

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

__dynamicStructureFields

Constructor Detail

StructureInfo

StructureInfo

Method Detail

getName

setName

getType

setType

getEnumerations

setEnumerations

getConstants

setConstants

getFields

setFields

getMetadata

setMetadata

getDocumentation

setDocumentation

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2