Class List Method List File List

# Class: Com::Vmware::Appliance::Monitoring::FunctionType

Inherits:
  VAPI::Bindings::VapiEnum
  - Object
  - VAPI::Bindings::VapiEnum
  - Com::Vmware::Appliance::Monitoring::FunctionType
  show all
Defined in:
  /build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance.rb

## Overview

``Com::Vmware::Appliance::Monitoring::FunctionType`` enumerated type Defines aggregation function

## Constant Summary

COUNT =

      FunctionType.new('COUNT')

MAX =

      FunctionType.new('MAX')

AVG =

      FunctionType.new('AVG')

MIN =

      FunctionType.new('MIN')

## Instance Attribute Summary (collapse)

- - (Com::Vmware::Appliance::Monitoring::FunctionType) avg

  Aggregation takes average per period.

- - (Com::Vmware::Appliance::Monitoring::FunctionType) count

  Aggregation takes count per period (sum).

- - (Com::Vmware::Appliance::Monitoring::FunctionType) max

  Aggregation takes maximums per period.

- - (Com::Vmware::Appliance::Monitoring::FunctionType) min

  Aggregation takes minimums per period.

## Class Method Summary (collapse)

- + (VAPI::Bindings::EnumType) binding_type

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

- + (FunctionType) from_string(value)

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

## Instance Attribute Details

### - (`Com::Vmware::Appliance::Monitoring::FunctionType`) avg

Aggregation takes average per period

Returns:

- (`Com::Vmware::Appliance::Monitoring::FunctionType`)

    303
    304
    305
    306
    307
    308
    309
    310
    311
    312
    313
    314
    315
    316
    317
    318
    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
    358
    359
    360
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance.rb', line 303

    class FunctionType < 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.appliance.monitoring.function_type',
                    FunctionType)
            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 [FunctionType] 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
                    FunctionType.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] count
        #     @return [Com::Vmware::Appliance::Monitoring::FunctionType]
        #     Aggregation takes count per period (sum)
        COUNT = FunctionType.new('COUNT')

        # @!attribute [rw] max
        #     @return [Com::Vmware::Appliance::Monitoring::FunctionType]
        #     Aggregation takes maximums per period
        MAX = FunctionType.new('MAX')

        # @!attribute [rw] avg
        #     @return [Com::Vmware::Appliance::Monitoring::FunctionType]
        #     Aggregation takes average per period
        AVG = FunctionType.new('AVG')

        # @!attribute [rw] min
        #     @return [Com::Vmware::Appliance::Monitoring::FunctionType]
        #     Aggregation takes minimums per period
        MIN = FunctionType.new('MIN')

    end

### - (`Com::Vmware::Appliance::Monitoring::FunctionType`) count

Aggregation takes count per period (sum)

Returns:

- (`Com::Vmware::Appliance::Monitoring::FunctionType`)

    303
    304
    305
    306
    307
    308
    309
    310
    311
    312
    313
    314
    315
    316
    317
    318
    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
    358
    359
    360
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance.rb', line 303

    class FunctionType < 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.appliance.monitoring.function_type',
                    FunctionType)
            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 [FunctionType] 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
                    FunctionType.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] count
        #     @return [Com::Vmware::Appliance::Monitoring::FunctionType]
        #     Aggregation takes count per period (sum)
        COUNT = FunctionType.new('COUNT')

        # @!attribute [rw] max
        #     @return [Com::Vmware::Appliance::Monitoring::FunctionType]
        #     Aggregation takes maximums per period
        MAX = FunctionType.new('MAX')

        # @!attribute [rw] avg
        #     @return [Com::Vmware::Appliance::Monitoring::FunctionType]
        #     Aggregation takes average per period
        AVG = FunctionType.new('AVG')

        # @!attribute [rw] min
        #     @return [Com::Vmware::Appliance::Monitoring::FunctionType]
        #     Aggregation takes minimums per period
        MIN = FunctionType.new('MIN')

    end

### - (`Com::Vmware::Appliance::Monitoring::FunctionType`) max

Aggregation takes maximums per period

Returns:

- (`Com::Vmware::Appliance::Monitoring::FunctionType`)

    303
    304
    305
    306
    307
    308
    309
    310
    311
    312
    313
    314
    315
    316
    317
    318
    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
    358
    359
    360
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance.rb', line 303

    class FunctionType < 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.appliance.monitoring.function_type',
                    FunctionType)
            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 [FunctionType] 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
                    FunctionType.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] count
        #     @return [Com::Vmware::Appliance::Monitoring::FunctionType]
        #     Aggregation takes count per period (sum)
        COUNT = FunctionType.new('COUNT')

        # @!attribute [rw] max
        #     @return [Com::Vmware::Appliance::Monitoring::FunctionType]
        #     Aggregation takes maximums per period
        MAX = FunctionType.new('MAX')

        # @!attribute [rw] avg
        #     @return [Com::Vmware::Appliance::Monitoring::FunctionType]
        #     Aggregation takes average per period
        AVG = FunctionType.new('AVG')

        # @!attribute [rw] min
        #     @return [Com::Vmware::Appliance::Monitoring::FunctionType]
        #     Aggregation takes minimums per period
        MIN = FunctionType.new('MIN')

    end

### - (`Com::Vmware::Appliance::Monitoring::FunctionType`) min

Aggregation takes minimums per period

Returns:

- (`Com::Vmware::Appliance::Monitoring::FunctionType`)

    303
    304
    305
    306
    307
    308
    309
    310
    311
    312
    313
    314
    315
    316
    317
    318
    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
    358
    359
    360
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance.rb', line 303

    class FunctionType < 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.appliance.monitoring.function_type',
                    FunctionType)
            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 [FunctionType] 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
                    FunctionType.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] count
        #     @return [Com::Vmware::Appliance::Monitoring::FunctionType]
        #     Aggregation takes count per period (sum)
        COUNT = FunctionType.new('COUNT')

        # @!attribute [rw] max
        #     @return [Com::Vmware::Appliance::Monitoring::FunctionType]
        #     Aggregation takes maximums per period
        MAX = FunctionType.new('MAX')

        # @!attribute [rw] avg
        #     @return [Com::Vmware::Appliance::Monitoring::FunctionType]
        #     Aggregation takes average per period
        AVG = FunctionType.new('AVG')

        # @!attribute [rw] min
        #     @return [Com::Vmware::Appliance::Monitoring::FunctionType]
        #     Aggregation takes minimums per period
        MIN = FunctionType.new('MIN')

    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

    309
    310
    311
    312
    313
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance.rb', line 309

    def binding_type
        @binding_type ||= VAPI::Bindings::EnumType.new(
            'com.vmware.appliance.monitoring.function_type',
            FunctionType)
    end

### + (`FunctionType`) 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:

- (`FunctionType`) —

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

    320
    321
    322
    323
    324
    325
    326
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance.rb', line 320

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