Class: VSphereAutomation::VCenter::VcenterVmHardwareSerialBackingInfo
- Inherits:
-
Object
- Object
- VSphereAutomation::VCenter::VcenterVmHardwareSerialBackingInfo
- Defined in:
- lib/vsphere-automation-vcenter/models/vcenter_vm_hardware_serial_backing_info.rb
Instance Attribute Summary collapse
-
#auto_detect ⇒ Object
Flag indicating whether the virtual serial port is configured to automatically detect a suitable host device.
-
#file ⇒ Object
Path of the file backing the virtual serial port.
-
#host_device ⇒ Object
Name of the device backing the virtual serial port.
-
#network_location ⇒ Object
URI specifying the location of the network service backing the virtual serial port.
-
#no_rx_loss ⇒ Object
Flag that enables optimized data transfer over the pipe.
-
#pipe ⇒ Object
Name of the pipe backing the virtual serial port.
-
#proxy ⇒ Object
Proxy service that provides network access to the network backing.
-
#type ⇒ Object
Returns the value of attribute type.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.openapi_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ VcenterVmHardwareSerialBackingInfo
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ VcenterVmHardwareSerialBackingInfo
Initializes the object
67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 |
# File 'lib/vsphere-automation-vcenter/models/vcenter_vm_hardware_serial_backing_info.rb', line 67 def initialize(attributes = {}) return unless attributes.is_a?(Hash) # convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v } if attributes.has_key?(:'type') self.type = attributes[:'type'] end if attributes.has_key?(:'file') self.file = attributes[:'file'] end if attributes.has_key?(:'host_device') self.host_device = attributes[:'host_device'] end if attributes.has_key?(:'auto_detect') self.auto_detect = attributes[:'auto_detect'] end if attributes.has_key?(:'pipe') self.pipe = attributes[:'pipe'] end if attributes.has_key?(:'no_rx_loss') self.no_rx_loss = attributes[:'no_rx_loss'] end if attributes.has_key?(:'network_location') self.network_location = attributes[:'network_location'] end if attributes.has_key?(:'proxy') self.proxy = attributes[:'proxy'] end end |
Instance Attribute Details
#auto_detect ⇒ Object
Flag indicating whether the virtual serial port is configured to automatically detect a suitable host device. This field is optional and it is only relevant when the value of Serial.BackingInfo.type is HOST_DEVICE.
23 24 25 |
# File 'lib/vsphere-automation-vcenter/models/vcenter_vm_hardware_serial_backing_info.rb', line 23 def auto_detect @auto_detect end |
#file ⇒ Object
Path of the file backing the virtual serial port. This field is optional and it is only relevant when the value of Serial.BackingInfo.type is FILE.
17 18 19 |
# File 'lib/vsphere-automation-vcenter/models/vcenter_vm_hardware_serial_backing_info.rb', line 17 def file @file end |
#host_device ⇒ Object
Name of the device backing the virtual serial port. This field will be unset if Serial.BackingInfo.auto-detect is true and the virtual serial port is not connected or no suitable device is available on the host.
20 21 22 |
# File 'lib/vsphere-automation-vcenter/models/vcenter_vm_hardware_serial_backing_info.rb', line 20 def host_device @host_device end |
#network_location ⇒ Object
URI specifying the location of the network service backing the virtual serial port. - If Serial.BackingInfo.type is NETWORK_SERVER, this field is the location used by clients to connect to this server. The hostname part of the URI should either be empty or should specify the address of the host on which the virtual machine is running. - If Serial.BackingInfo.type is NETWORK_CLIENT, this field is the location used by the virtual machine to connect to the remote server. This field is optional and it is only relevant when the value of Serial.BackingInfo.type is one of NETWORK_SERVER or NETWORK_CLIENT.
32 33 34 |
# File 'lib/vsphere-automation-vcenter/models/vcenter_vm_hardware_serial_backing_info.rb', line 32 def network_location @network_location end |
#no_rx_loss ⇒ Object
Flag that enables optimized data transfer over the pipe. When the value is true, the host buffers data to prevent data overrun. This allows the virtual machine to read all of the data transferred over the pipe with no data loss. This field is optional and it is only relevant when the value of Serial.BackingInfo.type is one of PIPE_SERVER or PIPE_CLIENT.
29 30 31 |
# File 'lib/vsphere-automation-vcenter/models/vcenter_vm_hardware_serial_backing_info.rb', line 29 def no_rx_loss @no_rx_loss end |
#pipe ⇒ Object
Name of the pipe backing the virtual serial port. This field is optional and it is only relevant when the value of Serial.BackingInfo.type is one of PIPE_SERVER or PIPE_CLIENT.
26 27 28 |
# File 'lib/vsphere-automation-vcenter/models/vcenter_vm_hardware_serial_backing_info.rb', line 26 def pipe @pipe end |
#proxy ⇒ Object
Proxy service that provides network access to the network backing. If set, the virtual machine initiates a connection with the proxy service and forwards the traffic to the proxy. If unset, no proxy service is configured.
35 36 37 |
# File 'lib/vsphere-automation-vcenter/models/vcenter_vm_hardware_serial_backing_info.rb', line 35 def proxy @proxy end |
#type ⇒ Object
Returns the value of attribute type.
14 15 16 |
# File 'lib/vsphere-automation-vcenter/models/vcenter_vm_hardware_serial_backing_info.rb', line 14 def type @type end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
38 39 40 41 42 43 44 45 46 47 48 49 |
# File 'lib/vsphere-automation-vcenter/models/vcenter_vm_hardware_serial_backing_info.rb', line 38 def self.attribute_map { :'type' => :'type', :'file' => :'file', :'host_device' => :'host_device', :'auto_detect' => :'auto_detect', :'pipe' => :'pipe', :'no_rx_loss' => :'no_rx_loss', :'network_location' => :'network_location', :'proxy' => :'proxy' } end |
.openapi_types ⇒ Object
Attribute type mapping.
52 53 54 55 56 57 58 59 60 61 62 63 |
# File 'lib/vsphere-automation-vcenter/models/vcenter_vm_hardware_serial_backing_info.rb', line 52 def self.openapi_types { :'type' => :'VcenterVmHardwareSerialBackingType', :'file' => :'String', :'host_device' => :'String', :'auto_detect' => :'Boolean', :'pipe' => :'String', :'no_rx_loss' => :'Boolean', :'network_location' => :'String', :'proxy' => :'String' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
126 127 128 129 130 131 132 133 134 135 136 137 |
# File 'lib/vsphere-automation-vcenter/models/vcenter_vm_hardware_serial_backing_info.rb', line 126 def ==(o) return true if self.equal?(o) self.class == o.class && type == o.type && file == o.file && host_device == o.host_device && auto_detect == o.auto_detect && pipe == o.pipe && no_rx_loss == o.no_rx_loss && network_location == o.network_location && proxy == o.proxy end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 |
# File 'lib/vsphere-automation-vcenter/models/vcenter_vm_hardware_serial_backing_info.rb', line 175 def _deserialize(type, value) case type.to_sym when :DateTime DateTime.parse(value) when :Date Date.parse(value) when :String value.to_s when :Integer value.to_i when :Float value.to_f when :BOOLEAN, :Boolean if value.to_s =~ /\A(true|t|yes|y|1)\z/i true else false end when :Object # generic object (usually a Hash), return directly value when /\AArray<(?<inner_type>.+)>\z/ inner_type = Regexp.last_match[:inner_type] value.map { |v| _deserialize(inner_type, v) } when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/ k_type = Regexp.last_match[:k_type] v_type = Regexp.last_match[:v_type] {}.tap do |hash| value.each do |k, v| hash[_deserialize(k_type, k)] = _deserialize(v_type, v) end end else # model temp_model = VSphereAutomation::VCenter.const_get(type).new temp_model.build_from_hash(value) end end |
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
241 242 243 244 245 246 247 248 249 250 251 252 253 |
# File 'lib/vsphere-automation-vcenter/models/vcenter_vm_hardware_serial_backing_info.rb', line 241 def _to_hash(value) if value.is_a?(Array) value.compact.map { |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to? :to_hash value.to_hash else value end end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 |
# File 'lib/vsphere-automation-vcenter/models/vcenter_vm_hardware_serial_backing_info.rb', line 154 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.openapi_types.each_pair do |key, type| if type =~ /\AArray<(.*)>/i # check to ensure the input is an array given that the the attribute # is documented as an array but the input is not if attributes[self.class.attribute_map[key]].is_a?(Array) self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) end elsif !attributes[self.class.attribute_map[key]].nil? self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) end # or else data not found in attributes(hash), not an issue as the data can be optional end self end |
#eql?(o) ⇒ Boolean
141 142 143 |
# File 'lib/vsphere-automation-vcenter/models/vcenter_vm_hardware_serial_backing_info.rb', line 141 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
147 148 149 |
# File 'lib/vsphere-automation-vcenter/models/vcenter_vm_hardware_serial_backing_info.rb', line 147 def hash [type, file, host_device, auto_detect, pipe, no_rx_loss, network_location, proxy].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
108 109 110 111 112 113 114 115 |
# File 'lib/vsphere-automation-vcenter/models/vcenter_vm_hardware_serial_backing_info.rb', line 108 def list_invalid_properties invalid_properties = Array.new if @type.nil? invalid_properties.push('invalid value for "type", type cannot be nil.') end invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
221 222 223 |
# File 'lib/vsphere-automation-vcenter/models/vcenter_vm_hardware_serial_backing_info.rb', line 221 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
227 228 229 230 231 232 233 234 235 |
# File 'lib/vsphere-automation-vcenter/models/vcenter_vm_hardware_serial_backing_info.rb', line 227 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) next if value.nil? hash[param] = _to_hash(value) end hash end |
#to_s ⇒ String
Returns the string representation of the object
215 216 217 |
# File 'lib/vsphere-automation-vcenter/models/vcenter_vm_hardware_serial_backing_info.rb', line 215 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
119 120 121 122 |
# File 'lib/vsphere-automation-vcenter/models/vcenter_vm_hardware_serial_backing_info.rb', line 119 def valid? return false if @type.nil? true end |