Class List Method List File List

# Class: Com::Vmware::Vcenter::Ovf::LibraryItem::OvfSummary

Inherits:
  VAPI::Bindings::VapiStruct
  - Object
  - VAPI::Bindings::VapiStruct
  - Com::Vmware::Vcenter::Ovf::LibraryItem::OvfSummary
  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::LibraryItem::OvfSummary`` class defines the result of the ``filter`` method . See :func:`Com::Vmware::Vcenter::Ovf::LibraryItem.filter` . The fields in the class describe parameterizable information in the OVF descriptor, with respect to a deployment target, for the ``deploy`` method . See :func:`Com::Vmware::Vcenter::Ovf::LibraryItem.deploy` .

## Instance Attribute Summary (collapse)

- - (Array<VAPI::Bindings::VapiStruct>?) additional_params

  Additional OVF parameters which can be specified for the deployment target.

- - (String?) annotation

  Default annotation for the virtual machine or virtual appliance.

- - (Array<String>) eulas

  End User License Agreements specified in the OVF descriptor.

- - (String?) name

  Default name for the virtual machine or virtual appliance.

- - (Array<String>?) networks

  Section identifiers for sections of type ovf:NetworkSection in the OVF descriptor.

- - (Array<String>?) storage_groups

  Section identifiers for sections of type vmw:StorageGroupSection in the OVF descriptor.

## 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)

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

  Constructs a new instance.

## Constructor Details

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

    880
    881
    882
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 880

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

## Instance Attribute Details

### - (`Array<VAPI::Bindings::VapiStruct>`?) additional_params

Additional OVF parameters which can be specified for the deployment target. These OVF parameters can be inspected, optionally modified, and used as values in :attr:`Com::Vmware::Vcenter::Ovf::LibraryItem::ResourcePoolDeploymentSpec.additional_parameters` for the ``deploy`` method . If nil , the OVF descriptor does not require addtional parameters or does not have additional parameters suitable for the deployment target.

Returns:

- (`Array<VAPI::Bindings::VapiStruct>`, `nil`)

    847
    848
    849
    850
    851
    852
    853
    854
    855
    856
    857
    858
    859
    860
    861
    862
    863
    864
    865
    866
    867
    868
    869
    870
    871
    872
    873
    874
    875
    876
    877
    878
    879
    880
    881
    882
    883
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 847

    class OvfSummary < 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.library_item.ovf_summary',
                    {
                        'name' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'annotation' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'EULAs' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                        'networks' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance)),
                        'storage_groups' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance)),
                        'additional_params' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ListType.new(VAPI::Bindings::DynamicStructType.new([VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Ovf::OvfParams')]))),
                    },
                    OvfSummary,
                    false,
                    nil)
            end
        end

        attr_accessor :name,
                      :annotation,
                      :eulas,
                      :networks,
                      :storage_groups,
                      :additional_params

        # 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
    end

### - (`String`?) annotation

Default annotation for the virtual machine or virtual appliance. If nil , the OVF descriptor did not specify an annotation.

Returns:

- (`String`, `nil`)

    847
    848
    849
    850
    851
    852
    853
    854
    855
    856
    857
    858
    859
    860
    861
    862
    863
    864
    865
    866
    867
    868
    869
    870
    871
    872
    873
    874
    875
    876
    877
    878
    879
    880
    881
    882
    883
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 847

    class OvfSummary < 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.library_item.ovf_summary',
                    {
                        'name' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'annotation' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'EULAs' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                        'networks' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance)),
                        'storage_groups' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance)),
                        'additional_params' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ListType.new(VAPI::Bindings::DynamicStructType.new([VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Ovf::OvfParams')]))),
                    },
                    OvfSummary,
                    false,
                    nil)
            end
        end

        attr_accessor :name,
                      :annotation,
                      :eulas,
                      :networks,
                      :storage_groups,
                      :additional_params

        # 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
    end

### - (`Array<String>`) eulas

End User License Agreements specified in the OVF descriptor. All end user license agreements must be accepted in order for the ``deploy`` method to succeed. See :attr:`Com::Vmware::Vcenter::Ovf::LibraryItem::ResourcePoolDeploymentSpec.accept_all_eula` .

Returns:

- (`Array<String>`)

    847
    848
    849
    850
    851
    852
    853
    854
    855
    856
    857
    858
    859
    860
    861
    862
    863
    864
    865
    866
    867
    868
    869
    870
    871
    872
    873
    874
    875
    876
    877
    878
    879
    880
    881
    882
    883
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 847

    class OvfSummary < 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.library_item.ovf_summary',
                    {
                        'name' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'annotation' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'EULAs' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                        'networks' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance)),
                        'storage_groups' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance)),
                        'additional_params' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ListType.new(VAPI::Bindings::DynamicStructType.new([VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Ovf::OvfParams')]))),
                    },
                    OvfSummary,
                    false,
                    nil)
            end
        end

        attr_accessor :name,
                      :annotation,
                      :eulas,
                      :networks,
                      :storage_groups,
                      :additional_params

        # 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
    end

### - (`String`?) name

Default name for the virtual machine or virtual appliance. If nil , the OVF descriptor did not specify a name.

Returns:

- (`String`, `nil`)

    847
    848
    849
    850
    851
    852
    853
    854
    855
    856
    857
    858
    859
    860
    861
    862
    863
    864
    865
    866
    867
    868
    869
    870
    871
    872
    873
    874
    875
    876
    877
    878
    879
    880
    881
    882
    883
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 847

    class OvfSummary < 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.library_item.ovf_summary',
                    {
                        'name' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'annotation' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'EULAs' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                        'networks' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance)),
                        'storage_groups' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance)),
                        'additional_params' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ListType.new(VAPI::Bindings::DynamicStructType.new([VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Ovf::OvfParams')]))),
                    },
                    OvfSummary,
                    false,
                    nil)
            end
        end

        attr_accessor :name,
                      :annotation,
                      :eulas,
                      :networks,
                      :storage_groups,
                      :additional_params

        # 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
    end

### - (`Array<String>`?) networks

Section identifiers for sections of type ovf:NetworkSection in the OVF descriptor. These identifiers can be used as keys in :attr:`Com::Vmware::Vcenter::Ovf::LibraryItem::ResourcePoolDeploymentSpec.network_mappings` . If nil , the OVF descriptor did not specify any networks.

Returns:

- (`Array<String>`, `nil`)

    847
    848
    849
    850
    851
    852
    853
    854
    855
    856
    857
    858
    859
    860
    861
    862
    863
    864
    865
    866
    867
    868
    869
    870
    871
    872
    873
    874
    875
    876
    877
    878
    879
    880
    881
    882
    883
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 847

    class OvfSummary < 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.library_item.ovf_summary',
                    {
                        'name' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'annotation' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'EULAs' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                        'networks' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance)),
                        'storage_groups' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance)),
                        'additional_params' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ListType.new(VAPI::Bindings::DynamicStructType.new([VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Ovf::OvfParams')]))),
                    },
                    OvfSummary,
                    false,
                    nil)
            end
        end

        attr_accessor :name,
                      :annotation,
                      :eulas,
                      :networks,
                      :storage_groups,
                      :additional_params

        # 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
    end

### - (`Array<String>`?) storage_groups

Section identifiers for sections of type vmw:StorageGroupSection in the OVF descriptor. These identifiers can be used as keys in :attr:`Com::Vmware::Vcenter::Ovf::LibraryItem::ResourcePoolDeploymentSpec.storage_mappings` . If nil , the OVF descriptor did not specify any storage groups.

Returns:

- (`Array<String>`, `nil`)

    847
    848
    849
    850
    851
    852
    853
    854
    855
    856
    857
    858
    859
    860
    861
    862
    863
    864
    865
    866
    867
    868
    869
    870
    871
    872
    873
    874
    875
    876
    877
    878
    879
    880
    881
    882
    883
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 847

    class OvfSummary < 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.library_item.ovf_summary',
                    {
                        'name' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'annotation' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'EULAs' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                        'networks' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance)),
                        'storage_groups' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance)),
                        'additional_params' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ListType.new(VAPI::Bindings::DynamicStructType.new([VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Ovf::OvfParams')]))),
                    },
                    OvfSummary,
                    false,
                    nil)
            end
        end

        attr_accessor :name,
                      :annotation,
                      :eulas,
                      :networks,
                      :storage_groups,
                      :additional_params

        # 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
    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

    853
    854
    855
    856
    857
    858
    859
    860
    861
    862
    863
    864
    865
    866
    867
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 853

    def binding_type
        @binding_type ||= VAPI::Bindings::StructType.new(
            'com.vmware.vcenter.ovf.library_item.ovf_summary',
            {
                'name' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                'annotation' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                'EULAs' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                'networks' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance)),
                'storage_groups' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance)),
                'additional_params' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ListType.new(VAPI::Bindings::DynamicStructType.new([VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Ovf::OvfParams')]))),
            },
            OvfSummary,
            false,
            nil)
    end