Class: VSphereAutomation::VCenter::VcenterVmHardwareSerialInfo

Inherits:
Object
  • Object
show all
Defined in:
lib/vsphere-automation-vcenter/models/vcenter_vm_hardware_serial_info.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ VcenterVmHardwareSerialInfo

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/vsphere-automation-vcenter/models/vcenter_vm_hardware_serial_info.rb', line 56

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?(:'label')
    self.label = attributes[:'label']
  end

  if attributes.has_key?(:'yield_on_poll')
    self.yield_on_poll = attributes[:'yield_on_poll']
  end

  if attributes.has_key?(:'backing')
    self.backing = attributes[:'backing']
  end

  if attributes.has_key?(:'state')
    self.state = attributes[:'state']
  end

  if attributes.has_key?(:'start_connected')
    self.start_connected = attributes[:'start_connected']
  end

  if attributes.has_key?(:'allow_guest_control')
    self.allow_guest_control = attributes[:'allow_guest_control']
  end
end

Instance Attribute Details

#allow_guest_control ⇒ Object

Flag indicating whether the guest can connect and disconnect the device.



28
29
30
 
# File 'lib/vsphere-automation-vcenter/models/vcenter_vm_hardware_serial_info.rb', line 28

def allow_guest_control
  @allow_guest_control
end

#backing ⇒ Object

Returns the value of attribute backing.



20
21
22
 
# File 'lib/vsphere-automation-vcenter/models/vcenter_vm_hardware_serial_info.rb', line 20

def backing
  @backing
end

#label ⇒ Object

Device label.



15
16
17
 
# File 'lib/vsphere-automation-vcenter/models/vcenter_vm_hardware_serial_info.rb', line 15

def label
  @label
end

#start_connected ⇒ Object

Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on.



25
26
27
 
# File 'lib/vsphere-automation-vcenter/models/vcenter_vm_hardware_serial_info.rb', line 25

def start_connected
  @start_connected
end

#state ⇒ Object

Returns the value of attribute state.



22
23
24
 
# File 'lib/vsphere-automation-vcenter/models/vcenter_vm_hardware_serial_info.rb', line 22

def state
  @state
end

#yield_on_poll ⇒ Object

CPU yield behavior. If set to true, the virtual machine will periodically relinquish the processor if its sole task is polling the virtual serial port. The amount of time it takes to regain the processor will depend on the degree of other virtual machine activity on the host.



18
19
20
 
# File 'lib/vsphere-automation-vcenter/models/vcenter_vm_hardware_serial_info.rb', line 18

def yield_on_poll
  @yield_on_poll
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



31
32
33
34
35
36
37
38
39
40
 
# File 'lib/vsphere-automation-vcenter/models/vcenter_vm_hardware_serial_info.rb', line 31

def self.attribute_map
  {
    :'label' => :'label',
    :'yield_on_poll' => :'yield_on_poll',
    :'backing' => :'backing',
    :'state' => :'state',
    :'start_connected' => :'start_connected',
    :'allow_guest_control' => :'allow_guest_control'
  }
end

.openapi_types ⇒ Object

Attribute type mapping.



43
44
45
46
47
48
49
50
51
52
 
# File 'lib/vsphere-automation-vcenter/models/vcenter_vm_hardware_serial_info.rb', line 43

def self.openapi_types
  {
    :'label' => :'String',
    :'yield_on_poll' => :'Boolean',
    :'backing' => :'VcenterVmHardwareSerialBackingInfo',
    :'state' => :'VcenterVmHardwareConnectionState',
    :'start_connected' => :'Boolean',
    :'allow_guest_control' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



132
133
134
135
136
137
138
139
140
141
 
# File 'lib/vsphere-automation-vcenter/models/vcenter_vm_hardware_serial_info.rb', line 132

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      label == o.label &&
      yield_on_poll == o.yield_on_poll &&
      backing == o.backing &&
      state == o.state &&
      start_connected == o.start_connected &&
      allow_guest_control == o.allow_guest_control
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



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
212
213
214
215
 
# File 'lib/vsphere-automation-vcenter/models/vcenter_vm_hardware_serial_info.rb', line 179

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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/vsphere-automation-vcenter/models/vcenter_vm_hardware_serial_info.rb', line 245

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

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/vsphere-automation-vcenter/models/vcenter_vm_hardware_serial_info.rb', line 158

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


145
146
147
 
# File 'lib/vsphere-automation-vcenter/models/vcenter_vm_hardware_serial_info.rb', line 145

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



151
152
153
 
# File 'lib/vsphere-automation-vcenter/models/vcenter_vm_hardware_serial_info.rb', line 151

def hash
  [label, yield_on_poll, backing, state, start_connected, allow_guest_control].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/vsphere-automation-vcenter/models/vcenter_vm_hardware_serial_info.rb', line 89

def list_invalid_properties
  invalid_properties = Array.new
  if @label.nil?
    invalid_properties.push('invalid value for "label", label cannot be nil.')
  end

  if @yield_on_poll.nil?
    invalid_properties.push('invalid value for "yield_on_poll", yield_on_poll cannot be nil.')
  end

  if @backing.nil?
    invalid_properties.push('invalid value for "backing", backing cannot be nil.')
  end

  if @state.nil?
    invalid_properties.push('invalid value for "state", state cannot be nil.')
  end

  if @start_connected.nil?
    invalid_properties.push('invalid value for "start_connected", start_connected cannot be nil.')
  end

  if @allow_guest_control.nil?
    invalid_properties.push('invalid value for "allow_guest_control", allow_guest_control cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



225
226
227
 
# File 'lib/vsphere-automation-vcenter/models/vcenter_vm_hardware_serial_info.rb', line 225

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



231
232
233
234
235
236
237
238
239
 
# File 'lib/vsphere-automation-vcenter/models/vcenter_vm_hardware_serial_info.rb', line 231

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

Returns:

  • (String) —

    String presentation of the object



219
220
221
 
# File 'lib/vsphere-automation-vcenter/models/vcenter_vm_hardware_serial_info.rb', line 219

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



120
121
122
123
124
125
126
127
128
 
# File 'lib/vsphere-automation-vcenter/models/vcenter_vm_hardware_serial_info.rb', line 120

def valid?
  return false if @label.nil?
  return false if @yield_on_poll.nil?
  return false if @backing.nil?
  return false if @state.nil?
  return false if @start_connected.nil?
  return false if @allow_guest_control.nil?
  true
end