Class: Com::Vmware::Vcenter::Ovf::DeploymentOptionParams

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::DeploymentOptionParams`` class describes the possible deployment options as well as the choice provided by the user. 


 This information based on the ovf:DeploymentOptionSection.  

 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

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



1179
1180
1181
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 1179

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::DeploymentOption>) deployment_options

List of deployment options. This field corresponds to the ovf:Configuration elements of the ovf:DeploymentOptionSection in the specification. It is a discrete set of intended resource allocation configurations from which one can be selected. 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:



1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 1152

class DeploymentOptionParams < 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.deployment_option_params',
                {
                    'deployment_options' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ListType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Ovf::DeploymentOption'))),
                    'selected_key' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    'type' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                },
                DeploymentOptionParams,
                false,
                nil)
        end
    end

    attr_accessor :deployment_options,
                  :selected_key,
                  :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

- (String) selected_key

The selected deployment option. Identifies the :class:`Com::Vmware::Vcenter::Ovf::DeploymentOption` in the list in the ``deploymentOptions`` field with a matching value in the :attr:`Com::Vmware::Vcenter::Ovf::DeploymentOption.key` field . This field is optional in the input parameters when deploying an OVF package. If nil the server will use the default deployment configuration, usually it’s the first one in :attr:`Com::Vmware::Vcenter::Ovf::DeploymentOptionParams.deployment_options` list . This field is optional in the result when retrieving information about an OVF package. The value will be set only if it is specified with the optional ovf:default attribute.

Returns:

  • (String) 


1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 1152

class DeploymentOptionParams < 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.deployment_option_params',
                {
                    'deployment_options' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ListType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Ovf::DeploymentOption'))),
                    'selected_key' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    'type' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                },
                DeploymentOptionParams,
                false,
                nil)
        end
    end

    attr_accessor :deployment_options,
                  :selected_key,
                  :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 



1172
1173
1174
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 1172

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 



1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 1158

def binding_type
    @binding_type ||= VAPI::Bindings::StructType.new(
        'com.vmware.vcenter.ovf.deployment_option_params',
        {
            'deployment_options' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ListType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Ovf::DeploymentOption'))),
            'selected_key' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
            'type' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
        },
        DeploymentOptionParams,
        false,
        nil)
end