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

Inherits:
VAPI::Bindings::VapiEnum
  • 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::FormatterType`` enumerated type defines supported CLI output formatter types. See :attr:`Com::Vmware::Vapi::Metadata::Cli::Command::Info.formatter` .

Constant Summary

SIMPLE = 
FormatterType.new('SIMPLE')
TABLE = 
FormatterType.new('TABLE')
JSON = 
FormatterType.new('JSON')
XML = 
FormatterType.new('XML')
CSV = 
FormatterType.new('CSV')
HTML = 
FormatterType.new('HTML')

Instance Attribute Summary (collapse)

Class Method Summary (collapse)

Instance Attribute Details

- (Com::Vmware::Vapi::Metadata::Cli::Command::FormatterType) csv

Displays command output in CSV format.

Returns:



380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/cli.rb', line 380

class FormatterType < VAPI::Bindings::VapiEnum

    class << self
        # Holds (gets or creates) the binding type metadata for this enumeration type.
        # @scope class
        # @return [VAPI::Bindings::EnumType] the binding type
        def binding_type
            @binding_type ||= VAPI::Bindings::EnumType.new(
                'com.vmware.vapi.metadata.cli.command.formatter_type',
                FormatterType)
        end

        # Converts from a string value (perhaps off the wire) to an instance
        # of this enum type.
        # @param value [String] the actual value of the enum instance
        # @return [FormatterType] the instance found for the value, otherwise
        #         an unknown instance will be built for the value
        def from_string(value)
            begin
                const_get(value)
            rescue NameError
                FormatterType.new('UNKNOWN', value)
            end
        end
    end

    private

    # Constructs a new instance.
    # @param value [String] the actual value of the enum instance
    # @param unknown [String] the unknown value when value is 'UKNOWN'
    def initialize(value, unknown=nil)
        super(self.class.binding_type, value, unknown)
    end

    public

    # @!attribute [rw] simple
    #     @return [Com::Vmware::Vapi::Metadata::Cli::Command::FormatterType]
    #     Displays command output as it is.
    SIMPLE = FormatterType.new('SIMPLE')

    # @!attribute [rw] table
    #     @return [Com::Vmware::Vapi::Metadata::Cli::Command::FormatterType]
    #     Displays command output in table format.
    TABLE = FormatterType.new('TABLE')

    # @!attribute [rw] json
    #     @return [Com::Vmware::Vapi::Metadata::Cli::Command::FormatterType]
    #     Displays command output in JSON format.
    JSON = FormatterType.new('JSON')

    # @!attribute [rw] xml
    #     @return [Com::Vmware::Vapi::Metadata::Cli::Command::FormatterType]
    #     Displays command output in XML format.
    XML = FormatterType.new('XML')

    # @!attribute [rw] csv
    #     @return [Com::Vmware::Vapi::Metadata::Cli::Command::FormatterType]
    #     Displays command output in CSV format.
    CSV = FormatterType.new('CSV')

    # @!attribute [rw] html
    #     @return [Com::Vmware::Vapi::Metadata::Cli::Command::FormatterType]
    #     Displays command output in HTML format.
    HTML = FormatterType.new('HTML')

end

- (Com::Vmware::Vapi::Metadata::Cli::Command::FormatterType) html

Displays command output in HTML format.

Returns:



380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/cli.rb', line 380

class FormatterType < VAPI::Bindings::VapiEnum

    class << self
        # Holds (gets or creates) the binding type metadata for this enumeration type.
        # @scope class
        # @return [VAPI::Bindings::EnumType] the binding type
        def binding_type
            @binding_type ||= VAPI::Bindings::EnumType.new(
                'com.vmware.vapi.metadata.cli.command.formatter_type',
                FormatterType)
        end

        # Converts from a string value (perhaps off the wire) to an instance
        # of this enum type.
        # @param value [String] the actual value of the enum instance
        # @return [FormatterType] the instance found for the value, otherwise
        #         an unknown instance will be built for the value
        def from_string(value)
            begin
                const_get(value)
            rescue NameError
                FormatterType.new('UNKNOWN', value)
            end
        end
    end

    private

    # Constructs a new instance.
    # @param value [String] the actual value of the enum instance
    # @param unknown [String] the unknown value when value is 'UKNOWN'
    def initialize(value, unknown=nil)
        super(self.class.binding_type, value, unknown)
    end

    public

    # @!attribute [rw] simple
    #     @return [Com::Vmware::Vapi::Metadata::Cli::Command::FormatterType]
    #     Displays command output as it is.
    SIMPLE = FormatterType.new('SIMPLE')

    # @!attribute [rw] table
    #     @return [Com::Vmware::Vapi::Metadata::Cli::Command::FormatterType]
    #     Displays command output in table format.
    TABLE = FormatterType.new('TABLE')

    # @!attribute [rw] json
    #     @return [Com::Vmware::Vapi::Metadata::Cli::Command::FormatterType]
    #     Displays command output in JSON format.
    JSON = FormatterType.new('JSON')

    # @!attribute [rw] xml
    #     @return [Com::Vmware::Vapi::Metadata::Cli::Command::FormatterType]
    #     Displays command output in XML format.
    XML = FormatterType.new('XML')

    # @!attribute [rw] csv
    #     @return [Com::Vmware::Vapi::Metadata::Cli::Command::FormatterType]
    #     Displays command output in CSV format.
    CSV = FormatterType.new('CSV')

    # @!attribute [rw] html
    #     @return [Com::Vmware::Vapi::Metadata::Cli::Command::FormatterType]
    #     Displays command output in HTML format.
    HTML = FormatterType.new('HTML')

end

- (Com::Vmware::Vapi::Metadata::Cli::Command::FormatterType) json

Displays command output in JSON format.

Returns:



380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/cli.rb', line 380

class FormatterType < VAPI::Bindings::VapiEnum

    class << self
        # Holds (gets or creates) the binding type metadata for this enumeration type.
        # @scope class
        # @return [VAPI::Bindings::EnumType] the binding type
        def binding_type
            @binding_type ||= VAPI::Bindings::EnumType.new(
                'com.vmware.vapi.metadata.cli.command.formatter_type',
                FormatterType)
        end

        # Converts from a string value (perhaps off the wire) to an instance
        # of this enum type.
        # @param value [String] the actual value of the enum instance
        # @return [FormatterType] the instance found for the value, otherwise
        #         an unknown instance will be built for the value
        def from_string(value)
            begin
                const_get(value)
            rescue NameError
                FormatterType.new('UNKNOWN', value)
            end
        end
    end

    private

    # Constructs a new instance.
    # @param value [String] the actual value of the enum instance
    # @param unknown [String] the unknown value when value is 'UKNOWN'
    def initialize(value, unknown=nil)
        super(self.class.binding_type, value, unknown)
    end

    public

    # @!attribute [rw] simple
    #     @return [Com::Vmware::Vapi::Metadata::Cli::Command::FormatterType]
    #     Displays command output as it is.
    SIMPLE = FormatterType.new('SIMPLE')

    # @!attribute [rw] table
    #     @return [Com::Vmware::Vapi::Metadata::Cli::Command::FormatterType]
    #     Displays command output in table format.
    TABLE = FormatterType.new('TABLE')

    # @!attribute [rw] json
    #     @return [Com::Vmware::Vapi::Metadata::Cli::Command::FormatterType]
    #     Displays command output in JSON format.
    JSON = FormatterType.new('JSON')

    # @!attribute [rw] xml
    #     @return [Com::Vmware::Vapi::Metadata::Cli::Command::FormatterType]
    #     Displays command output in XML format.
    XML = FormatterType.new('XML')

    # @!attribute [rw] csv
    #     @return [Com::Vmware::Vapi::Metadata::Cli::Command::FormatterType]
    #     Displays command output in CSV format.
    CSV = FormatterType.new('CSV')

    # @!attribute [rw] html
    #     @return [Com::Vmware::Vapi::Metadata::Cli::Command::FormatterType]
    #     Displays command output in HTML format.
    HTML = FormatterType.new('HTML')

end

- (Com::Vmware::Vapi::Metadata::Cli::Command::FormatterType) simple

Displays command output as it is.

Returns:



380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/cli.rb', line 380

class FormatterType < VAPI::Bindings::VapiEnum

    class << self
        # Holds (gets or creates) the binding type metadata for this enumeration type.
        # @scope class
        # @return [VAPI::Bindings::EnumType] the binding type
        def binding_type
            @binding_type ||= VAPI::Bindings::EnumType.new(
                'com.vmware.vapi.metadata.cli.command.formatter_type',
                FormatterType)
        end

        # Converts from a string value (perhaps off the wire) to an instance
        # of this enum type.
        # @param value [String] the actual value of the enum instance
        # @return [FormatterType] the instance found for the value, otherwise
        #         an unknown instance will be built for the value
        def from_string(value)
            begin
                const_get(value)
            rescue NameError
                FormatterType.new('UNKNOWN', value)
            end
        end
    end

    private

    # Constructs a new instance.
    # @param value [String] the actual value of the enum instance
    # @param unknown [String] the unknown value when value is 'UKNOWN'
    def initialize(value, unknown=nil)
        super(self.class.binding_type, value, unknown)
    end

    public

    # @!attribute [rw] simple
    #     @return [Com::Vmware::Vapi::Metadata::Cli::Command::FormatterType]
    #     Displays command output as it is.
    SIMPLE = FormatterType.new('SIMPLE')

    # @!attribute [rw] table
    #     @return [Com::Vmware::Vapi::Metadata::Cli::Command::FormatterType]
    #     Displays command output in table format.
    TABLE = FormatterType.new('TABLE')

    # @!attribute [rw] json
    #     @return [Com::Vmware::Vapi::Metadata::Cli::Command::FormatterType]
    #     Displays command output in JSON format.
    JSON = FormatterType.new('JSON')

    # @!attribute [rw] xml
    #     @return [Com::Vmware::Vapi::Metadata::Cli::Command::FormatterType]
    #     Displays command output in XML format.
    XML = FormatterType.new('XML')

    # @!attribute [rw] csv
    #     @return [Com::Vmware::Vapi::Metadata::Cli::Command::FormatterType]
    #     Displays command output in CSV format.
    CSV = FormatterType.new('CSV')

    # @!attribute [rw] html
    #     @return [Com::Vmware::Vapi::Metadata::Cli::Command::FormatterType]
    #     Displays command output in HTML format.
    HTML = FormatterType.new('HTML')

end

- (Com::Vmware::Vapi::Metadata::Cli::Command::FormatterType) table

Displays command output in table format.

Returns:



380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/cli.rb', line 380

class FormatterType < VAPI::Bindings::VapiEnum

    class << self
        # Holds (gets or creates) the binding type metadata for this enumeration type.
        # @scope class
        # @return [VAPI::Bindings::EnumType] the binding type
        def binding_type
            @binding_type ||= VAPI::Bindings::EnumType.new(
                'com.vmware.vapi.metadata.cli.command.formatter_type',
                FormatterType)
        end

        # Converts from a string value (perhaps off the wire) to an instance
        # of this enum type.
        # @param value [String] the actual value of the enum instance
        # @return [FormatterType] the instance found for the value, otherwise
        #         an unknown instance will be built for the value
        def from_string(value)
            begin
                const_get(value)
            rescue NameError
                FormatterType.new('UNKNOWN', value)
            end
        end
    end

    private

    # Constructs a new instance.
    # @param value [String] the actual value of the enum instance
    # @param unknown [String] the unknown value when value is 'UKNOWN'
    def initialize(value, unknown=nil)
        super(self.class.binding_type, value, unknown)
    end

    public

    # @!attribute [rw] simple
    #     @return [Com::Vmware::Vapi::Metadata::Cli::Command::FormatterType]
    #     Displays command output as it is.
    SIMPLE = FormatterType.new('SIMPLE')

    # @!attribute [rw] table
    #     @return [Com::Vmware::Vapi::Metadata::Cli::Command::FormatterType]
    #     Displays command output in table format.
    TABLE = FormatterType.new('TABLE')

    # @!attribute [rw] json
    #     @return [Com::Vmware::Vapi::Metadata::Cli::Command::FormatterType]
    #     Displays command output in JSON format.
    JSON = FormatterType.new('JSON')

    # @!attribute [rw] xml
    #     @return [Com::Vmware::Vapi::Metadata::Cli::Command::FormatterType]
    #     Displays command output in XML format.
    XML = FormatterType.new('XML')

    # @!attribute [rw] csv
    #     @return [Com::Vmware::Vapi::Metadata::Cli::Command::FormatterType]
    #     Displays command output in CSV format.
    CSV = FormatterType.new('CSV')

    # @!attribute [rw] html
    #     @return [Com::Vmware::Vapi::Metadata::Cli::Command::FormatterType]
    #     Displays command output in HTML format.
    HTML = FormatterType.new('HTML')

end

- (Com::Vmware::Vapi::Metadata::Cli::Command::FormatterType) xml

Displays command output in XML format.

Returns:



380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/cli.rb', line 380

class FormatterType < VAPI::Bindings::VapiEnum

    class << self
        # Holds (gets or creates) the binding type metadata for this enumeration type.
        # @scope class
        # @return [VAPI::Bindings::EnumType] the binding type
        def binding_type
            @binding_type ||= VAPI::Bindings::EnumType.new(
                'com.vmware.vapi.metadata.cli.command.formatter_type',
                FormatterType)
        end

        # Converts from a string value (perhaps off the wire) to an instance
        # of this enum type.
        # @param value [String] the actual value of the enum instance
        # @return [FormatterType] the instance found for the value, otherwise
        #         an unknown instance will be built for the value
        def from_string(value)
            begin
                const_get(value)
            rescue NameError
                FormatterType.new('UNKNOWN', value)
            end
        end
    end

    private

    # Constructs a new instance.
    # @param value [String] the actual value of the enum instance
    # @param unknown [String] the unknown value when value is 'UKNOWN'
    def initialize(value, unknown=nil)
        super(self.class.binding_type, value, unknown)
    end

    public

    # @!attribute [rw] simple
    #     @return [Com::Vmware::Vapi::Metadata::Cli::Command::FormatterType]
    #     Displays command output as it is.
    SIMPLE = FormatterType.new('SIMPLE')

    # @!attribute [rw] table
    #     @return [Com::Vmware::Vapi::Metadata::Cli::Command::FormatterType]
    #     Displays command output in table format.
    TABLE = FormatterType.new('TABLE')

    # @!attribute [rw] json
    #     @return [Com::Vmware::Vapi::Metadata::Cli::Command::FormatterType]
    #     Displays command output in JSON format.
    JSON = FormatterType.new('JSON')

    # @!attribute [rw] xml
    #     @return [Com::Vmware::Vapi::Metadata::Cli::Command::FormatterType]
    #     Displays command output in XML format.
    XML = FormatterType.new('XML')

    # @!attribute [rw] csv
    #     @return [Com::Vmware::Vapi::Metadata::Cli::Command::FormatterType]
    #     Displays command output in CSV format.
    CSV = FormatterType.new('CSV')

    # @!attribute [rw] html
    #     @return [Com::Vmware::Vapi::Metadata::Cli::Command::FormatterType]
    #     Displays command output in HTML format.
    HTML = FormatterType.new('HTML')

end

Class Method Details

+ (VAPI::Bindings::EnumType) binding_type

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

Returns:

  • (VAPI::Bindings::EnumType) —

    the binding type 



386
387
388
389
390
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/cli.rb', line 386

def binding_type
    @binding_type ||= VAPI::Bindings::EnumType.new(
        'com.vmware.vapi.metadata.cli.command.formatter_type',
        FormatterType)
end

+ (FormatterType) from_string(value)

Converts from a string value (perhaps off the wire) to an instance of this enum type.

Parameters:

  • value (String) —

    the actual value of the enum instance

Returns:

  • (FormatterType) —

    the instance found for the value, otherwise an unknown instance will be built for the value 



397
398
399
400
401
402
403
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/cli.rb', line 397

def from_string(value)
    begin
        const_get(value)
    rescue NameError
        FormatterType.new('UNKNOWN', value)
    end
end