Class: Com::Vmware::Vcenter::Ovf::ScaleOutParams

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::ScaleOutParams`` class contains information about the scale-out groups described in the OVF package.


 When deploying an OVF package, a deployment specific instance count can be specified (see   :attr:`Com::Vmware::Vcenter::Ovf::ScaleOutGroup.instance_count`  .  

 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)

Class Method Summary (collapse)

Instance Method Summary (collapse)

Constructor Details

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



2280
2281
2282
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 2280

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

Instance Attribute Details

- (Array<Com::Vmware::Vcenter::Ovf::ScaleOutGroup>) groups

The list of scale-out groups. This field is optional in the input parameters when deploying an OVF package. If nil there are no scale-out groups. This field will always be present in the result when retrieving information about an OVF package.



2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 2255

class ScaleOutParams < 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_params',
                {
                    'groups' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ListType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Ovf::ScaleOutGroup'))),
                    'type' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                },
                ScaleOutParams,
                false,
                nil)
        end
    end

    attr_accessor :groups,
                  :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



2274
2275
2276
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 2274

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



2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 2261

def binding_type
    @binding_type ||= VAPI::Bindings::StructType.new(
        'com.vmware.vcenter.ovf.scale_out_params',
        {
            'groups' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ListType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Ovf::ScaleOutGroup'))),
            'type' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
        },
        ScaleOutParams,
        false,
        nil)
end