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

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::Info`` class contains information about a command. It includes the identity of the command, a description, information about the class and method that implement the command, and CLI-specific information for the command.

Instance Attribute Summary (collapse)

Class Method Summary (collapse)

Instance Method Summary (collapse)

Constructor Details

- (Info) 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) 



354
355
356
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/cli.rb', line 354

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

Instance Attribute Details

- (String) description

The text description displayed to the user in help output.

Returns:

  • (String) 


319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/cli.rb', line 319

class Info < 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.info',
                {
                    'identity' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Metadata::Cli::Command::Identity'),
                    'description' => VAPI::Bindings::StringType.instance,
                    'service_id' => VAPI::Bindings::IdType.new(resource_types='com.vmware.vapi.service'),
                    'operation_id' => VAPI::Bindings::IdType.new(resource_types='com.vmware.vapi.operation'),
                    'options' => VAPI::Bindings::ListType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Metadata::Cli::Command::OptionInfo')),
                    'formatter' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Metadata::Cli::Command::FormatterType')),
                    'output_field_list' => VAPI::Bindings::ListType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Metadata::Cli::Command::OutputInfo')),
                },
                Info,
                false,
                nil)
        end
    end

    attr_accessor :identity,
                  :description,
                  :service_id,
                  :operation_id,
                  :options,
                  :formatter,
                  :output_field_list

    # 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::FormatterType?) formatter

The formatter to use when displaying the output of this command. If not present, client can choose a default output formatter.

Returns:



319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/cli.rb', line 319

class Info < 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.info',
                {
                    'identity' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Metadata::Cli::Command::Identity'),
                    'description' => VAPI::Bindings::StringType.instance,
                    'service_id' => VAPI::Bindings::IdType.new(resource_types='com.vmware.vapi.service'),
                    'operation_id' => VAPI::Bindings::IdType.new(resource_types='com.vmware.vapi.operation'),
                    'options' => VAPI::Bindings::ListType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Metadata::Cli::Command::OptionInfo')),
                    'formatter' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Metadata::Cli::Command::FormatterType')),
                    'output_field_list' => VAPI::Bindings::ListType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Metadata::Cli::Command::OutputInfo')),
                },
                Info,
                false,
                nil)
        end
    end

    attr_accessor :identity,
                  :description,
                  :service_id,
                  :operation_id,
                  :options,
                  :formatter,
                  :output_field_list

    # 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::Identity) identity

Basic command identity.

Returns:



319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/cli.rb', line 319

class Info < 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.info',
                {
                    'identity' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Metadata::Cli::Command::Identity'),
                    'description' => VAPI::Bindings::StringType.instance,
                    'service_id' => VAPI::Bindings::IdType.new(resource_types='com.vmware.vapi.service'),
                    'operation_id' => VAPI::Bindings::IdType.new(resource_types='com.vmware.vapi.operation'),
                    'options' => VAPI::Bindings::ListType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Metadata::Cli::Command::OptionInfo')),
                    'formatter' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Metadata::Cli::Command::FormatterType')),
                    'output_field_list' => VAPI::Bindings::ListType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Metadata::Cli::Command::OutputInfo')),
                },
                Info,
                false,
                nil)
        end
    end

    attr_accessor :identity,
                  :description,
                  :service_id,
                  :operation_id,
                  :options,
                  :formatter,
                  :output_field_list

    # 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) operation_id

The operation identifier corresponding to this CLI command.

Returns:

  • (String) 


319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/cli.rb', line 319

class Info < 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.info',
                {
                    'identity' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Metadata::Cli::Command::Identity'),
                    'description' => VAPI::Bindings::StringType.instance,
                    'service_id' => VAPI::Bindings::IdType.new(resource_types='com.vmware.vapi.service'),
                    'operation_id' => VAPI::Bindings::IdType.new(resource_types='com.vmware.vapi.operation'),
                    'options' => VAPI::Bindings::ListType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Metadata::Cli::Command::OptionInfo')),
                    'formatter' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Metadata::Cli::Command::FormatterType')),
                    'output_field_list' => VAPI::Bindings::ListType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Metadata::Cli::Command::OutputInfo')),
                },
                Info,
                false,
                nil)
        end
    end

    attr_accessor :identity,
                  :description,
                  :service_id,
                  :operation_id,
                  :options,
                  :formatter,
                  :output_field_list

    # 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

- (Array<Com::Vmware::Vapi::Metadata::Cli::Command::OptionInfo>) options

The input for this command.

Returns:



319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/cli.rb', line 319

class Info < 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.info',
                {
                    'identity' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Metadata::Cli::Command::Identity'),
                    'description' => VAPI::Bindings::StringType.instance,
                    'service_id' => VAPI::Bindings::IdType.new(resource_types='com.vmware.vapi.service'),
                    'operation_id' => VAPI::Bindings::IdType.new(resource_types='com.vmware.vapi.operation'),
                    'options' => VAPI::Bindings::ListType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Metadata::Cli::Command::OptionInfo')),
                    'formatter' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Metadata::Cli::Command::FormatterType')),
                    'output_field_list' => VAPI::Bindings::ListType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Metadata::Cli::Command::OutputInfo')),
                },
                Info,
                false,
                nil)
        end
    end

    attr_accessor :identity,
                  :description,
                  :service_id,
                  :operation_id,
                  :options,
                  :formatter,
                  :output_field_list

    # 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

- (Array<Com::Vmware::Vapi::Metadata::Cli::Command::OutputInfo>) output_field_list

List of output structure name and output field info.

Returns:



319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/cli.rb', line 319

class Info < 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.info',
                {
                    'identity' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Metadata::Cli::Command::Identity'),
                    'description' => VAPI::Bindings::StringType.instance,
                    'service_id' => VAPI::Bindings::IdType.new(resource_types='com.vmware.vapi.service'),
                    'operation_id' => VAPI::Bindings::IdType.new(resource_types='com.vmware.vapi.operation'),
                    'options' => VAPI::Bindings::ListType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Metadata::Cli::Command::OptionInfo')),
                    'formatter' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Metadata::Cli::Command::FormatterType')),
                    'output_field_list' => VAPI::Bindings::ListType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Metadata::Cli::Command::OutputInfo')),
                },
                Info,
                false,
                nil)
        end
    end

    attr_accessor :identity,
                  :description,
                  :service_id,
                  :operation_id,
                  :options,
                  :formatter,
                  :output_field_list

    # 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) service_id

The service identifier that contains the operations for this CLI command.

Returns:

  • (String) 


319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/cli.rb', line 319

class Info < 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.info',
                {
                    'identity' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Metadata::Cli::Command::Identity'),
                    'description' => VAPI::Bindings::StringType.instance,
                    'service_id' => VAPI::Bindings::IdType.new(resource_types='com.vmware.vapi.service'),
                    'operation_id' => VAPI::Bindings::IdType.new(resource_types='com.vmware.vapi.operation'),
                    'options' => VAPI::Bindings::ListType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Metadata::Cli::Command::OptionInfo')),
                    'formatter' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Metadata::Cli::Command::FormatterType')),
                    'output_field_list' => VAPI::Bindings::ListType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Metadata::Cli::Command::OutputInfo')),
                },
                Info,
                false,
                nil)
        end
    end

    attr_accessor :identity,
                  :description,
                  :service_id,
                  :operation_id,
                  :options,
                  :formatter,
                  :output_field_list

    # 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 



325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/cli.rb', line 325

def binding_type
    @binding_type ||= VAPI::Bindings::StructType.new(
        'com.vmware.vapi.metadata.cli.command.info',
        {
            'identity' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Metadata::Cli::Command::Identity'),
            'description' => VAPI::Bindings::StringType.instance,
            'service_id' => VAPI::Bindings::IdType.new(resource_types='com.vmware.vapi.service'),
            'operation_id' => VAPI::Bindings::IdType.new(resource_types='com.vmware.vapi.operation'),
            'options' => VAPI::Bindings::ListType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Metadata::Cli::Command::OptionInfo')),
            'formatter' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Metadata::Cli::Command::FormatterType')),
            'output_field_list' => VAPI::Bindings::ListType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Metadata::Cli::Command::OutputInfo')),
        },
        Info,
        false,
        nil)
end