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::OperationInfo Class Reference
Inheritance diagram for Com::Vmware::Vapi::Metadata::Metamodel::OperationInfo:

Avaliable Methods

public method get_documentation ()
 
public method get_errors ()
 
public method set_name ()
 
public method set_metadata ()
 
public method get_metadata ()
 
public method set_errors ()
 
public method set_documentation ()
 
public method get_params ()
 
public method set_output ()
 
public method new ()
 
public method set_params ()
 
public method get_name ()
 
public method get_output ()
 

Detailed Description

The Com::Vmware::Vapi::Metadata::Metamodel::OperationInfo class contains metamodel information of an operation element.

Member Function Documentation

public method Com::Vmware::Vapi::Metadata::Metamodel::OperationInfo::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. String#
Code:
click to view
public method Com::Vmware::Vapi::Metadata::Metamodel::OperationInfo::get_errors ( )

Gets the value of 'errors' property.

Return values
errors- The current value of the field. 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. List#
Code:
click to view
public method Com::Vmware::Vapi::Metadata::Metamodel::OperationInfo::get_metadata ( )

Gets the value of 'metadata' property.

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

Map#

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

Gets the value of 'name' property.

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

Gets the value of 'output' property.

Return values
output- The current value of the field. Metamodel type for the output element. OperationResultInfo#
Code:
click to view
public method Com::Vmware::Vapi::Metadata::Metamodel::OperationInfo::get_params ( )

Gets the value of 'params' property.

Return values
params- The current value of the field. 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. List#
Code:
click to view
public method Com::Vmware::Vapi::Metadata::Metamodel::OperationInfo::new ( )

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

Return values
Blessedobject
Code:
click to view
public method Com::Vmware::Vapi::Metadata::Metamodel::OperationInfo::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.
Code:
click to view
public method Com::Vmware::Vapi::Metadata::Metamodel::OperationInfo::set_errors ( )

Sets the given value for 'errors' property.

Parameters
errors- New value for the field. 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.
Code:
click to view
public method Com::Vmware::Vapi::Metadata::Metamodel::OperationInfo::set_metadata ( )

Sets the given value for 'metadata' property.

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

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

Sets the given value for 'name' property.

Parameters
name- New value for the field. 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.
Code:
click to view
public method Com::Vmware::Vapi::Metadata::Metamodel::OperationInfo::set_output ( )

Sets the given value for 'output' property.

Parameters
output- New value for the field. Metamodel type for the output element.
Code:
click to view
public method Com::Vmware::Vapi::Metadata::Metamodel::OperationInfo::set_params ( )

Sets the given value for 'params' property.

Parameters
params- New value for the field. 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.
Code:
click to view

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