Class List Method List File List

# Class: Com::Vmware::Vcenter::Ovf::ScaleOutGroup

Inherits:
  VAPI::Bindings::VapiStruct
  - Object
  - VAPI::Bindings::VapiStruct
  - Com::Vmware::Vcenter::Ovf::ScaleOutGroup
  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::ScaleOutGroup`` class contains information about a scale-out group.

     It allows a virtual system collection to contain a set of children that are homogeneous with respect to a prototypical virtual system or virtual system collection. It shall cause the deployment function to replicate the prototype a number of times, thus allowing the number of instantiated virtual systems to be configured dynamically at deployment time.

     This is based on the ovf2:ScaleOutSection.

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

## Instance Attribute Summary (collapse)

- - (String) description

  The description of the scale-out group.

- - (String) id

  The identifier of the scale-out group.

- - (Fixnum) instance_count

  The scaling factor to use.

- - (Fixnum) maximum_instance_count

  The maximum scaling factor.

- - (Fixnum) minimum_instance_count

  The minimum scaling factor.

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

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

  Constructs a new instance.

## Constructor Details

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

    2238
    2239
    2240
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 2238

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

## Instance Attribute Details

### - (`String`) description

The description of the scale-out group. This field is not used in the input parameters when deploying an OVF package. This field will always be present in the result when retrieving information about an OVF package.

Returns:

- (`String`)

    2207
    2208
    2209
    2210
    2211
    2212
    2213
    2214
    2215
    2216
    2217
    2218
    2219
    2220
    2221
    2222
    2223
    2224
    2225
    2226
    2227
    2228
    2229
    2230
    2231
    2232
    2233
    2234
    2235
    2236
    2237
    2238
    2239
    2240
    2241
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 2207

    class ScaleOutGroup < 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.scale_out_group',
                    {
                        'id' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'description' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'instance_count' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                        'minimum_instance_count' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                        'maximum_instance_count' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                    },
                    ScaleOutGroup,
                    false,
                    nil)
            end
        end

        attr_accessor :id,
                      :description,
                      :instance_count,
                      :minimum_instance_count,
                      :maximum_instance_count

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

The identifier of the scale-out group. This field must be provided in the input parameters when deploying an OVF package. This field will always be present in the result when retrieving information about an OVF package.

Returns:

- (`String`)

    2207
    2208
    2209
    2210
    2211
    2212
    2213
    2214
    2215
    2216
    2217
    2218
    2219
    2220
    2221
    2222
    2223
    2224
    2225
    2226
    2227
    2228
    2229
    2230
    2231
    2232
    2233
    2234
    2235
    2236
    2237
    2238
    2239
    2240
    2241
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 2207

    class ScaleOutGroup < 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.scale_out_group',
                    {
                        'id' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'description' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'instance_count' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                        'minimum_instance_count' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                        'maximum_instance_count' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                    },
                    ScaleOutGroup,
                    false,
                    nil)
            end
        end

        attr_accessor :id,
                      :description,
                      :instance_count,
                      :minimum_instance_count,
                      :maximum_instance_count

        # 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

### - (`Fixnum`) instance_count

The scaling factor to use. It defines the number of replicas of the prototypical virtual system or virtual system collection. This field must be provided in the input parameters when deploying an OVF package. This field will always be present in the result when retrieving information about an OVF package.

Returns:

- (`Fixnum`)

    2207
    2208
    2209
    2210
    2211
    2212
    2213
    2214
    2215
    2216
    2217
    2218
    2219
    2220
    2221
    2222
    2223
    2224
    2225
    2226
    2227
    2228
    2229
    2230
    2231
    2232
    2233
    2234
    2235
    2236
    2237
    2238
    2239
    2240
    2241
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 2207

    class ScaleOutGroup < 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.scale_out_group',
                    {
                        'id' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'description' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'instance_count' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                        'minimum_instance_count' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                        'maximum_instance_count' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                    },
                    ScaleOutGroup,
                    false,
                    nil)
            end
        end

        attr_accessor :id,
                      :description,
                      :instance_count,
                      :minimum_instance_count,
                      :maximum_instance_count

        # 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

### - (`Fixnum`) maximum_instance_count

The maximum scaling factor. This field is not used in the input parameters when deploying an OVF package. This field is optional in the result when retrieving information about an OVF package. This will be nil if there is no explicit limit.

Returns:

- (`Fixnum`)

    2207
    2208
    2209
    2210
    2211
    2212
    2213
    2214
    2215
    2216
    2217
    2218
    2219
    2220
    2221
    2222
    2223
    2224
    2225
    2226
    2227
    2228
    2229
    2230
    2231
    2232
    2233
    2234
    2235
    2236
    2237
    2238
    2239
    2240
    2241
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 2207

    class ScaleOutGroup < 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.scale_out_group',
                    {
                        'id' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'description' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'instance_count' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                        'minimum_instance_count' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                        'maximum_instance_count' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                    },
                    ScaleOutGroup,
                    false,
                    nil)
            end
        end

        attr_accessor :id,
                      :description,
                      :instance_count,
                      :minimum_instance_count,
                      :maximum_instance_count

        # 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

### - (`Fixnum`) minimum_instance_count

The minimum scaling factor. This field is not used in the input parameters when deploying an OVF package. This field will always be present in the result when retrieving information about an OVF package. This will be 1 if there is no explicit limit.

Returns:

- (`Fixnum`)

    2207
    2208
    2209
    2210
    2211
    2212
    2213
    2214
    2215
    2216
    2217
    2218
    2219
    2220
    2221
    2222
    2223
    2224
    2225
    2226
    2227
    2228
    2229
    2230
    2231
    2232
    2233
    2234
    2235
    2236
    2237
    2238
    2239
    2240
    2241
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 2207

    class ScaleOutGroup < 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.scale_out_group',
                    {
                        'id' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'description' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'instance_count' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                        'minimum_instance_count' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                        'maximum_instance_count' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                    },
                    ScaleOutGroup,
                    false,
                    nil)
            end
        end

        attr_accessor :id,
                      :description,
                      :instance_count,
                      :minimum_instance_count,
                      :maximum_instance_count

        # 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

    2213
    2214
    2215
    2216
    2217
    2218
    2219
    2220
    2221
    2222
    2223
    2224
    2225
    2226
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 2213

    def binding_type
        @binding_type ||= VAPI::Bindings::StructType.new(
            'com.vmware.vcenter.ovf.scale_out_group',
            {
                'id' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                'description' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                'instance_count' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                'minimum_instance_count' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                'maximum_instance_count' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
            },
            ScaleOutGroup,
            false,
            nil)
    end