Class List Method List File List

# Class: Com::Vmware::Vcenter::Ovf::OvfMessage::Category

Inherits:
  VAPI::Bindings::VapiEnum
  - Object
  - VAPI::Bindings::VapiEnum
  - Com::Vmware::Vcenter::Ovf::OvfMessage::Category
  show all
Defined in:
  /build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb

## Overview

The ``Com::Vmware::Vcenter::Ovf::OvfMessage::Category`` enumerated type defines the categories of messages (see :class:`Com::Vmware::Vcenter::Ovf::OvfMessage` ).

## Constant Summary

VALIDATION =

      Category.new('VALIDATION')

INPUT =

      Category.new('INPUT')

SERVER =

      Category.new('SERVER')

## Instance Attribute Summary (collapse)

- - (Com::Vmware::Vcenter::Ovf::OvfMessage::Category) input

  The user provided input parameters are invalid.

- - (Com::Vmware::Vcenter::Ovf::OvfMessage::Category) server

  Server error.

- - (Com::Vmware::Vcenter::Ovf::OvfMessage::Category) validation

  The OVF descriptor is invalid, for example, syntax errors or schema errors.

## 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::Vcenter::Ovf::OvfMessage::Category`) input

The user provided input parameters are invalid.

Returns:

- (`Com::Vmware::Vcenter::Ovf::OvfMessage::Category`)

    1624
    1625
    1626
    1627
    1628
    1629
    1630
    1631
    1632
    1633
    1634
    1635
    1636
    1637
    1638
    1639
    1640
    1641
    1642
    1643
    1644
    1645
    1646
    1647
    1648
    1649
    1650
    1651
    1652
    1653
    1654
    1655
    1656
    1657
    1658
    1659
    1660
    1661
    1662
    1663
    1664
    1665
    1666
    1667
    1668
    1669
    1670
    1671
    1672
    1673
    1674
    1675
    1676
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 1624

    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.vcenter.ovf.ovf_message.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] validation
        #     @return [Com::Vmware::Vcenter::Ovf::OvfMessage::Category]
        #     The OVF descriptor is invalid, for example, syntax errors or schema errors.
        VALIDATION = Category.new('VALIDATION')

        # @!attribute [rw] input
        #     @return [Com::Vmware::Vcenter::Ovf::OvfMessage::Category]
        #     The user provided input parameters are invalid.
        INPUT = Category.new('INPUT')

        # @!attribute [rw] server
        #     @return [Com::Vmware::Vcenter::Ovf::OvfMessage::Category]
        #     Server error.
        SERVER = Category.new('SERVER')

    end

### - (`Com::Vmware::Vcenter::Ovf::OvfMessage::Category`) server

Server error.

Returns:

- (`Com::Vmware::Vcenter::Ovf::OvfMessage::Category`)

    1624
    1625
    1626
    1627
    1628
    1629
    1630
    1631
    1632
    1633
    1634
    1635
    1636
    1637
    1638
    1639
    1640
    1641
    1642
    1643
    1644
    1645
    1646
    1647
    1648
    1649
    1650
    1651
    1652
    1653
    1654
    1655
    1656
    1657
    1658
    1659
    1660
    1661
    1662
    1663
    1664
    1665
    1666
    1667
    1668
    1669
    1670
    1671
    1672
    1673
    1674
    1675
    1676
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 1624

    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.vcenter.ovf.ovf_message.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] validation
        #     @return [Com::Vmware::Vcenter::Ovf::OvfMessage::Category]
        #     The OVF descriptor is invalid, for example, syntax errors or schema errors.
        VALIDATION = Category.new('VALIDATION')

        # @!attribute [rw] input
        #     @return [Com::Vmware::Vcenter::Ovf::OvfMessage::Category]
        #     The user provided input parameters are invalid.
        INPUT = Category.new('INPUT')

        # @!attribute [rw] server
        #     @return [Com::Vmware::Vcenter::Ovf::OvfMessage::Category]
        #     Server error.
        SERVER = Category.new('SERVER')

    end

### - (`Com::Vmware::Vcenter::Ovf::OvfMessage::Category`) validation

The OVF descriptor is invalid, for example, syntax errors or schema errors.

Returns:

- (`Com::Vmware::Vcenter::Ovf::OvfMessage::Category`)

    1624
    1625
    1626
    1627
    1628
    1629
    1630
    1631
    1632
    1633
    1634
    1635
    1636
    1637
    1638
    1639
    1640
    1641
    1642
    1643
    1644
    1645
    1646
    1647
    1648
    1649
    1650
    1651
    1652
    1653
    1654
    1655
    1656
    1657
    1658
    1659
    1660
    1661
    1662
    1663
    1664
    1665
    1666
    1667
    1668
    1669
    1670
    1671
    1672
    1673
    1674
    1675
    1676
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 1624

    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.vcenter.ovf.ovf_message.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] validation
        #     @return [Com::Vmware::Vcenter::Ovf::OvfMessage::Category]
        #     The OVF descriptor is invalid, for example, syntax errors or schema errors.
        VALIDATION = Category.new('VALIDATION')

        # @!attribute [rw] input
        #     @return [Com::Vmware::Vcenter::Ovf::OvfMessage::Category]
        #     The user provided input parameters are invalid.
        INPUT = Category.new('INPUT')

        # @!attribute [rw] server
        #     @return [Com::Vmware::Vcenter::Ovf::OvfMessage::Category]
        #     Server error.
        SERVER = Category.new('SERVER')

    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

    1630
    1631
    1632
    1633
    1634
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 1630

    def binding_type
        @binding_type ||= VAPI::Bindings::EnumType.new(
            'com.vmware.vcenter.ovf.ovf_message.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

    1641
    1642
    1643
    1644
    1645
    1646
    1647
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 1641

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