Class List Method List File List

# Class: Com::Vmware::Vcenter::Ovf::ExtraConfigParams

Inherits:
  VAPI::Bindings::VapiStruct
  - Object
  - VAPI::Bindings::VapiStruct
  - Com::Vmware::Vcenter::Ovf::ExtraConfigParams
  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::ExtraConfigParams`` class contains the parameters with information about the vmw:ExtraConfig elements in an OVF package.

     vmw:ExtraConfig elements can be used to specify configuration settings that are transferred directly to the  ``.vmx``  file.

     The behavior of the vmw:ExtraConfig element is similar to the  ``extraConfig``  property of the  ``VirtualMachineConfigSpec``  object in the VMware vSphere API. Thus, the same restrictions apply, such as you cannot set values that could otherwise be set with other properties in the  ``VirtualMachineConfigSpec``  object. See the VMware vSphere API reference for details on this.

     See   :func:`Com::Vmware::Vcenter::Ovf::LibraryItem.deploy`   and   :func:`Com::Vmware::Vcenter::Ovf::LibraryItem.filter`  .

## Instance Attribute Summary (collapse)

- - (Array<String>) exclude_keys

  Specifies which extra configuration items in the list in the ``extraConfigs`` ``field`` should be ignored during deployment.

- - (Array<Com::Vmware::Vcenter::Ovf::ExtraConfig>) extra_configs

  List of vmw:ExtraConfig elements in the OVF package.

- - (Array<String>) include_keys

  Specifies which extra configuration items in the list in the ``extraConfigs`` ``field`` should be included during deployment.

- - (Object) type

  Returns the value of attribute type.

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

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

  Constructs a new instance.

## Constructor Details

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

    1287
    1288
    1289
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 1287

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

## Instance Attribute Details

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

Specifies which extra configuration items in the list in the ``extraConfigs`` ``field`` should be ignored during deployment.

     If set, the given keys for extra configurations will be ignored during deployment. The key is defined in the   :attr:`Com::Vmware::Vcenter::Ovf::ExtraConfig.key`    field .

This field is optional in the input parameters when deploying an OVF package. It is an error to set both this and :attr:`Com::Vmware::Vcenter::Ovf::ExtraConfigParams.include_keys` . This field is optional in the result when retrieving information about an OVF package. It is an error to set both this and :attr:`Com::Vmware::Vcenter::Ovf::ExtraConfigParams.include_keys` .

Returns:

- (`Array<String>`)

    1258
    1259
    1260
    1261
    1262
    1263
    1264
    1265
    1266
    1267
    1268
    1269
    1270
    1271
    1272
    1273
    1274
    1275
    1276
    1277
    1278
    1279
    1280
    1281
    1282
    1283
    1284
    1285
    1286
    1287
    1288
    1289
    1290
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 1258

    class ExtraConfigParams < 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.extra_config_params',
                    {
                        'extra_configs' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ListType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Ovf::ExtraConfig'))),
                        'exclude_keys' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance)),
                        'include_keys' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance)),
                        'type' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    },
                    ExtraConfigParams,
                    false,
                    nil)
            end
        end

        attr_accessor :extra_configs,
                      :exclude_keys,
                      :include_keys,
                      :type

        # 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<Com::Vmware::Vcenter::Ovf::ExtraConfig>`) extra_configs

List of vmw:ExtraConfig elements in the OVF package. This field is optional in the input parameters when deploying an OVF package. If nil there are no extra configuration elements to use for this OVF package deployment. This field will always be present in the result when retrieving information about an OVF package. It will be an empty list if there are no extra configuration elements in the OVF package.

Returns:

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

    1258
    1259
    1260
    1261
    1262
    1263
    1264
    1265
    1266
    1267
    1268
    1269
    1270
    1271
    1272
    1273
    1274
    1275
    1276
    1277
    1278
    1279
    1280
    1281
    1282
    1283
    1284
    1285
    1286
    1287
    1288
    1289
    1290
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 1258

    class ExtraConfigParams < 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.extra_config_params',
                    {
                        'extra_configs' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ListType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Ovf::ExtraConfig'))),
                        'exclude_keys' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance)),
                        'include_keys' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance)),
                        'type' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    },
                    ExtraConfigParams,
                    false,
                    nil)
            end
        end

        attr_accessor :extra_configs,
                      :exclude_keys,
                      :include_keys,
                      :type

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

Specifies which extra configuration items in the list in the ``extraConfigs`` ``field`` should be included during deployment.

     If set, all but the given keys for extra configurations will be ignored during deployment. The key is defined in the   :attr:`Com::Vmware::Vcenter::Ovf::ExtraConfig.key`    field .

This field is optional in the input parameters when deploying an OVF package. It is an error to set both this and :attr:`Com::Vmware::Vcenter::Ovf::ExtraConfigParams.exclude_keys` . This field is optional in the result when retrieving information about an OVF package. It is an error to set both this and :attr:`Com::Vmware::Vcenter::Ovf::ExtraConfigParams.exclude_keys` .

Returns:

- (`Array<String>`)

    1258
    1259
    1260
    1261
    1262
    1263
    1264
    1265
    1266
    1267
    1268
    1269
    1270
    1271
    1272
    1273
    1274
    1275
    1276
    1277
    1278
    1279
    1280
    1281
    1282
    1283
    1284
    1285
    1286
    1287
    1288
    1289
    1290
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 1258

    class ExtraConfigParams < 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.extra_config_params',
                    {
                        'extra_configs' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ListType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Ovf::ExtraConfig'))),
                        'exclude_keys' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance)),
                        'include_keys' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance)),
                        'type' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    },
                    ExtraConfigParams,
                    false,
                    nil)
            end
        end

        attr_accessor :extra_configs,
                      :exclude_keys,
                      :include_keys,
                      :type

        # 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

### - (`Object`) type

Returns the value of attribute type

    1279
    1280
    1281
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 1279

    def type
      @type
    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

    1264
    1265
    1266
    1267
    1268
    1269
    1270
    1271
    1272
    1273
    1274
    1275
    1276
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 1264

    def binding_type
        @binding_type ||= VAPI::Bindings::StructType.new(
            'com.vmware.vcenter.ovf.extra_config_params',
            {
                'extra_configs' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ListType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Ovf::ExtraConfig'))),
                'exclude_keys' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance)),
                'include_keys' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance)),
                'type' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
            },
            ExtraConfigParams,
            false,
            nil)
    end