Class: Com::Vmware::Vcenter::Ovf::ParseIssue

Inherits:
VAPI::Bindings::VapiStruct
  • Object
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::ParseIssue`` class contains the information about the issue found when parsing an OVF package during deployment or exporting an OVF package including:


  * Parsing and validation error on OVF descriptor (which is an XML document), manifest and certificate files. 
 * OVF descriptor generating and device error. 
 * Unexpected server error.

Defined Under Namespace

Classes: Category

Instance Attribute Summary (collapse)

Class Method Summary (collapse)

Instance Method Summary (collapse)

Constructor Details

- (ParseIssue) 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)



1733
1734
1735
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 1733

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::ParseIssue::Category) category

The category of the parse issue.



1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 1702

class ParseIssue < 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.parse_issue',
                {
                    'category' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Ovf::ParseIssue::Category'),
                    'file' => VAPI::Bindings::StringType.instance,
                    'line_number' => VAPI::Bindings::IntegerType.instance,
                    'column_number' => VAPI::Bindings::IntegerType.instance,
                    'message' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Std::LocalizableMessage'),
                },
                ParseIssue,
                false,
                nil)
        end
    end

    attr_accessor :category,
                  :file,
                  :line_number,
                  :column_number,
                  :message

    # 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::ParseIssue::Category``   enumerated type  defines the categories of issues that can be found when parsing files inside an OVF package (see   :class:`Com::Vmware::Vcenter::Ovf::ParseIssue`  ) including OVF descriptor (which is an XML document), manifest and certificate files, or exporting an OVF package.
    # @!attribute [rw] value_illegal
    #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
    #     Illegal value error. For example, the value is malformed, not a number, or outside of the given range, and so on.
    # @!attribute [rw] attribute_required
    #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
    #     Required attribute error. It indicates that a required attribute is missing from an element in the OVF descriptor.
    # @!attribute [rw] attribute_illegal
    #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
    #     Illegal attribute error. It indicates that an illegal attribute is set for an element in the OVF descriptor. For example, empty disks do not use format, parentRef, and populatedSize attributes, if these attributes are present in an empty disk element then will get this pasrse issue.
    # @!attribute [rw] element_required
    #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
    #     Required element error. It indicates that a required element is missing from the OVF descriptor.
    # @!attribute [rw] element_illegal
    #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
    #     Illegal element error. It indicates that an element is present in a location which is not allowed, or found multiple elements but only one is allowed at the location in the OVF descriptor.
    # @!attribute [rw] element_unknown
    #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
    #     Unknown element error. It indicates that an element is unsupported when parsing an OVF descriptor.
    # @!attribute [rw] section_unknown
    #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
    #     Section unknown error. It indicates that a section is unsupported when parsing an OVF descriptor.
    # @!attribute [rw] section_restriction
    #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
    #     Section restriction error. It indicates that a section appears in place in the OVF descriptor where it is not allowed, a section appears fewer times than is required, or a section appears more times than is allowed.
    # @!attribute [rw] parse_error
    #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
    #     OVF package parsing error, including:  
    #     
    #       * OVF descriptor parsing errors, for example, syntax errors or schema errors. 
    #      * Manifest file parsing and verification errors. 
    #      * Certificate file parsing and verification errors. 
    # @!attribute [rw] generate_error
    #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
    #     OVF descriptor (which is an XML document) generating error, for example, well-formedness errors as well as unexpected processing conditions.
    # @!attribute [rw] validation_error
    #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
    #     An issue with the manifest and signing.
    # @!attribute [rw] export_error
    #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
    #     Issue during OVF export, for example, malformed deviceId, controller not found, or file backing for a device not found.
    # @!attribute [rw] internal_error
    #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
    #     Server encountered an unexpected error which prevented it from fulfilling the request.
    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.parse_issue.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] value_illegal
        #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
        #     Illegal value error. For example, the value is malformed, not a number, or outside of the given range, and so on.
        VALUE_ILLEGAL = Category.new('VALUE_ILLEGAL')

        # @!attribute [rw] attribute_required
        #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
        #     Required attribute error. It indicates that a required attribute is missing from an element in the OVF descriptor.
        ATTRIBUTE_REQUIRED = Category.new('ATTRIBUTE_REQUIRED')

        # @!attribute [rw] attribute_illegal
        #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
        #     Illegal attribute error. It indicates that an illegal attribute is set for an element in the OVF descriptor. For example, empty disks do not use format, parentRef, and populatedSize attributes, if these attributes are present in an empty disk element then will get this pasrse issue.
        ATTRIBUTE_ILLEGAL = Category.new('ATTRIBUTE_ILLEGAL')

        # @!attribute [rw] element_required
        #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
        #     Required element error. It indicates that a required element is missing from the OVF descriptor.
        ELEMENT_REQUIRED = Category.new('ELEMENT_REQUIRED')

        # @!attribute [rw] element_illegal
        #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
        #     Illegal element error. It indicates that an element is present in a location which is not allowed, or found multiple elements but only one is allowed at the location in the OVF descriptor.
        ELEMENT_ILLEGAL = Category.new('ELEMENT_ILLEGAL')

        # @!attribute [rw] element_unknown
        #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
        #     Unknown element error. It indicates that an element is unsupported when parsing an OVF descriptor.
        ELEMENT_UNKNOWN = Category.new('ELEMENT_UNKNOWN')

        # @!attribute [rw] section_unknown
        #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
        #     Section unknown error. It indicates that a section is unsupported when parsing an OVF descriptor.
        SECTION_UNKNOWN = Category.new('SECTION_UNKNOWN')

        # @!attribute [rw] section_restriction
        #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
        #     Section restriction error. It indicates that a section appears in place in the OVF descriptor where it is not allowed, a section appears fewer times than is required, or a section appears more times than is allowed.
        SECTION_RESTRICTION = Category.new('SECTION_RESTRICTION')

        # @!attribute [rw] parse_error
        #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
        #     OVF package parsing error, including:  
        #     
        #       * OVF descriptor parsing errors, for example, syntax errors or schema errors. 
        #      * Manifest file parsing and verification errors. 
        #      * Certificate file parsing and verification errors. 
        PARSE_ERROR = Category.new('PARSE_ERROR')

        # @!attribute [rw] generate_error
        #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
        #     OVF descriptor (which is an XML document) generating error, for example, well-formedness errors as well as unexpected processing conditions.
        GENERATE_ERROR = Category.new('GENERATE_ERROR')

        # @!attribute [rw] validation_error
        #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
        #     An issue with the manifest and signing.
        VALIDATION_ERROR = Category.new('VALIDATION_ERROR')

        # @!attribute [rw] export_error
        #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
        #     Issue during OVF export, for example, malformed deviceId, controller not found, or file backing for a device not found.
        EXPORT_ERROR = Category.new('EXPORT_ERROR')

        # @!attribute [rw] internal_error
        #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
        #     Server encountered an unexpected error which prevented it from fulfilling the request.
        INTERNAL_ERROR = Category.new('INTERNAL_ERROR')

    end


end

- (Fixnum) column_number

The position in the line (see :attr:`Com::Vmware::Vcenter::Ovf::ParseIssue.line_number` ) (or -1 if not applicable).

Returns:

  • (Fixnum)


1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 1702

class ParseIssue < 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.parse_issue',
                {
                    'category' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Ovf::ParseIssue::Category'),
                    'file' => VAPI::Bindings::StringType.instance,
                    'line_number' => VAPI::Bindings::IntegerType.instance,
                    'column_number' => VAPI::Bindings::IntegerType.instance,
                    'message' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Std::LocalizableMessage'),
                },
                ParseIssue,
                false,
                nil)
        end
    end

    attr_accessor :category,
                  :file,
                  :line_number,
                  :column_number,
                  :message

    # 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::ParseIssue::Category``   enumerated type  defines the categories of issues that can be found when parsing files inside an OVF package (see   :class:`Com::Vmware::Vcenter::Ovf::ParseIssue`  ) including OVF descriptor (which is an XML document), manifest and certificate files, or exporting an OVF package.
    # @!attribute [rw] value_illegal
    #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
    #     Illegal value error. For example, the value is malformed, not a number, or outside of the given range, and so on.
    # @!attribute [rw] attribute_required
    #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
    #     Required attribute error. It indicates that a required attribute is missing from an element in the OVF descriptor.
    # @!attribute [rw] attribute_illegal
    #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
    #     Illegal attribute error. It indicates that an illegal attribute is set for an element in the OVF descriptor. For example, empty disks do not use format, parentRef, and populatedSize attributes, if these attributes are present in an empty disk element then will get this pasrse issue.
    # @!attribute [rw] element_required
    #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
    #     Required element error. It indicates that a required element is missing from the OVF descriptor.
    # @!attribute [rw] element_illegal
    #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
    #     Illegal element error. It indicates that an element is present in a location which is not allowed, or found multiple elements but only one is allowed at the location in the OVF descriptor.
    # @!attribute [rw] element_unknown
    #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
    #     Unknown element error. It indicates that an element is unsupported when parsing an OVF descriptor.
    # @!attribute [rw] section_unknown
    #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
    #     Section unknown error. It indicates that a section is unsupported when parsing an OVF descriptor.
    # @!attribute [rw] section_restriction
    #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
    #     Section restriction error. It indicates that a section appears in place in the OVF descriptor where it is not allowed, a section appears fewer times than is required, or a section appears more times than is allowed.
    # @!attribute [rw] parse_error
    #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
    #     OVF package parsing error, including:  
    #     
    #       * OVF descriptor parsing errors, for example, syntax errors or schema errors. 
    #      * Manifest file parsing and verification errors. 
    #      * Certificate file parsing and verification errors. 
    # @!attribute [rw] generate_error
    #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
    #     OVF descriptor (which is an XML document) generating error, for example, well-formedness errors as well as unexpected processing conditions.
    # @!attribute [rw] validation_error
    #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
    #     An issue with the manifest and signing.
    # @!attribute [rw] export_error
    #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
    #     Issue during OVF export, for example, malformed deviceId, controller not found, or file backing for a device not found.
    # @!attribute [rw] internal_error
    #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
    #     Server encountered an unexpected error which prevented it from fulfilling the request.
    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.parse_issue.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] value_illegal
        #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
        #     Illegal value error. For example, the value is malformed, not a number, or outside of the given range, and so on.
        VALUE_ILLEGAL = Category.new('VALUE_ILLEGAL')

        # @!attribute [rw] attribute_required
        #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
        #     Required attribute error. It indicates that a required attribute is missing from an element in the OVF descriptor.
        ATTRIBUTE_REQUIRED = Category.new('ATTRIBUTE_REQUIRED')

        # @!attribute [rw] attribute_illegal
        #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
        #     Illegal attribute error. It indicates that an illegal attribute is set for an element in the OVF descriptor. For example, empty disks do not use format, parentRef, and populatedSize attributes, if these attributes are present in an empty disk element then will get this pasrse issue.
        ATTRIBUTE_ILLEGAL = Category.new('ATTRIBUTE_ILLEGAL')

        # @!attribute [rw] element_required
        #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
        #     Required element error. It indicates that a required element is missing from the OVF descriptor.
        ELEMENT_REQUIRED = Category.new('ELEMENT_REQUIRED')

        # @!attribute [rw] element_illegal
        #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
        #     Illegal element error. It indicates that an element is present in a location which is not allowed, or found multiple elements but only one is allowed at the location in the OVF descriptor.
        ELEMENT_ILLEGAL = Category.new('ELEMENT_ILLEGAL')

        # @!attribute [rw] element_unknown
        #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
        #     Unknown element error. It indicates that an element is unsupported when parsing an OVF descriptor.
        ELEMENT_UNKNOWN = Category.new('ELEMENT_UNKNOWN')

        # @!attribute [rw] section_unknown
        #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
        #     Section unknown error. It indicates that a section is unsupported when parsing an OVF descriptor.
        SECTION_UNKNOWN = Category.new('SECTION_UNKNOWN')

        # @!attribute [rw] section_restriction
        #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
        #     Section restriction error. It indicates that a section appears in place in the OVF descriptor where it is not allowed, a section appears fewer times than is required, or a section appears more times than is allowed.
        SECTION_RESTRICTION = Category.new('SECTION_RESTRICTION')

        # @!attribute [rw] parse_error
        #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
        #     OVF package parsing error, including:  
        #     
        #       * OVF descriptor parsing errors, for example, syntax errors or schema errors. 
        #      * Manifest file parsing and verification errors. 
        #      * Certificate file parsing and verification errors. 
        PARSE_ERROR = Category.new('PARSE_ERROR')

        # @!attribute [rw] generate_error
        #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
        #     OVF descriptor (which is an XML document) generating error, for example, well-formedness errors as well as unexpected processing conditions.
        GENERATE_ERROR = Category.new('GENERATE_ERROR')

        # @!attribute [rw] validation_error
        #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
        #     An issue with the manifest and signing.
        VALIDATION_ERROR = Category.new('VALIDATION_ERROR')

        # @!attribute [rw] export_error
        #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
        #     Issue during OVF export, for example, malformed deviceId, controller not found, or file backing for a device not found.
        EXPORT_ERROR = Category.new('EXPORT_ERROR')

        # @!attribute [rw] internal_error
        #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
        #     Server encountered an unexpected error which prevented it from fulfilling the request.
        INTERNAL_ERROR = Category.new('INTERNAL_ERROR')

    end


end

- (String) file

The name of the file in which the parse issue was found.

Returns:

  • (String)


1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 1702

class ParseIssue < 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.parse_issue',
                {
                    'category' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Ovf::ParseIssue::Category'),
                    'file' => VAPI::Bindings::StringType.instance,
                    'line_number' => VAPI::Bindings::IntegerType.instance,
                    'column_number' => VAPI::Bindings::IntegerType.instance,
                    'message' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Std::LocalizableMessage'),
                },
                ParseIssue,
                false,
                nil)
        end
    end

    attr_accessor :category,
                  :file,
                  :line_number,
                  :column_number,
                  :message

    # 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::ParseIssue::Category``   enumerated type  defines the categories of issues that can be found when parsing files inside an OVF package (see   :class:`Com::Vmware::Vcenter::Ovf::ParseIssue`  ) including OVF descriptor (which is an XML document), manifest and certificate files, or exporting an OVF package.
    # @!attribute [rw] value_illegal
    #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
    #     Illegal value error. For example, the value is malformed, not a number, or outside of the given range, and so on.
    # @!attribute [rw] attribute_required
    #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
    #     Required attribute error. It indicates that a required attribute is missing from an element in the OVF descriptor.
    # @!attribute [rw] attribute_illegal
    #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
    #     Illegal attribute error. It indicates that an illegal attribute is set for an element in the OVF descriptor. For example, empty disks do not use format, parentRef, and populatedSize attributes, if these attributes are present in an empty disk element then will get this pasrse issue.
    # @!attribute [rw] element_required
    #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
    #     Required element error. It indicates that a required element is missing from the OVF descriptor.
    # @!attribute [rw] element_illegal
    #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
    #     Illegal element error. It indicates that an element is present in a location which is not allowed, or found multiple elements but only one is allowed at the location in the OVF descriptor.
    # @!attribute [rw] element_unknown
    #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
    #     Unknown element error. It indicates that an element is unsupported when parsing an OVF descriptor.
    # @!attribute [rw] section_unknown
    #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
    #     Section unknown error. It indicates that a section is unsupported when parsing an OVF descriptor.
    # @!attribute [rw] section_restriction
    #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
    #     Section restriction error. It indicates that a section appears in place in the OVF descriptor where it is not allowed, a section appears fewer times than is required, or a section appears more times than is allowed.
    # @!attribute [rw] parse_error
    #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
    #     OVF package parsing error, including:  
    #     
    #       * OVF descriptor parsing errors, for example, syntax errors or schema errors. 
    #      * Manifest file parsing and verification errors. 
    #      * Certificate file parsing and verification errors. 
    # @!attribute [rw] generate_error
    #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
    #     OVF descriptor (which is an XML document) generating error, for example, well-formedness errors as well as unexpected processing conditions.
    # @!attribute [rw] validation_error
    #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
    #     An issue with the manifest and signing.
    # @!attribute [rw] export_error
    #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
    #     Issue during OVF export, for example, malformed deviceId, controller not found, or file backing for a device not found.
    # @!attribute [rw] internal_error
    #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
    #     Server encountered an unexpected error which prevented it from fulfilling the request.
    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.parse_issue.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] value_illegal
        #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
        #     Illegal value error. For example, the value is malformed, not a number, or outside of the given range, and so on.
        VALUE_ILLEGAL = Category.new('VALUE_ILLEGAL')

        # @!attribute [rw] attribute_required
        #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
        #     Required attribute error. It indicates that a required attribute is missing from an element in the OVF descriptor.
        ATTRIBUTE_REQUIRED = Category.new('ATTRIBUTE_REQUIRED')

        # @!attribute [rw] attribute_illegal
        #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
        #     Illegal attribute error. It indicates that an illegal attribute is set for an element in the OVF descriptor. For example, empty disks do not use format, parentRef, and populatedSize attributes, if these attributes are present in an empty disk element then will get this pasrse issue.
        ATTRIBUTE_ILLEGAL = Category.new('ATTRIBUTE_ILLEGAL')

        # @!attribute [rw] element_required
        #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
        #     Required element error. It indicates that a required element is missing from the OVF descriptor.
        ELEMENT_REQUIRED = Category.new('ELEMENT_REQUIRED')

        # @!attribute [rw] element_illegal
        #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
        #     Illegal element error. It indicates that an element is present in a location which is not allowed, or found multiple elements but only one is allowed at the location in the OVF descriptor.
        ELEMENT_ILLEGAL = Category.new('ELEMENT_ILLEGAL')

        # @!attribute [rw] element_unknown
        #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
        #     Unknown element error. It indicates that an element is unsupported when parsing an OVF descriptor.
        ELEMENT_UNKNOWN = Category.new('ELEMENT_UNKNOWN')

        # @!attribute [rw] section_unknown
        #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
        #     Section unknown error. It indicates that a section is unsupported when parsing an OVF descriptor.
        SECTION_UNKNOWN = Category.new('SECTION_UNKNOWN')

        # @!attribute [rw] section_restriction
        #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
        #     Section restriction error. It indicates that a section appears in place in the OVF descriptor where it is not allowed, a section appears fewer times than is required, or a section appears more times than is allowed.
        SECTION_RESTRICTION = Category.new('SECTION_RESTRICTION')

        # @!attribute [rw] parse_error
        #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
        #     OVF package parsing error, including:  
        #     
        #       * OVF descriptor parsing errors, for example, syntax errors or schema errors. 
        #      * Manifest file parsing and verification errors. 
        #      * Certificate file parsing and verification errors. 
        PARSE_ERROR = Category.new('PARSE_ERROR')

        # @!attribute [rw] generate_error
        #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
        #     OVF descriptor (which is an XML document) generating error, for example, well-formedness errors as well as unexpected processing conditions.
        GENERATE_ERROR = Category.new('GENERATE_ERROR')

        # @!attribute [rw] validation_error
        #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
        #     An issue with the manifest and signing.
        VALIDATION_ERROR = Category.new('VALIDATION_ERROR')

        # @!attribute [rw] export_error
        #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
        #     Issue during OVF export, for example, malformed deviceId, controller not found, or file backing for a device not found.
        EXPORT_ERROR = Category.new('EXPORT_ERROR')

        # @!attribute [rw] internal_error
        #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
        #     Server encountered an unexpected error which prevented it from fulfilling the request.
        INTERNAL_ERROR = Category.new('INTERNAL_ERROR')

    end


end

- (Fixnum) line_number

The line number of the line in the file (see :attr:`Com::Vmware::Vcenter::Ovf::ParseIssue.file` ) where the parse issue was found (or -1 if not applicable).

Returns:

  • (Fixnum)


1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 1702

class ParseIssue < 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.parse_issue',
                {
                    'category' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Ovf::ParseIssue::Category'),
                    'file' => VAPI::Bindings::StringType.instance,
                    'line_number' => VAPI::Bindings::IntegerType.instance,
                    'column_number' => VAPI::Bindings::IntegerType.instance,
                    'message' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Std::LocalizableMessage'),
                },
                ParseIssue,
                false,
                nil)
        end
    end

    attr_accessor :category,
                  :file,
                  :line_number,
                  :column_number,
                  :message

    # 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::ParseIssue::Category``   enumerated type  defines the categories of issues that can be found when parsing files inside an OVF package (see   :class:`Com::Vmware::Vcenter::Ovf::ParseIssue`  ) including OVF descriptor (which is an XML document), manifest and certificate files, or exporting an OVF package.
    # @!attribute [rw] value_illegal
    #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
    #     Illegal value error. For example, the value is malformed, not a number, or outside of the given range, and so on.
    # @!attribute [rw] attribute_required
    #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
    #     Required attribute error. It indicates that a required attribute is missing from an element in the OVF descriptor.
    # @!attribute [rw] attribute_illegal
    #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
    #     Illegal attribute error. It indicates that an illegal attribute is set for an element in the OVF descriptor. For example, empty disks do not use format, parentRef, and populatedSize attributes, if these attributes are present in an empty disk element then will get this pasrse issue.
    # @!attribute [rw] element_required
    #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
    #     Required element error. It indicates that a required element is missing from the OVF descriptor.
    # @!attribute [rw] element_illegal
    #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
    #     Illegal element error. It indicates that an element is present in a location which is not allowed, or found multiple elements but only one is allowed at the location in the OVF descriptor.
    # @!attribute [rw] element_unknown
    #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
    #     Unknown element error. It indicates that an element is unsupported when parsing an OVF descriptor.
    # @!attribute [rw] section_unknown
    #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
    #     Section unknown error. It indicates that a section is unsupported when parsing an OVF descriptor.
    # @!attribute [rw] section_restriction
    #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
    #     Section restriction error. It indicates that a section appears in place in the OVF descriptor where it is not allowed, a section appears fewer times than is required, or a section appears more times than is allowed.
    # @!attribute [rw] parse_error
    #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
    #     OVF package parsing error, including:  
    #     
    #       * OVF descriptor parsing errors, for example, syntax errors or schema errors. 
    #      * Manifest file parsing and verification errors. 
    #      * Certificate file parsing and verification errors. 
    # @!attribute [rw] generate_error
    #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
    #     OVF descriptor (which is an XML document) generating error, for example, well-formedness errors as well as unexpected processing conditions.
    # @!attribute [rw] validation_error
    #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
    #     An issue with the manifest and signing.
    # @!attribute [rw] export_error
    #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
    #     Issue during OVF export, for example, malformed deviceId, controller not found, or file backing for a device not found.
    # @!attribute [rw] internal_error
    #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
    #     Server encountered an unexpected error which prevented it from fulfilling the request.
    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.parse_issue.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] value_illegal
        #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
        #     Illegal value error. For example, the value is malformed, not a number, or outside of the given range, and so on.
        VALUE_ILLEGAL = Category.new('VALUE_ILLEGAL')

        # @!attribute [rw] attribute_required
        #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
        #     Required attribute error. It indicates that a required attribute is missing from an element in the OVF descriptor.
        ATTRIBUTE_REQUIRED = Category.new('ATTRIBUTE_REQUIRED')

        # @!attribute [rw] attribute_illegal
        #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
        #     Illegal attribute error. It indicates that an illegal attribute is set for an element in the OVF descriptor. For example, empty disks do not use format, parentRef, and populatedSize attributes, if these attributes are present in an empty disk element then will get this pasrse issue.
        ATTRIBUTE_ILLEGAL = Category.new('ATTRIBUTE_ILLEGAL')

        # @!attribute [rw] element_required
        #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
        #     Required element error. It indicates that a required element is missing from the OVF descriptor.
        ELEMENT_REQUIRED = Category.new('ELEMENT_REQUIRED')

        # @!attribute [rw] element_illegal
        #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
        #     Illegal element error. It indicates that an element is present in a location which is not allowed, or found multiple elements but only one is allowed at the location in the OVF descriptor.
        ELEMENT_ILLEGAL = Category.new('ELEMENT_ILLEGAL')

        # @!attribute [rw] element_unknown
        #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
        #     Unknown element error. It indicates that an element is unsupported when parsing an OVF descriptor.
        ELEMENT_UNKNOWN = Category.new('ELEMENT_UNKNOWN')

        # @!attribute [rw] section_unknown
        #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
        #     Section unknown error. It indicates that a section is unsupported when parsing an OVF descriptor.
        SECTION_UNKNOWN = Category.new('SECTION_UNKNOWN')

        # @!attribute [rw] section_restriction
        #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
        #     Section restriction error. It indicates that a section appears in place in the OVF descriptor where it is not allowed, a section appears fewer times than is required, or a section appears more times than is allowed.
        SECTION_RESTRICTION = Category.new('SECTION_RESTRICTION')

        # @!attribute [rw] parse_error
        #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
        #     OVF package parsing error, including:  
        #     
        #       * OVF descriptor parsing errors, for example, syntax errors or schema errors. 
        #      * Manifest file parsing and verification errors. 
        #      * Certificate file parsing and verification errors. 
        PARSE_ERROR = Category.new('PARSE_ERROR')

        # @!attribute [rw] generate_error
        #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
        #     OVF descriptor (which is an XML document) generating error, for example, well-formedness errors as well as unexpected processing conditions.
        GENERATE_ERROR = Category.new('GENERATE_ERROR')

        # @!attribute [rw] validation_error
        #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
        #     An issue with the manifest and signing.
        VALIDATION_ERROR = Category.new('VALIDATION_ERROR')

        # @!attribute [rw] export_error
        #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
        #     Issue during OVF export, for example, malformed deviceId, controller not found, or file backing for a device not found.
        EXPORT_ERROR = Category.new('EXPORT_ERROR')

        # @!attribute [rw] internal_error
        #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
        #     Server encountered an unexpected error which prevented it from fulfilling the request.
        INTERNAL_ERROR = Category.new('INTERNAL_ERROR')

    end


end

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

A localizable message describing the parse issue.



1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 1702

class ParseIssue < 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.parse_issue',
                {
                    'category' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Ovf::ParseIssue::Category'),
                    'file' => VAPI::Bindings::StringType.instance,
                    'line_number' => VAPI::Bindings::IntegerType.instance,
                    'column_number' => VAPI::Bindings::IntegerType.instance,
                    'message' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Std::LocalizableMessage'),
                },
                ParseIssue,
                false,
                nil)
        end
    end

    attr_accessor :category,
                  :file,
                  :line_number,
                  :column_number,
                  :message

    # 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::ParseIssue::Category``   enumerated type  defines the categories of issues that can be found when parsing files inside an OVF package (see   :class:`Com::Vmware::Vcenter::Ovf::ParseIssue`  ) including OVF descriptor (which is an XML document), manifest and certificate files, or exporting an OVF package.
    # @!attribute [rw] value_illegal
    #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
    #     Illegal value error. For example, the value is malformed, not a number, or outside of the given range, and so on.
    # @!attribute [rw] attribute_required
    #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
    #     Required attribute error. It indicates that a required attribute is missing from an element in the OVF descriptor.
    # @!attribute [rw] attribute_illegal
    #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
    #     Illegal attribute error. It indicates that an illegal attribute is set for an element in the OVF descriptor. For example, empty disks do not use format, parentRef, and populatedSize attributes, if these attributes are present in an empty disk element then will get this pasrse issue.
    # @!attribute [rw] element_required
    #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
    #     Required element error. It indicates that a required element is missing from the OVF descriptor.
    # @!attribute [rw] element_illegal
    #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
    #     Illegal element error. It indicates that an element is present in a location which is not allowed, or found multiple elements but only one is allowed at the location in the OVF descriptor.
    # @!attribute [rw] element_unknown
    #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
    #     Unknown element error. It indicates that an element is unsupported when parsing an OVF descriptor.
    # @!attribute [rw] section_unknown
    #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
    #     Section unknown error. It indicates that a section is unsupported when parsing an OVF descriptor.
    # @!attribute [rw] section_restriction
    #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
    #     Section restriction error. It indicates that a section appears in place in the OVF descriptor where it is not allowed, a section appears fewer times than is required, or a section appears more times than is allowed.
    # @!attribute [rw] parse_error
    #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
    #     OVF package parsing error, including:  
    #     
    #       * OVF descriptor parsing errors, for example, syntax errors or schema errors. 
    #      * Manifest file parsing and verification errors. 
    #      * Certificate file parsing and verification errors. 
    # @!attribute [rw] generate_error
    #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
    #     OVF descriptor (which is an XML document) generating error, for example, well-formedness errors as well as unexpected processing conditions.
    # @!attribute [rw] validation_error
    #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
    #     An issue with the manifest and signing.
    # @!attribute [rw] export_error
    #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
    #     Issue during OVF export, for example, malformed deviceId, controller not found, or file backing for a device not found.
    # @!attribute [rw] internal_error
    #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
    #     Server encountered an unexpected error which prevented it from fulfilling the request.
    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.parse_issue.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] value_illegal
        #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
        #     Illegal value error. For example, the value is malformed, not a number, or outside of the given range, and so on.
        VALUE_ILLEGAL = Category.new('VALUE_ILLEGAL')

        # @!attribute [rw] attribute_required
        #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
        #     Required attribute error. It indicates that a required attribute is missing from an element in the OVF descriptor.
        ATTRIBUTE_REQUIRED = Category.new('ATTRIBUTE_REQUIRED')

        # @!attribute [rw] attribute_illegal
        #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
        #     Illegal attribute error. It indicates that an illegal attribute is set for an element in the OVF descriptor. For example, empty disks do not use format, parentRef, and populatedSize attributes, if these attributes are present in an empty disk element then will get this pasrse issue.
        ATTRIBUTE_ILLEGAL = Category.new('ATTRIBUTE_ILLEGAL')

        # @!attribute [rw] element_required
        #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
        #     Required element error. It indicates that a required element is missing from the OVF descriptor.
        ELEMENT_REQUIRED = Category.new('ELEMENT_REQUIRED')

        # @!attribute [rw] element_illegal
        #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
        #     Illegal element error. It indicates that an element is present in a location which is not allowed, or found multiple elements but only one is allowed at the location in the OVF descriptor.
        ELEMENT_ILLEGAL = Category.new('ELEMENT_ILLEGAL')

        # @!attribute [rw] element_unknown
        #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
        #     Unknown element error. It indicates that an element is unsupported when parsing an OVF descriptor.
        ELEMENT_UNKNOWN = Category.new('ELEMENT_UNKNOWN')

        # @!attribute [rw] section_unknown
        #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
        #     Section unknown error. It indicates that a section is unsupported when parsing an OVF descriptor.
        SECTION_UNKNOWN = Category.new('SECTION_UNKNOWN')

        # @!attribute [rw] section_restriction
        #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
        #     Section restriction error. It indicates that a section appears in place in the OVF descriptor where it is not allowed, a section appears fewer times than is required, or a section appears more times than is allowed.
        SECTION_RESTRICTION = Category.new('SECTION_RESTRICTION')

        # @!attribute [rw] parse_error
        #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
        #     OVF package parsing error, including:  
        #     
        #       * OVF descriptor parsing errors, for example, syntax errors or schema errors. 
        #      * Manifest file parsing and verification errors. 
        #      * Certificate file parsing and verification errors. 
        PARSE_ERROR = Category.new('PARSE_ERROR')

        # @!attribute [rw] generate_error
        #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
        #     OVF descriptor (which is an XML document) generating error, for example, well-formedness errors as well as unexpected processing conditions.
        GENERATE_ERROR = Category.new('GENERATE_ERROR')

        # @!attribute [rw] validation_error
        #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
        #     An issue with the manifest and signing.
        VALIDATION_ERROR = Category.new('VALIDATION_ERROR')

        # @!attribute [rw] export_error
        #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
        #     Issue during OVF export, for example, malformed deviceId, controller not found, or file backing for a device not found.
        EXPORT_ERROR = Category.new('EXPORT_ERROR')

        # @!attribute [rw] internal_error
        #     @return [Com::Vmware::Vcenter::Ovf::ParseIssue::Category]
        #     Server encountered an unexpected error which prevented it from fulfilling the request.
        INTERNAL_ERROR = Category.new('INTERNAL_ERROR')

    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



1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 1708

def binding_type
    @binding_type ||= VAPI::Bindings::StructType.new(
        'com.vmware.vcenter.ovf.parse_issue',
        {
            'category' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Ovf::ParseIssue::Category'),
            'file' => VAPI::Bindings::StringType.instance,
            'line_number' => VAPI::Bindings::IntegerType.instance,
            'column_number' => VAPI::Bindings::IntegerType.instance,
            'message' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Std::LocalizableMessage'),
        },
        ParseIssue,
        false,
        nil)
end