Com::Vmware::Vapi::Metadata::Cli::Command Class Reference

Inheritance diagram for Com::Vmware::Vapi::Metadata::Cli::Command:

Classes
class	FormatterType
class	GenericType
class	Identity
class	Info
class	OptionInfo
class	OutputFieldInfo
class	OutputInfo

Avaliable Methods
public method	get ()
public method	fingerprint ()
public method	new ()
public method	list ()

Detailed Description

The Com::Vmware::Vapi::Metadata::Cli::Command interface provides methods to get information about command line interface (CLI) commands.

Member Function Documentation

public method Com::Vmware::Vapi::Metadata::Cli::Command::fingerprint

(

)

Returns the aggregate fingerprint of all the command metadata from all the metadata sources.

The fingerprint provides clients an efficient way to check if the metadata for commands has been modified on the server.

Return values

Fingerprint

of all the command metadata present on the server. The return type will be String

Code:

public method Com::Vmware::Vapi::Metadata::Cli::Command::get

(

)

Retrieves information about a command including information about how to execute that command.

Parameters

identity

[REQUIRED] Identifier of the command for which to retreive information. . The value must be Com::Vmware::Vapi::Metadata::Cli::Command::Identity.

Return values

Information

about the command including information about how to execute that command. The return type will be Com::Vmware::Vapi::Metadata::Cli::Command::Info

Exceptions

Com::Vmware::Vapi::Std::Errors::NotFound

if a command corresponding to identity doesn't exist.

Code:

public method Com::Vmware::Vapi::Metadata::Cli::Command::list

(

)

Returns the identifiers of all commands, or commands in a specific namespace.

Parameters

path	[OPTIONAL] The dot-separated path of the namespace for which command identifiers should be returned. If null identifiers of all commands registered with the infrastructure will be returned. . The value must be String or None.

Return values

Identifiers

of the requested commands. The return type will be Array of Com::Vmware::Vapi::Metadata::Cli::Command::Identity

Exceptions

Com::Vmware::Vapi::Std::Errors::NotFound

if a namespace corresponding to path doesn't exist.

Code:

public method Com::Vmware::Vapi::Metadata::Cli::Command::new

(

)

Constructor to initialize the object

Parameters

api_provider	- protocol connection to use with stubs created by this factory
StubConfig	- Stub's additional configuration

Return values

Blessed

object

Code:

---

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

• Com/Vmware/Vapi/Metadata/Cli/Command.pm