Class: Comet::SFTPDestinationLocation

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ SFTPDestinationLocation

Returns a new instance of SFTPDestinationLocation.



44
45
46
 
# File 'lib/comet/models/sftpdestination_location.rb', line 44

def initialize
  clear
end

Instance Attribute Details

#sftpauth_mode ⇒ Object

Returns the value of attribute sftpauth_mode.



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

def sftpauth_mode
  @sftpauth_mode
end

#sftpcustom_auth__known_hosts_file ⇒ Object

Returns the value of attribute sftpcustom_auth__known_hosts_file.



39
40
41
 
# File 'lib/comet/models/sftpdestination_location.rb', line 39

def sftpcustom_auth__known_hosts_file
  @sftpcustom_auth__known_hosts_file
end

#sftpcustom_auth__use_known_hosts_file ⇒ Object

Returns the value of attribute sftpcustom_auth__use_known_hosts_file.



36
37
38
 
# File 'lib/comet/models/sftpdestination_location.rb', line 36

def sftpcustom_auth__use_known_hosts_file
  @sftpcustom_auth__use_known_hosts_file
end

#sftppassword ⇒ Object

Returns the value of attribute sftppassword.



30
31
32
 
# File 'lib/comet/models/sftpdestination_location.rb', line 30

def sftppassword
  @sftppassword
end

#sftpprivate_key ⇒ Object

Returns the value of attribute sftpprivate_key.



33
34
35
 
# File 'lib/comet/models/sftpdestination_location.rb', line 33

def sftpprivate_key
  @sftpprivate_key
end

#sftpremote_path ⇒ Object

Returns the value of attribute sftpremote_path.



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

def sftpremote_path
  @sftpremote_path
end

#sftpserver ⇒ Object

Returns the value of attribute sftpserver.



18
19
20
 
# File 'lib/comet/models/sftpdestination_location.rb', line 18

def sftpserver
  @sftpserver
end

#sftpusername ⇒ Object

Returns the value of attribute sftpusername.



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

def sftpusername
  @sftpusername
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



42
43
44
 
# File 'lib/comet/models/sftpdestination_location.rb', line 42

def unknown_json_fields
  @unknown_json_fields
end

Instance Method Details

#clear ⇒ Object 



48
49
50
51
52
53
54
55
56
57
 
# File 'lib/comet/models/sftpdestination_location.rb', line 48

def clear
  @sftpserver = ''
  @sftpusername = ''
  @sftpremote_path = ''
  @sftpauth_mode = 0
  @sftppassword = ''
  @sftpprivate_key = ''
  @sftpcustom_auth__known_hosts_file = ''
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash

Raises:

  • (TypeError) 


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
105
106
 
# File 'lib/comet/models/sftpdestination_location.rb', line 67

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 'SFTPServer'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

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

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

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

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

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

      @sftpprivate_key = v
    when 'SFTPCustomAuth_UseKnownHostsFile'
      @sftpcustom_auth__use_known_hosts_file = v
    when 'SFTPCustomAuth_KnownHostsFile'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @sftpcustom_auth__known_hosts_file = 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) 


60
61
62
63
64
 
# File 'lib/comet/models/sftpdestination_location.rb', line 60

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



126
127
128
 
# File 'lib/comet/models/sftpdestination_location.rb', line 126

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



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/comet/models/sftpdestination_location.rb', line 109

def to_hash
  ret = {}
  ret['SFTPServer'] = @sftpserver
  ret['SFTPUsername'] = @sftpusername
  ret['SFTPRemotePath'] = @sftpremote_path
  ret['SFTPAuthMode'] = @sftpauth_mode
  ret['SFTPPassword'] = @sftppassword
  ret['SFTPPrivateKey'] = @sftpprivate_key
  ret['SFTPCustomAuth_UseKnownHostsFile'] = @sftpcustom_auth__use_known_hosts_file
  ret['SFTPCustomAuth_KnownHostsFile'] = @sftpcustom_auth__known_hosts_file
  @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



131
132
133
 
# File 'lib/comet/models/sftpdestination_location.rb', line 131

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