Class List Method List File List

# Class: Com::Vmware::Vapi::Metadata::Metamodel::Type::Category

Inherits:
  VAPI::Bindings::VapiEnum
  - Object
  - VAPI::Bindings::VapiEnum
  - Com::Vmware::Vapi::Metadata::Metamodel::Type::Category
  show all
Defined in:
  /build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/metamodel.rb

## Overview

The ``Com::Vmware::Vapi::Metadata::Metamodel::Type::Category`` enumerated type provides enumeration value for each category of the type.

## Constant Summary

BUILTIN =

      Category.new('BUILTIN')

USER_DEFINED =

      Category.new('USER_DEFINED')

GENERIC =

      Category.new('GENERIC')

## Instance Attribute Summary (collapse)

- - (Com::Vmware::Vapi::Metadata::Metamodel::Type::Category) builtin

  The type is one of the built-in types specified in :class:`Com::Vmware::Vapi::Metadata::Metamodel::Type::BuiltinType`.

- - (Com::Vmware::Vapi::Metadata::Metamodel::Type::Category) generic

  The type is an instantiation of one of the generic types.

- - (Com::Vmware::Vapi::Metadata::Metamodel::Type::Category) user_defined

  The type is one of the user defined named types.

## Class Method Summary (collapse)

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

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

- + (Category) from_string(value)

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

## Instance Attribute Details

### - (`Com::Vmware::Vapi::Metadata::Metamodel::Type::Category`) builtin

The type is one of the built-in types specified in :class:`Com::Vmware::Vapi::Metadata::Metamodel::Type::BuiltinType`

Returns:

- (`Com::Vmware::Vapi::Metadata::Metamodel::Type::Category`)

    2134
    2135
    2136
    2137
    2138
    2139
    2140
    2141
    2142
    2143
    2144
    2145
    2146
    2147
    2148
    2149
    2150
    2151
    2152
    2153
    2154
    2155
    2156
    2157
    2158
    2159
    2160
    2161
    2162
    2163
    2164
    2165
    2166
    2167
    2168
    2169
    2170
    2171
    2172
    2173
    2174
    2175
    2176
    2177
    2178
    2179
    2180
    2181
    2182
    2183
    2184
    2185
    2186
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/metamodel.rb', line 2134

    class Category < 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.metamodel.type.category',
                    Category)
            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 [Category] 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
                    Category.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] builtin
        #     @return [Com::Vmware::Vapi::Metadata::Metamodel::Type::Category]
        #     The type is one of the built-in types specified in   :class:`Com::Vmware::Vapi::Metadata::Metamodel::Type::BuiltinType`
        BUILTIN = Category.new('BUILTIN')

        # @!attribute [rw] user_defined
        #     @return [Com::Vmware::Vapi::Metadata::Metamodel::Type::Category]
        #     The type is one of the user defined named types.
        USER_DEFINED = Category.new('USER_DEFINED')

        # @!attribute [rw] generic
        #     @return [Com::Vmware::Vapi::Metadata::Metamodel::Type::Category]
        #     The type is an instantiation of one of the generic types.
        GENERIC = Category.new('GENERIC')

    end

### - (`Com::Vmware::Vapi::Metadata::Metamodel::Type::Category`) generic

The type is an instantiation of one of the generic types.

Returns:

- (`Com::Vmware::Vapi::Metadata::Metamodel::Type::Category`)

    2134
    2135
    2136
    2137
    2138
    2139
    2140
    2141
    2142
    2143
    2144
    2145
    2146
    2147
    2148
    2149
    2150
    2151
    2152
    2153
    2154
    2155
    2156
    2157
    2158
    2159
    2160
    2161
    2162
    2163
    2164
    2165
    2166
    2167
    2168
    2169
    2170
    2171
    2172
    2173
    2174
    2175
    2176
    2177
    2178
    2179
    2180
    2181
    2182
    2183
    2184
    2185
    2186
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/metamodel.rb', line 2134

    class Category < 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.metamodel.type.category',
                    Category)
            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 [Category] 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
                    Category.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] builtin
        #     @return [Com::Vmware::Vapi::Metadata::Metamodel::Type::Category]
        #     The type is one of the built-in types specified in   :class:`Com::Vmware::Vapi::Metadata::Metamodel::Type::BuiltinType`
        BUILTIN = Category.new('BUILTIN')

        # @!attribute [rw] user_defined
        #     @return [Com::Vmware::Vapi::Metadata::Metamodel::Type::Category]
        #     The type is one of the user defined named types.
        USER_DEFINED = Category.new('USER_DEFINED')

        # @!attribute [rw] generic
        #     @return [Com::Vmware::Vapi::Metadata::Metamodel::Type::Category]
        #     The type is an instantiation of one of the generic types.
        GENERIC = Category.new('GENERIC')

    end

### - (`Com::Vmware::Vapi::Metadata::Metamodel::Type::Category`) user_defined

The type is one of the user defined named types.

Returns:

- (`Com::Vmware::Vapi::Metadata::Metamodel::Type::Category`)

    2134
    2135
    2136
    2137
    2138
    2139
    2140
    2141
    2142
    2143
    2144
    2145
    2146
    2147
    2148
    2149
    2150
    2151
    2152
    2153
    2154
    2155
    2156
    2157
    2158
    2159
    2160
    2161
    2162
    2163
    2164
    2165
    2166
    2167
    2168
    2169
    2170
    2171
    2172
    2173
    2174
    2175
    2176
    2177
    2178
    2179
    2180
    2181
    2182
    2183
    2184
    2185
    2186
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/metamodel.rb', line 2134

    class Category < 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.metamodel.type.category',
                    Category)
            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 [Category] 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
                    Category.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] builtin
        #     @return [Com::Vmware::Vapi::Metadata::Metamodel::Type::Category]
        #     The type is one of the built-in types specified in   :class:`Com::Vmware::Vapi::Metadata::Metamodel::Type::BuiltinType`
        BUILTIN = Category.new('BUILTIN')

        # @!attribute [rw] user_defined
        #     @return [Com::Vmware::Vapi::Metadata::Metamodel::Type::Category]
        #     The type is one of the user defined named types.
        USER_DEFINED = Category.new('USER_DEFINED')

        # @!attribute [rw] generic
        #     @return [Com::Vmware::Vapi::Metadata::Metamodel::Type::Category]
        #     The type is an instantiation of one of the generic types.
        GENERIC = Category.new('GENERIC')

    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

    2140
    2141
    2142
    2143
    2144
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/metamodel.rb', line 2140

    def binding_type
        @binding_type ||= VAPI::Bindings::EnumType.new(
            'com.vmware.vapi.metadata.metamodel.type.category',
            Category)
    end

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

- (`Category`) —

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

    2151
    2152
    2153
    2154
    2155
    2156
    2157
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/metamodel.rb', line 2151

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