Class: Com::Vmware::Vcenter::Ovf::OvfParams

Inherits:

VAPI::Bindings::VapiStruct

Object
VAPI::Bindings::VapiStruct
Com::Vmware::Vcenter::Ovf::OvfParams

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::OvfParams`` class defines the common fields for all OVF deployment parameters. OVF parameters serve several purposes:


  * Describe information about a given OVF package. 
 * Describe default deployment configuration. 
 * Describe possible deployment values based on the deployment environment. 
 * Provide deployment-specific configuration. 

  Each OVF parameters  class  specifies a particular configurable aspect of OVF deployment. An aspect has both a query-model and a deploy-model. The query-model is used when the OVF package is queried, and the deploy-model is used when deploying an OVF package.  

 Most OVF parameter  classes  provide both informational and deployment parameters. However, some are purely informational (for example, download size) and some are purely deployment parameters (for example, the flag to indicate whether registration as a vCenter extension is accepted).  

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

Instance Attribute Summary (collapse)

- (String) type
Unique identifier describing the type of the OVF parameters.

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)

- (OvfParams) initialize(ruby_values = nil, struct_value = nil) constructor
Constructs a new instance.

Constructor Details

- (`OvfParams`) 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)



2046
2047
2048

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

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

Instance Attribute Details

- (`String`) type

Unique identifier describing the type of the OVF parameters. The value is the name of the OVF parameters class . 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)

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

class OvfParams < 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.ovf_params',
                {
                    'type' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                },
                OvfParams,
                false,
                nil)
        end
    end

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

Class Method Details

+ (`VAPI::Bindings::StructType`) binding_type

Holds (gets or creates) the binding type metadata for this structure type.