class Comet::SSHConnection

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

Attributes

sshauth_mode[RW]

@type [Number] sshauth_mode

sshcustom_auth__known_hosts_file[RW]
sshcustom_auth__use_known_hosts_file[RW]
sshpassword[RW]

@type [String] sshpassword

sshprivate_key[RW]

@type [String] sshprivate_key

sshserver[RW]

@type [String] sshserver

sshusername[RW]

@type [String] sshusername

unknown_json_fields[RW]

@type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations

Public Class Methods

new() click to toggle source
# File lib/comet/models/sshconnection.rb, line 41
def initialize
  clear
end

Public Instance Methods

clear() click to toggle source
# File lib/comet/models/sshconnection.rb, line 45
def clear
  @sshserver = ''
  @sshusername = ''
  @sshauth_mode = 0
  @sshpassword = ''
  @sshprivate_key = ''
  @sshcustom_auth__known_hosts_file = ''
  @unknown_json_fields = {}
end
from_hash(obj) click to toggle source

@param [Hash] obj The complete object as a Ruby hash

# File lib/comet/models/sshconnection.rb, line 63
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 'SSHServer'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @sshserver = v
    when 'SSHUsername'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @sshusername = v
    when 'SSHAuthMode'
      raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric

      @sshauth_mode = v
    when 'SSHPassword'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @sshpassword = v
    when 'SSHPrivateKey'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @sshprivate_key = v
    when 'SSHCustomAuth_UseKnownHostsFile'
      @sshcustom_auth__use_known_hosts_file = v
    when 'SSHCustomAuth_KnownHostsFile'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @sshcustom_auth__known_hosts_file = v
    else
      @unknown_json_fields[k] = v
    end
  end
end
from_json(json_string) click to toggle source

@param [String] json_string The complete object in JSON format

# File lib/comet/models/sshconnection.rb, line 56
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() click to toggle source

@return [Hash] The complete object as a Ruby hash

# File lib/comet/models/sshconnection.rb, line 117
def to_h
  to_hash
end
to_hash() click to toggle source

@return [Hash] The complete object as a Ruby hash

# File lib/comet/models/sshconnection.rb, line 101
def to_hash
  ret = {}
  ret['SSHServer'] = @sshserver
  ret['SSHUsername'] = @sshusername
  ret['SSHAuthMode'] = @sshauth_mode
  ret['SSHPassword'] = @sshpassword
  ret['SSHPrivateKey'] = @sshprivate_key
  ret['SSHCustomAuth_UseKnownHostsFile'] = @sshcustom_auth__use_known_hosts_file
  ret['SSHCustomAuth_KnownHostsFile'] = @sshcustom_auth__known_hosts_file
  @unknown_json_fields.each do |k, v|
    ret[k] = v
  end
  ret
end
to_json(options = {}) click to toggle source

@return [String] The complete object as a JSON string

# File lib/comet/models/sshconnection.rb, line 122
def to_json(options = {})
  to_hash.to_json(options)
end