Class List Method List File List

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

Inherits:
  VAPI::Bindings::VapiStruct
  - Object
  - VAPI::Bindings::VapiStruct
  - Com::Vmware::Vcenter::Ovf::OvfMessage
  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`` class describes a base OVF handling error message related to accessing, validating, deploying, or exporting an OVF package.

     These messages fall into different categories defined in   :class:`Com::Vmware::Vcenter::Ovf::OvfMessage::Category`  :

## Defined Under Namespace

Classes: Category

## Instance Attribute Summary (collapse)

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

  The message category.

- - (VAPI::Bindings::VapiStruct) error

  Represents a server :class:`Com::Vmware::Vapi::Std::Errors::Error` .

- - (Array<Com::Vmware::Vcenter::Ovf::ParseIssue>) issues

  List of parse issues (see :class:`Com::Vmware::Vcenter::Ovf::ParseIssue` ).

- - (Com::Vmware::Vapi::Std::LocalizableMessage) message

  A localizable message.

- - (String) name

  The name of input parameter.

- - (String) value

  The value of input parameter.

## Class Method Summary (collapse)

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

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

## Instance Method Summary (collapse)

- - (OvfMessage) initialize(ruby_values = nil, struct_value = nil) constructor

  Constructs a new instance.

## Constructor Details

### - (`OvfMessage`) 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)

    1609
    1610
    1611
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 1609

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

## Instance Attribute Details

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

The message category.

Returns:

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

    1576
    1577
    1578
    1579
    1580
    1581
    1582
    1583
    1584
    1585
    1586
    1587
    1588
    1589
    1590
    1591
    1592
    1593
    1594
    1595
    1596
    1597
    1598
    1599
    1600
    1601
    1602
    1603
    1604
    1605
    1606
    1607
    1608
    1609
    1610
    1611
    1612
    1613
    1614
    1615
    1616
    1617
    1618
    1619
    1620
    1621
    1622
    1623
    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
    1677
    1678
    1679
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 1576

    class OvfMessage < 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.vcenter.ovf.ovf_message',
                    {
                        'category' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Ovf::OvfMessage::Category'),
                        'issues' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ListType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Ovf::ParseIssue'))),
                        'name' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'value' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'message' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Std::LocalizableMessage')),
                        'error' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::DynamicStructType.new([VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Std::Errors::Error')])),
                    },
                    OvfMessage,
                    false,
                    nil)
            end
        end

        attr_accessor :category,
                      :issues,
                      :name,
                      :value,
                      :message,
                      :error

        # 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

        # The  ``Com::Vmware::Vcenter::Ovf::OvfMessage::Category``   enumerated type  defines the categories of messages (see   :class:`Com::Vmware::Vcenter::Ovf::OvfMessage`  ).
        # @!attribute [rw] validation
        #     @return [Com::Vmware::Vcenter::Ovf::OvfMessage::Category]
        #     The OVF descriptor is invalid, for example, syntax errors or schema errors.
        # @!attribute [rw] input
        #     @return [Com::Vmware::Vcenter::Ovf::OvfMessage::Category]
        #     The user provided input parameters are invalid.
        # @!attribute [rw] server
        #     @return [Com::Vmware::Vcenter::Ovf::OvfMessage::Category]
        #     Server error.
        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

    end

### - (`VAPI::Bindings::VapiStruct`) error

Represents a server :class:`Com::Vmware::Vapi::Std::Errors::Error` . This field is optional and it is only relevant when the value of ``category`` is :attr:`Com::Vmware::Vcenter::Ovf::OvfMessage::Category.SERVER` .

Returns:

- (`VAPI::Bindings::VapiStruct`)

    1576
    1577
    1578
    1579
    1580
    1581
    1582
    1583
    1584
    1585
    1586
    1587
    1588
    1589
    1590
    1591
    1592
    1593
    1594
    1595
    1596
    1597
    1598
    1599
    1600
    1601
    1602
    1603
    1604
    1605
    1606
    1607
    1608
    1609
    1610
    1611
    1612
    1613
    1614
    1615
    1616
    1617
    1618
    1619
    1620
    1621
    1622
    1623
    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
    1677
    1678
    1679
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 1576

    class OvfMessage < 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.vcenter.ovf.ovf_message',
                    {
                        'category' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Ovf::OvfMessage::Category'),
                        'issues' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ListType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Ovf::ParseIssue'))),
                        'name' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'value' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'message' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Std::LocalizableMessage')),
                        'error' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::DynamicStructType.new([VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Std::Errors::Error')])),
                    },
                    OvfMessage,
                    false,
                    nil)
            end
        end

        attr_accessor :category,
                      :issues,
                      :name,
                      :value,
                      :message,
                      :error

        # 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

        # The  ``Com::Vmware::Vcenter::Ovf::OvfMessage::Category``   enumerated type  defines the categories of messages (see   :class:`Com::Vmware::Vcenter::Ovf::OvfMessage`  ).
        # @!attribute [rw] validation
        #     @return [Com::Vmware::Vcenter::Ovf::OvfMessage::Category]
        #     The OVF descriptor is invalid, for example, syntax errors or schema errors.
        # @!attribute [rw] input
        #     @return [Com::Vmware::Vcenter::Ovf::OvfMessage::Category]
        #     The user provided input parameters are invalid.
        # @!attribute [rw] server
        #     @return [Com::Vmware::Vcenter::Ovf::OvfMessage::Category]
        #     Server error.
        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

    end

### - (`Array<Com::Vmware::Vcenter::Ovf::ParseIssue>`) issues

List of parse issues (see :class:`Com::Vmware::Vcenter::Ovf::ParseIssue` ). This field is optional and it is only relevant when the value of ``category`` is :attr:`Com::Vmware::Vcenter::Ovf::OvfMessage::Category.VALIDATION` .

Returns:

- (`Array<Com::Vmware::Vcenter::Ovf::ParseIssue>`)

    1576
    1577
    1578
    1579
    1580
    1581
    1582
    1583
    1584
    1585
    1586
    1587
    1588
    1589
    1590
    1591
    1592
    1593
    1594
    1595
    1596
    1597
    1598
    1599
    1600
    1601
    1602
    1603
    1604
    1605
    1606
    1607
    1608
    1609
    1610
    1611
    1612
    1613
    1614
    1615
    1616
    1617
    1618
    1619
    1620
    1621
    1622
    1623
    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
    1677
    1678
    1679
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 1576

    class OvfMessage < 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.vcenter.ovf.ovf_message',
                    {
                        'category' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Ovf::OvfMessage::Category'),
                        'issues' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ListType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Ovf::ParseIssue'))),
                        'name' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'value' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'message' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Std::LocalizableMessage')),
                        'error' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::DynamicStructType.new([VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Std::Errors::Error')])),
                    },
                    OvfMessage,
                    false,
                    nil)
            end
        end

        attr_accessor :category,
                      :issues,
                      :name,
                      :value,
                      :message,
                      :error

        # 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

        # The  ``Com::Vmware::Vcenter::Ovf::OvfMessage::Category``   enumerated type  defines the categories of messages (see   :class:`Com::Vmware::Vcenter::Ovf::OvfMessage`  ).
        # @!attribute [rw] validation
        #     @return [Com::Vmware::Vcenter::Ovf::OvfMessage::Category]
        #     The OVF descriptor is invalid, for example, syntax errors or schema errors.
        # @!attribute [rw] input
        #     @return [Com::Vmware::Vcenter::Ovf::OvfMessage::Category]
        #     The user provided input parameters are invalid.
        # @!attribute [rw] server
        #     @return [Com::Vmware::Vcenter::Ovf::OvfMessage::Category]
        #     Server error.
        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

    end

### - (`Com::Vmware::Vapi::Std::LocalizableMessage`) message

A localizable message. This field is optional and it is only relevant when the value of ``category`` is :attr:`Com::Vmware::Vcenter::Ovf::OvfMessage::Category.INPUT` .

Returns:

- (`Com::Vmware::Vapi::Std::LocalizableMessage`)

    1576
    1577
    1578
    1579
    1580
    1581
    1582
    1583
    1584
    1585
    1586
    1587
    1588
    1589
    1590
    1591
    1592
    1593
    1594
    1595
    1596
    1597
    1598
    1599
    1600
    1601
    1602
    1603
    1604
    1605
    1606
    1607
    1608
    1609
    1610
    1611
    1612
    1613
    1614
    1615
    1616
    1617
    1618
    1619
    1620
    1621
    1622
    1623
    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
    1677
    1678
    1679
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 1576

    class OvfMessage < 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.vcenter.ovf.ovf_message',
                    {
                        'category' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Ovf::OvfMessage::Category'),
                        'issues' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ListType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Ovf::ParseIssue'))),
                        'name' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'value' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'message' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Std::LocalizableMessage')),
                        'error' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::DynamicStructType.new([VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Std::Errors::Error')])),
                    },
                    OvfMessage,
                    false,
                    nil)
            end
        end

        attr_accessor :category,
                      :issues,
                      :name,
                      :value,
                      :message,
                      :error

        # 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

        # The  ``Com::Vmware::Vcenter::Ovf::OvfMessage::Category``   enumerated type  defines the categories of messages (see   :class:`Com::Vmware::Vcenter::Ovf::OvfMessage`  ).
        # @!attribute [rw] validation
        #     @return [Com::Vmware::Vcenter::Ovf::OvfMessage::Category]
        #     The OVF descriptor is invalid, for example, syntax errors or schema errors.
        # @!attribute [rw] input
        #     @return [Com::Vmware::Vcenter::Ovf::OvfMessage::Category]
        #     The user provided input parameters are invalid.
        # @!attribute [rw] server
        #     @return [Com::Vmware::Vcenter::Ovf::OvfMessage::Category]
        #     Server error.
        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

    end

### - (`String`) name

The name of input parameter. This field is optional and it is only relevant when the value of ``category`` is :attr:`Com::Vmware::Vcenter::Ovf::OvfMessage::Category.INPUT` .

Returns:

- (`String`)

    1576
    1577
    1578
    1579
    1580
    1581
    1582
    1583
    1584
    1585
    1586
    1587
    1588
    1589
    1590
    1591
    1592
    1593
    1594
    1595
    1596
    1597
    1598
    1599
    1600
    1601
    1602
    1603
    1604
    1605
    1606
    1607
    1608
    1609
    1610
    1611
    1612
    1613
    1614
    1615
    1616
    1617
    1618
    1619
    1620
    1621
    1622
    1623
    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
    1677
    1678
    1679
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 1576

    class OvfMessage < 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.vcenter.ovf.ovf_message',
                    {
                        'category' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Ovf::OvfMessage::Category'),
                        'issues' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ListType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Ovf::ParseIssue'))),
                        'name' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'value' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'message' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Std::LocalizableMessage')),
                        'error' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::DynamicStructType.new([VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Std::Errors::Error')])),
                    },
                    OvfMessage,
                    false,
                    nil)
            end
        end

        attr_accessor :category,
                      :issues,
                      :name,
                      :value,
                      :message,
                      :error

        # 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

        # The  ``Com::Vmware::Vcenter::Ovf::OvfMessage::Category``   enumerated type  defines the categories of messages (see   :class:`Com::Vmware::Vcenter::Ovf::OvfMessage`  ).
        # @!attribute [rw] validation
        #     @return [Com::Vmware::Vcenter::Ovf::OvfMessage::Category]
        #     The OVF descriptor is invalid, for example, syntax errors or schema errors.
        # @!attribute [rw] input
        #     @return [Com::Vmware::Vcenter::Ovf::OvfMessage::Category]
        #     The user provided input parameters are invalid.
        # @!attribute [rw] server
        #     @return [Com::Vmware::Vcenter::Ovf::OvfMessage::Category]
        #     Server error.
        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

    end

### - (`String`) value

The value of input parameter. This field is optional and it is only relevant when the value of ``category`` is :attr:`Com::Vmware::Vcenter::Ovf::OvfMessage::Category.INPUT` .

Returns:

- (`String`)

    1576
    1577
    1578
    1579
    1580
    1581
    1582
    1583
    1584
    1585
    1586
    1587
    1588
    1589
    1590
    1591
    1592
    1593
    1594
    1595
    1596
    1597
    1598
    1599
    1600
    1601
    1602
    1603
    1604
    1605
    1606
    1607
    1608
    1609
    1610
    1611
    1612
    1613
    1614
    1615
    1616
    1617
    1618
    1619
    1620
    1621
    1622
    1623
    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
    1677
    1678
    1679
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 1576

    class OvfMessage < 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.vcenter.ovf.ovf_message',
                    {
                        'category' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Ovf::OvfMessage::Category'),
                        'issues' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ListType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Ovf::ParseIssue'))),
                        'name' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'value' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'message' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Std::LocalizableMessage')),
                        'error' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::DynamicStructType.new([VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Std::Errors::Error')])),
                    },
                    OvfMessage,
                    false,
                    nil)
            end
        end

        attr_accessor :category,
                      :issues,
                      :name,
                      :value,
                      :message,
                      :error

        # 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

        # The  ``Com::Vmware::Vcenter::Ovf::OvfMessage::Category``   enumerated type  defines the categories of messages (see   :class:`Com::Vmware::Vcenter::Ovf::OvfMessage`  ).
        # @!attribute [rw] validation
        #     @return [Com::Vmware::Vcenter::Ovf::OvfMessage::Category]
        #     The OVF descriptor is invalid, for example, syntax errors or schema errors.
        # @!attribute [rw] input
        #     @return [Com::Vmware::Vcenter::Ovf::OvfMessage::Category]
        #     The user provided input parameters are invalid.
        # @!attribute [rw] server
        #     @return [Com::Vmware::Vcenter::Ovf::OvfMessage::Category]
        #     Server error.
        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

    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

    1582
    1583
    1584
    1585
    1586
    1587
    1588
    1589
    1590
    1591
    1592
    1593
    1594
    1595
    1596
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 1582

    def binding_type
        @binding_type ||= VAPI::Bindings::StructType.new(
            'com.vmware.vcenter.ovf.ovf_message',
            {
                'category' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Ovf::OvfMessage::Category'),
                'issues' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ListType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Ovf::ParseIssue'))),
                'name' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                'value' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                'message' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Std::LocalizableMessage')),
                'error' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::DynamicStructType.new([VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Std::Errors::Error')])),
            },
            OvfMessage,
            false,
            nil)
    end