Class: Com::Vmware::Vcenter::Ovf::Property
- Inherits:
-
VAPI::Bindings::VapiStruct
- Object
- VAPI::Bindings::VapiStruct
- Com::Vmware::Vcenter::Ovf::Property
- Defined in:
- /build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb
Overview
The ``Com::Vmware::Vcenter::Ovf::Property`` class contains the information about a property in an OVF package.
A property is uniquely identified by its [classid.]id[.instanceid] fully-qualified name (see :attr:`Com::Vmware::Vcenter::Ovf::Property.class_id` , :attr:`Com::Vmware::Vcenter::Ovf::Property.id` , and :attr:`Com::Vmware::Vcenter::Ovf::Property.instance_id` ). If multiple properties in an OVF package have the same fully-qualified name, then the property is excluded and cannot be set. We do warn about this during import.
See :func:`Com::Vmware::Vcenter::Ovf::LibraryItem.deploy` and :func:`Com::Vmware::Vcenter::Ovf::LibraryItem.filter` .
Instance Attribute Summary (collapse)
-
- (String) category
If this is set to a non-empty string, this property starts a new category.
-
- (String) class_id
The classId of this OVF property.
-
- (String) description
A description of this OVF property.
-
- (String) id
The identifier of this OVF property.
-
- (String) instance_id
The instanceId of this OVF property.
-
- (String) label
The display name of this OVF property.
-
- (String) type
The type of this OVF property.
-
- (Boolean) ui_optional
Whether a category is UI optional.
-
- (String) value
The OVF property value.
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)
-
- (Property) initialize(ruby_values = nil, struct_value = nil)
constructor
Constructs a new instance.
Constructor Details
- (Property) initialize(ruby_values = nil, struct_value = nil)
Constructs a new instance.
2134 2135 2136 |
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 2134 def initialize(ruby_values=nil, struct_value=nil) super(self.class.binding_type, ruby_values, struct_value) end |
Instance Attribute Details
- (String) category
If this is set to a non-empty string, this property starts a new category. 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 , the property is in the same category as the previous item, otherwise, it starts a new category.
2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 |
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 2095 class Property < 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.property', { 'class_id' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), 'id' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), 'instance_id' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), 'category' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), 'ui_optional' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance), 'label' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), 'description' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), 'type' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), 'value' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), }, Property, false, nil) end end attr_accessor :class_id, :id, :instance_id, :category, :ui_optional, :label, :description, :type, :value # 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) class_id
The classId of this OVF property. 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.
2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 |
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 2095 class Property < 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.property', { 'class_id' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), 'id' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), 'instance_id' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), 'category' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), 'ui_optional' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance), 'label' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), 'description' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), 'type' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), 'value' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), }, Property, false, nil) end end attr_accessor :class_id, :id, :instance_id, :category, :ui_optional, :label, :description, :type, :value # 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 description of this OVF property. 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.
2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 |
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 2095 class Property < 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.property', { 'class_id' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), 'id' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), 'instance_id' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), 'category' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), 'ui_optional' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance), 'label' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), 'description' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), 'type' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), 'value' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), }, Property, false, nil) end end attr_accessor :class_id, :id, :instance_id, :category, :ui_optional, :label, :description, :type, :value # 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 this OVF property. 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.
2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 |
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 2095 class Property < 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.property', { 'class_id' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), 'id' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), 'instance_id' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), 'category' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), 'ui_optional' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance), 'label' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), 'description' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), 'type' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), 'value' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), }, Property, false, nil) end end attr_accessor :class_id, :id, :instance_id, :category, :ui_optional, :label, :description, :type, :value # 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) instance_id
The instanceId of this OVF property. 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.
2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 |
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 2095 class Property < 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.property', { 'class_id' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), 'id' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), 'instance_id' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), 'category' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), 'ui_optional' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance), 'label' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), 'description' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), 'type' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), 'value' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), }, Property, false, nil) end end attr_accessor :class_id, :id, :instance_id, :category, :ui_optional, :label, :description, :type, :value # 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
The display name of this OVF property. 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.
2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 |
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 2095 class Property < 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.property', { 'class_id' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), 'id' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), 'instance_id' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), 'category' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), 'ui_optional' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance), 'label' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), 'description' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), 'type' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), 'value' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), }, Property, false, nil) end end attr_accessor :class_id, :id, :instance_id, :category, :ui_optional, :label, :description, :type, :value # 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) type
The type of this OVF property. Refer to the configuration of a virtual appliance/virtual machine for the valid values. 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.
2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 |
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 2095 class Property < 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.property', { 'class_id' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), 'id' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), 'instance_id' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), 'category' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), 'ui_optional' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance), 'label' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), 'description' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), 'type' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), 'value' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), }, Property, false, nil) end end attr_accessor :class_id, :id, :instance_id, :category, :ui_optional, :label, :description, :type, :value # 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 |
- (Boolean) ui_optional
Whether a category is UI optional. This is only used if this property starts a new category (see :attr:`Com::Vmware::Vcenter::Ovf::Property.category` ).
The value is stored in an optional attribute vmw:uioptional to the ovf:Category element. The default value is false. If this value is true, the properties within this category are optional. The UI renders this as a group with a check box, and the group is grayed out until the check box is selected. When the check box is selected, the input values are read and used in deployment. If properties within the same category specify conflicting values the default is used. Only implemented in vSphere Web Client 5.1 and later as of Nov 2012.
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.
2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 |
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 2095 class Property < 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.property', { 'class_id' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), 'id' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), 'instance_id' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), 'category' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), 'ui_optional' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance), 'label' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), 'description' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), 'type' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), 'value' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), }, Property, false, nil) end end attr_accessor :class_id, :id, :instance_id, :category, :ui_optional, :label, :description, :type, :value # 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) value
The OVF property value. This contains the default value from ovf:defaultValue if ovf:value is not present when read. 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.
2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 |
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 2095 class Property < 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.property', { 'class_id' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), 'id' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), 'instance_id' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), 'category' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), 'ui_optional' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance), 'label' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), 'description' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), 'type' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), 'value' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), }, Property, false, nil) end end attr_accessor :class_id, :id, :instance_id, :category, :ui_optional, :label, :description, :type, :value # 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.
2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 |
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 2101 def binding_type @binding_type ||= VAPI::Bindings::StructType.new( 'com.vmware.vcenter.ovf.property', { 'class_id' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), 'id' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), 'instance_id' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), 'category' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), 'ui_optional' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance), 'label' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), 'description' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), 'type' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), 'value' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), }, Property, false, nil) end |