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

Inherits:
VAPI::Bindings::VapiStruct
  • Object
show all
Defined in:
/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/cli.rb

Overview

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

Instance Attribute Summary (collapse)

Class Method Summary (collapse)

Instance Method Summary (collapse)

Constructor Details

- (OptionInfo) initialize(ruby_values = nil, struct_value = nil)

Constructs a new instance.

Parameters:

  • ruby_values (Hash) (defaults to: nil) —

    a map of initial property values (optional)

  • struct_value (VAPI::Data::StructValue) (defaults to: nil) —

    a raw StructValue from the wire (optional) 



252
253
254
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/cli.rb', line 252

def initialize(ruby_values=nil, struct_value=nil)
    super(self.class.binding_type, ruby_values, struct_value)
end

Instance Attribute Details

- (String) description

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

Returns:

  • (String) 


219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/cli.rb', line 219

class OptionInfo < VAPI::Bindings::VapiStruct

    class << self
        # Holds (gets or creates) the binding type metadata for this structure type.
        # @scope class
        # @return [VAPI::Bindings::StructType] the binding type
        def binding_type
            @binding_type ||= VAPI::Bindings::StructType.new(
                'com.vmware.vapi.metadata.cli.command.option_info',
                {
                    'long_option' => VAPI::Bindings::StringType.instance,
                    'short_option' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    'field_name' => VAPI::Bindings::StringType.instance,
                    'description' => VAPI::Bindings::StringType.instance,
                    'type' => VAPI::Bindings::StringType.instance,
                    'generic' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Metadata::Cli::Command::GenericType'),
                },
                OptionInfo,
                false,
                nil)
        end
    end

    attr_accessor :long_option,
                  :short_option,
                  :field_name,
                  :description,
                  :type,
                  :generic

    # Constructs a new instance.
    # @param ruby_values [Hash] a map of initial property values (optional)
    # @param struct_value [VAPI::Data::StructValue] a raw StructValue from the wire (optional)
    def initialize(ruby_values=nil, struct_value=nil)
        super(self.class.binding_type, ruby_values, struct_value)
    end
end

- (String) field_name

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

Returns:

  • (String) 


219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/cli.rb', line 219

class OptionInfo < VAPI::Bindings::VapiStruct

    class << self
        # Holds (gets or creates) the binding type metadata for this structure type.
        # @scope class
        # @return [VAPI::Bindings::StructType] the binding type
        def binding_type
            @binding_type ||= VAPI::Bindings::StructType.new(
                'com.vmware.vapi.metadata.cli.command.option_info',
                {
                    'long_option' => VAPI::Bindings::StringType.instance,
                    'short_option' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    'field_name' => VAPI::Bindings::StringType.instance,
                    'description' => VAPI::Bindings::StringType.instance,
                    'type' => VAPI::Bindings::StringType.instance,
                    'generic' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Metadata::Cli::Command::GenericType'),
                },
                OptionInfo,
                false,
                nil)
        end
    end

    attr_accessor :long_option,
                  :short_option,
                  :field_name,
                  :description,
                  :type,
                  :generic

    # Constructs a new instance.
    # @param ruby_values [Hash] a map of initial property values (optional)
    # @param struct_value [VAPI::Data::StructValue] a raw StructValue from the wire (optional)
    def initialize(ruby_values=nil, struct_value=nil)
        super(self.class.binding_type, ruby_values, struct_value)
    end
end

- (Com::Vmware::Vapi::Metadata::Cli::Command::GenericType) generic

This is used to tell the user whether the option is required or optional, or whether they can specify the option multiple times.

Returns:



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/cli.rb', line 219

class OptionInfo < VAPI::Bindings::VapiStruct

    class << self
        # Holds (gets or creates) the binding type metadata for this structure type.
        # @scope class
        # @return [VAPI::Bindings::StructType] the binding type
        def binding_type
            @binding_type ||= VAPI::Bindings::StructType.new(
                'com.vmware.vapi.metadata.cli.command.option_info',
                {
                    'long_option' => VAPI::Bindings::StringType.instance,
                    'short_option' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    'field_name' => VAPI::Bindings::StringType.instance,
                    'description' => VAPI::Bindings::StringType.instance,
                    'type' => VAPI::Bindings::StringType.instance,
                    'generic' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Metadata::Cli::Command::GenericType'),
                },
                OptionInfo,
                false,
                nil)
        end
    end

    attr_accessor :long_option,
                  :short_option,
                  :field_name,
                  :description,
                  :type,
                  :generic

    # Constructs a new instance.
    # @param ruby_values [Hash] a map of initial property values (optional)
    # @param struct_value [VAPI::Data::StructValue] a raw StructValue from the wire (optional)
    def initialize(ruby_values=nil, struct_value=nil)
        super(self.class.binding_type, ruby_values, struct_value)
    end
end

- (String) long_option

The long option name of the parameter as used by the user.

Returns:

  • (String) 


219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/cli.rb', line 219

class OptionInfo < VAPI::Bindings::VapiStruct

    class << self
        # Holds (gets or creates) the binding type metadata for this structure type.
        # @scope class
        # @return [VAPI::Bindings::StructType] the binding type
        def binding_type
            @binding_type ||= VAPI::Bindings::StructType.new(
                'com.vmware.vapi.metadata.cli.command.option_info',
                {
                    'long_option' => VAPI::Bindings::StringType.instance,
                    'short_option' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    'field_name' => VAPI::Bindings::StringType.instance,
                    'description' => VAPI::Bindings::StringType.instance,
                    'type' => VAPI::Bindings::StringType.instance,
                    'generic' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Metadata::Cli::Command::GenericType'),
                },
                OptionInfo,
                false,
                nil)
        end
    end

    attr_accessor :long_option,
                  :short_option,
                  :field_name,
                  :description,
                  :type,
                  :generic

    # Constructs a new instance.
    # @param ruby_values [Hash] a map of initial property values (optional)
    # @param struct_value [VAPI::Data::StructValue] a raw StructValue from the wire (optional)
    def initialize(ruby_values=nil, struct_value=nil)
        super(self.class.binding_type, ruby_values, struct_value)
    end
end

- (String?) short_option

The single character value option name. If not present, there’s no single character option for the parameter.

Returns:

  • (String, nil) 


219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/cli.rb', line 219

class OptionInfo < VAPI::Bindings::VapiStruct

    class << self
        # Holds (gets or creates) the binding type metadata for this structure type.
        # @scope class
        # @return [VAPI::Bindings::StructType] the binding type
        def binding_type
            @binding_type ||= VAPI::Bindings::StructType.new(
                'com.vmware.vapi.metadata.cli.command.option_info',
                {
                    'long_option' => VAPI::Bindings::StringType.instance,
                    'short_option' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    'field_name' => VAPI::Bindings::StringType.instance,
                    'description' => VAPI::Bindings::StringType.instance,
                    'type' => VAPI::Bindings::StringType.instance,
                    'generic' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Metadata::Cli::Command::GenericType'),
                },
                OptionInfo,
                false,
                nil)
        end
    end

    attr_accessor :long_option,
                  :short_option,
                  :field_name,
                  :description,
                  :type,
                  :generic

    # Constructs a new instance.
    # @param ruby_values [Hash] a map of initial property values (optional)
    # @param struct_value [VAPI::Data::StructValue] a raw StructValue from the wire (optional)
    def initialize(ruby_values=nil, struct_value=nil)
        super(self.class.binding_type, ruby_values, struct_value)
    end
end

- (String) type

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.

Returns:

  • (String) 


219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/cli.rb', line 219

class OptionInfo < VAPI::Bindings::VapiStruct

    class << self
        # Holds (gets or creates) the binding type metadata for this structure type.
        # @scope class
        # @return [VAPI::Bindings::StructType] the binding type
        def binding_type
            @binding_type ||= VAPI::Bindings::StructType.new(
                'com.vmware.vapi.metadata.cli.command.option_info',
                {
                    'long_option' => VAPI::Bindings::StringType.instance,
                    'short_option' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    'field_name' => VAPI::Bindings::StringType.instance,
                    'description' => VAPI::Bindings::StringType.instance,
                    'type' => VAPI::Bindings::StringType.instance,
                    'generic' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Metadata::Cli::Command::GenericType'),
                },
                OptionInfo,
                false,
                nil)
        end
    end

    attr_accessor :long_option,
                  :short_option,
                  :field_name,
                  :description,
                  :type,
                  :generic

    # Constructs a new instance.
    # @param ruby_values [Hash] a map of initial property values (optional)
    # @param struct_value [VAPI::Data::StructValue] a raw StructValue from the wire (optional)
    def initialize(ruby_values=nil, struct_value=nil)
        super(self.class.binding_type, ruby_values, struct_value)
    end
end

Class Method Details

+ (VAPI::Bindings::StructType) binding_type

Holds (gets or creates) the binding type metadata for this structure type.

Returns:

  • (VAPI::Bindings::StructType) —

    the binding type 



225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/cli.rb', line 225

def binding_type
    @binding_type ||= VAPI::Bindings::StructType.new(
        'com.vmware.vapi.metadata.cli.command.option_info',
        {
            'long_option' => VAPI::Bindings::StringType.instance,
            'short_option' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
            'field_name' => VAPI::Bindings::StringType.instance,
            'description' => VAPI::Bindings::StringType.instance,
            'type' => VAPI::Bindings::StringType.instance,
            'generic' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Metadata::Cli::Command::GenericType'),
        },
        OptionInfo,
        false,
        nil)
end