4.1

Type Value Description
java-name
Java method Name of the Java method signature with
argument types in parenthesis, for
example, getVms(DataStore).
Mandatory attribute.
script-name
JavaScript method Name of the corresponding JavaScript
method. Mandatory attribute.
return-type
Java object type The type this method obtains. Optional
attribute.
static
true or false If true, this method is static. Optional
attribute.
show-in-api
true or false If false, this method does not appear
in API documentation. Optional
attribute.
is-deprecated
true or false If true, the object maps a deprecated
method. Optional attribute.
since-version
Number The version at which the method was
deprecated. Optional attribute.
Table 7-43. Element Hierarchy
Parent Element Child Elements
<methods>
n
<deprecated>
n
<description>
n
<example>
n
<parameters>
example Element
The <example> element allows you to add code examples to Javascript methods that appear in the API Explorer
documentation.
The <example> element is optional. The <example> element has no attributes.
Table 7-44. Element Hierarchy
Parent Element Child Elements
<method>
n
<code>
n
<description>
code Element
The <code> element provides example code that appears in the API Explorer documentation.
You provide the code example between the <code> and </code> tags. The <code> element is optional. The
<code> element has no attributes.
Table 7-45. Element Hierarchy
Parent Element Child Elements
<example>
None
vCenter Orchestrator Developer's Guide
238 VMware, Inc.