Developer Documentation

MetamodelPackageInfo

The PackageInfo structure contains the metamodel information of all the service elements, structure elements and enumeration elements contained in the package element.


Properties

Required Property Name Type Description
required documentation string

English language documentation for a package. It can contain HTML markup and Javadoc tags. The first sentence of the package documentation is a complete sentence that identifies the package by name and summarizes the purpose of the package. The primary purpose of a package documentation is to provide high-level context that will provide a framework in which the users can put the detail about the package contents.

required enumerations map of MetamodelEnumerationInfo

Metamodel information of all the enumeration elements contained in the package element. The key in the map is the identifier of the enumeration element and the value in the map is the metamodel information for the enumeration element. This does not include the enumeration elements that are contained in the service elements of this package element or structure elements of this package element.

When clients pass a value of this structure as a parameter, the key in the field map must be an identifier for the resource type: com.vmware.vapi.enumeration. When operations return a value of this structure as a result, the key in the field map will be an identifier for the resource type: com.vmware.vapi.enumeration.

required metadata map of MetamodelElementMap

Generic metadata elements for the package 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.

required name string

Dot separated name of the package 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.

required services map of MetamodelServiceInfo

Metamodel information of all the service elements contained in the package element. The key in the map is the identifier of the service element and the value in the map is the metamodel information for the service element. When clients pass a value of this structure as a parameter, the key in the field map must be an identifier for the resource type: com.vmware.vapi.service. When operations return a value of this structure as a result, the key in the field map will be an identifier for the resource type: com.vmware.vapi.service.

required structures map of MetamodelStructureInfo

Metamodel information of all the structure elements contained in the package element. The key in the map is the identifier of the structure element and the value in the map is the metamodel information for the structure element. This does not include the structure elements contained in the service elements that are contained in this package element.

When clients pass a value of this structure as a parameter, the key in the field map must be an identifier for the resource type: com.vmware.vapi.structure. When operations return a value of this structure as a result, the key in the field map will be an identifier for the resource type: com.vmware.vapi.structure.

Feedback

Was this page helpful?