VMware vSphere Automation SDK Perl
The VMware vSphere Automation SDK for Perl supports the client-side vSphere Automation API for access to vSphere services and capabilities
 All Classes Files Functions
List of all members
Com::Vmware::Vapi::Metadata::Metamodel::ServiceInfo Class Reference
Inheritance diagram for Com::Vmware::Vapi::Metadata::Metamodel::ServiceInfo:

Avaliable Methods

public method get_enumerations ()
 
public method get_documentation ()
 
public method set_constants ()
 
public method get_constants ()
 
public method set_name ()
 
public method set_metadata ()
 
public method get_structures ()
 
public method get_metadata ()
 
public method set_structures ()
 
public method set_documentation ()
 
public method set_operations ()
 
public method set_enumerations ()
 
public method get_operations ()
 
public method new ()
 
public method get_name ()
 

Detailed Description

The Com::Vmware::Vapi::Metadata::Metamodel::ServiceInfo class contains the metamodel information of all the operation elements, structure elements and enumeration elements containted in a service element.

Member Function Documentation

public method Com::Vmware::Vapi::Metadata::Metamodel::ServiceInfo::get_constants ( )

Gets the value of 'constants' property.

Return values
constants- The current value of the field. Metamodel information of all the constant elements contained in the service 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 contant element. Map#
Code:
click to view
public method Com::Vmware::Vapi::Metadata::Metamodel::ServiceInfo::get_documentation ( )

Gets the value of 'documentation' property.

Return values
documentation- The current value of the field. English language documentation for the service element. It can contain HTML markup and Javadoc tags. The first sentence of the service documentation is a complete sentence that identifies the service by name and summarizes the purpose of the service. The remaining part of the documentation provides a summary of how to use the operations defined in the service. String#
Code:
click to view
public method Com::Vmware::Vapi::Metadata::Metamodel::ServiceInfo::get_enumerations ( )

Gets the value of 'enumerations' property.

Return values
enumerations- The current value of the field. Metamodel information of all the enumeration elements contained in the service 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. Map#
Code:
click to view
public method Com::Vmware::Vapi::Metadata::Metamodel::ServiceInfo::get_metadata ( )

Gets the value of 'metadata' property.

Return values
metadata- The current value of the field. Generic metadata elements for the service 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 class Com::Vmware::Vapi::Metadata::Metamodel::MetadataIdentifier contains possible string values for keys in the map .

Map#

Code:
click to view
public method Com::Vmware::Vapi::Metadata::Metamodel::ServiceInfo::get_name ( )

Gets the value of 'name' property.

Return values
name- The current value of the field. Dot separated name of the service 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. String#
Code:
click to view
public method Com::Vmware::Vapi::Metadata::Metamodel::ServiceInfo::get_operations ( )

Gets the value of 'operations' property.

Return values
operations- The current value of the field. Metamodel information of all the operation elements contained in the service element. The key in the map is the identifier of the operation element and the value in the map* is the metamodel information for the operation element. Map#
Code:
click to view
public method Com::Vmware::Vapi::Metadata::Metamodel::ServiceInfo::get_structures ( )

Gets the value of 'structures' property.

Return values
structures- The current value of the field. Metamodel information of all the structure elements contained in the service 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. Map#
Code:
click to view
public method Com::Vmware::Vapi::Metadata::Metamodel::ServiceInfo::new ( )

Constructor to initialize the Com::Vmware::Vapi::Metadata::Metamodel::ServiceInfo structure

Return values
Blessedobject
Code:
click to view
public method Com::Vmware::Vapi::Metadata::Metamodel::ServiceInfo::set_constants ( )

Sets the given value for 'constants' property.

Parameters
constants- New value for the field. Metamodel information of all the constant elements contained in the service 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 contant element.
Code:
click to view
public method Com::Vmware::Vapi::Metadata::Metamodel::ServiceInfo::set_documentation ( )

Sets the given value for 'documentation' property.

Parameters
documentation- New value for the field. English language documentation for the service element. It can contain HTML markup and Javadoc tags. The first sentence of the service documentation is a complete sentence that identifies the service by name and summarizes the purpose of the service. The remaining part of the documentation provides a summary of how to use the operations defined in the service.
Code:
click to view
public method Com::Vmware::Vapi::Metadata::Metamodel::ServiceInfo::set_enumerations ( )

Sets the given value for 'enumerations' property.

Parameters
enumerations- New value for the field. Metamodel information of all the enumeration elements contained in the service 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.
Code:
click to view
public method Com::Vmware::Vapi::Metadata::Metamodel::ServiceInfo::set_metadata ( )

Sets the given value for 'metadata' property.

Parameters
metadata- New value for the field. Generic metadata elements for the service 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 class Com::Vmware::Vapi::Metadata::Metamodel::MetadataIdentifier contains possible string values for keys in the map .

Code:
click to view
public method Com::Vmware::Vapi::Metadata::Metamodel::ServiceInfo::set_name ( )

Sets the given value for 'name' property.

Parameters
name- New value for the field. Dot separated name of the service 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.
Code:
click to view
public method Com::Vmware::Vapi::Metadata::Metamodel::ServiceInfo::set_operations ( )

Sets the given value for 'operations' property.

Parameters
operations- New value for the field. Metamodel information of all the operation elements contained in the service element. The key in the map is the identifier of the operation element and the value in the map* is the metamodel information for the operation element.
Code:
click to view
public method Com::Vmware::Vapi::Metadata::Metamodel::ServiceInfo::set_structures ( )

Sets the given value for 'structures' property.

Parameters
structures- New value for the field. Metamodel information of all the structure elements contained in the service 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.
Code:
click to view

The documentation for this class was generated from the following file: