Class: Comet::VMwareConnection

Inherits:
Object
  • Object
show all
Defined in:
lib/comet/models/vmware_connection.rb

Overview

VMwareConnection is a typed class wrapper around the underlying Comet Server API data structure.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ VMwareConnection

Returns a new instance of VMwareConnection.



29
30
31
 
# File 'lib/comet/models/vmware_connection.rb', line 29

def initialize
  clear
end

Instance Attribute Details

#connection_type ⇒ Object

One of the VMWARE_CONNECTION_ constants



17
18
19
 
# File 'lib/comet/models/vmware_connection.rb', line 17

def connection_type
  @connection_type
end

#ssh ⇒ Object

Deprecated.

This member has been deprecated since Comet version 23.9.11



21
22
23
 
# File 'lib/comet/models/vmware_connection.rb', line 21

def ssh
  @ssh
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



27
28
29
 
# File 'lib/comet/models/vmware_connection.rb', line 27

def unknown_json_fields
  @unknown_json_fields
end

#vsphere ⇒ Object

Returns the value of attribute vsphere.



24
25
26
 
# File 'lib/comet/models/vmware_connection.rb', line 24

def vsphere
  @vsphere
end

Instance Method Details

#clear ⇒ Object 



33
34
35
36
37
38
 
# File 'lib/comet/models/vmware_connection.rb', line 33

def clear
  @connection_type = ''
  @ssh = Comet::SSHConnection.new
  @vsphere = Comet::VSphereConnection.new
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash

Raises:

  • (TypeError) 


48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/comet/models/vmware_connection.rb', line 48

def from_hash(obj)
  raise TypeError, "'obj' expected Hash, got #{obj.class}" unless obj.is_a? Hash

  obj.each do |k, v|
    case k
    when 'ConnectionType'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @connection_type = v
    when 'SSH'
      @ssh = Comet::SSHConnection.new
      @ssh.from_hash(v)
    when 'VSphere'
      @vsphere = Comet::VSphereConnection.new
      @vsphere.from_hash(v)
    else
      @unknown_json_fields[k] = v
    end
  end
end

#from_json(json_string) ⇒ Object

Parameters:

  • json_string (String) —

    The complete object in JSON format

Raises:

  • (TypeError) 


41
42
43
44
45
 
# File 'lib/comet/models/vmware_connection.rb', line 41

def from_json(json_string)
  raise TypeError, "'json_string' expected String, got #{json_string.class}" unless json_string.is_a? String

  from_hash(JSON.parse(json_string))
end

#to_h ⇒ Hash

Returns The complete object as a Ruby hash.

Returns:

  • (Hash) —

    The complete object as a Ruby hash



82
83
84
 
# File 'lib/comet/models/vmware_connection.rb', line 82

def to_h
  to_hash
end

#to_hash ⇒ Hash

Returns The complete object as a Ruby hash.

Returns:

  • (Hash) —

    The complete object as a Ruby hash



70
71
72
73
74
75
76
77
78
79
 
# File 'lib/comet/models/vmware_connection.rb', line 70

def to_hash
  ret = {}
  ret['ConnectionType'] = @connection_type
  ret['SSH'] = @ssh
  ret['VSphere'] = @vsphere
  @unknown_json_fields.each do |k, v|
    ret[k] = v
  end
  ret
end

#to_json(options = {}) ⇒ String

Returns The complete object as a JSON string.

Returns:

  • (String) —

    The complete object as a JSON string



87
88
89
 
# File 'lib/comet/models/vmware_connection.rb', line 87

def to_json(options = {})
  to_hash.to_json(options)
end