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

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

Avaliable Methods
public method	get_long_option ()
public method	set_field_name ()
public method	set_type ()
public method	set_description ()
public method	set_long_option ()
public method	get_generic ()
public method	set_short_option ()
public method	set_generic ()
public method	get_short_option ()
public method	get_description ()
public method	get_type ()
public method	new ()
public method	get_field_name ()

Detailed Description

The Com::Vmware::Vapi::Metadata::Cli::Command::OptionInfo class describes information about a specific input option of a command.

Member Function Documentation

public method Com::Vmware::Vapi::Metadata::Cli::Command::OptionInfo::get_description

(

)

Gets the value of 'description' property.

Return values

description

- The current value of the field. The description of the option to be displayed to the user when they request usage information for a CLI command. String#

Code:

public method Com::Vmware::Vapi::Metadata::Cli::Command::OptionInfo::get_field_name

(

)

Gets the value of 'field_name' property.

Return values

field_name

- The current value of the field. The fully qualified name of the option referred to by the operation element in :attr:Com::Vmware::Vapi::Metadata::Cli::Command::Info.operation_id . String#

Code:

public method Com::Vmware::Vapi::Metadata::Cli::Command::OptionInfo::get_generic

(

)

Gets the value of 'generic' property.

Return values

generic

- The current value of the field. This is used to tell the user whether the option is required or optional, or whether they can specify the option multiple times. GenericType#

Code:

public method Com::Vmware::Vapi::Metadata::Cli::Command::OptionInfo::get_long_option

(

)

Gets the value of 'long_option' property.

Return values

long_option

- The current value of the field. The long option name of the parameter as used by the user. String#

Code:

public method Com::Vmware::Vapi::Metadata::Cli::Command::OptionInfo::get_short_option

(

)

Gets the value of 'short_option' property.

Return values

short_option

- The current value of the field. The single character value option name. Optional#

Code:

public method Com::Vmware::Vapi::Metadata::Cli::Command::OptionInfo::get_type

(

)

Gets the value of 'type' property.

Return values

type

- The current value of the field. The type of option. This is used to display information about what kind of data is expected (string, number, boolean, etc.) for the option when they request usage information for a CLI command. For enumerated type this stores the fully qualified enumerated type* id. String#

Code:

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

(

)

Constructor to initialize the Com::Vmware::Vapi::Metadata::Cli::Command::OptionInfo structure

Return values

Blessed

object

Code:

public method Com::Vmware::Vapi::Metadata::Cli::Command::OptionInfo::set_description

(

)

Sets the given value for 'description' property.

Parameters

description

- New value for the field. The description of the option to be displayed to the user when they request usage information for a CLI command.

Code:

public method Com::Vmware::Vapi::Metadata::Cli::Command::OptionInfo::set_field_name

(

)

Sets the given value for 'field_name' property.

Parameters

field_name

- New value for the field. The fully qualified name of the option referred to by the operation element in :attr:Com::Vmware::Vapi::Metadata::Cli::Command::Info.operation_id .

Code:

public method Com::Vmware::Vapi::Metadata::Cli::Command::OptionInfo::set_generic

(

)

Sets the given value for 'generic' property.

Parameters

generic

- New value for the field. This is used to tell the user whether the option is required or optional, or whether they can specify the option multiple times.

Code:

public method Com::Vmware::Vapi::Metadata::Cli::Command::OptionInfo::set_long_option

(

)

Sets the given value for 'long_option' property.

Parameters

long_option

- New value for the field. The long option name of the parameter as used by the user.

Code:

public method Com::Vmware::Vapi::Metadata::Cli::Command::OptionInfo::set_short_option

(

)

Sets the given value for 'short_option' property.

Parameters

short_option

- New value for the field. The single character value option name.

Code:

public method Com::Vmware::Vapi::Metadata::Cli::Command::OptionInfo::set_type

(

)

Sets the given value for 'type' property.

Parameters

type	- New value for the field. The type of option. This is used to display information about what kind of data is expected (string, number, boolean, etc.) for the option when they request usage information for a CLI command. For enumerated type this stores the fully qualified enumerated type* id.

Code:

---

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

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