Class: Com::Vmware::Vcenter::Ovf::DeploymentOption

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::DeploymentOption`` class contains the information about a deployment option as defined in the OVF specification. 


 This corresponds to the ovf:Configuration element of the ovf:DeploymentOptionSection in the specification. The ovf:DeploymentOptionSection specifies a discrete set of intended resource allocation configurations. This  class  represents one item from that set.  

 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

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



1133
1134
1135
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 1133

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

Instance Attribute Details

- (Boolean) default_choice

A boolean flag indicates whether this deployment option is the default choice. 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. If nil or false, it is not the default.

Returns:

  • (Boolean) 


1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 1104

class DeploymentOption < 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',
                {
                    'key' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    'label' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    'description' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    'default_choice' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                },
                DeploymentOption,
                false,
                nil)
        end
    end

    attr_accessor :key,
                  :label,
                  :description,
                  :default_choice

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

A localizable description for the deployment option. 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) 


1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 1104

class DeploymentOption < 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',
                {
                    'key' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    'label' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    'description' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    'default_choice' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                },
                DeploymentOption,
                false,
                nil)
        end
    end

    attr_accessor :key,
                  :label,
                  :description,
                  :default_choice

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

The key of the deployment option, corresponding to the ovf:id attribute in the OVF descriptor. 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) 


1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 1104

class DeploymentOption < 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',
                {
                    'key' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    'label' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    'description' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    'default_choice' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                },
                DeploymentOption,
                false,
                nil)
        end
    end

    attr_accessor :key,
                  :label,
                  :description,
                  :default_choice

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

A localizable label for the deployment option. 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) 


1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 1104

class DeploymentOption < 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',
                {
                    'key' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    'label' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    'description' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    'default_choice' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                },
                DeploymentOption,
                false,
                nil)
        end
    end

    attr_accessor :key,
                  :label,
                  :description,
                  :default_choice

    # 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 



1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 1110

def binding_type
    @binding_type ||= VAPI::Bindings::StructType.new(
        'com.vmware.vcenter.ovf.deployment_option',
        {
            'key' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
            'label' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
            'description' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
            'default_choice' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
        },
        DeploymentOption,
        false,
        nil)
end