class Comet::SFTPDestinationLocation
SFTPDestinationLocation
is a typed class wrapper around the underlying Comet
Server API data structure.
Attributes
sftpauth_mode[RW]
@type [Number] sftpauth_mode
sftpcustom_auth__known_hosts_file[RW]
@type [String] sftpcustom_auth__known_hosts_file
sftpcustom_auth__use_known_hosts_file[RW]
@type [Boolean] sftpcustom_auth__use_known_hosts_file
sftppassword[RW]
@type [String] sftppassword
sftpprivate_key[RW]
@type [String] sftpprivate_key
sftpremote_path[RW]
@type [String] sftpremote_path
sftpserver[RW]
@type [String] sftpserver
sftpusername[RW]
@type [String] sftpusername
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/sftpdestination_location.rb, line 44 def initialize clear end
Public Instance Methods
clear()
click to toggle source
# 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)
click to toggle source
@param [Hash] obj The complete object as a Ruby hash
# 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)
click to toggle source
@param [String] json_string The complete object in JSON format
# 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()
click to toggle source
@return [Hash] The complete object as a Ruby hash
# File lib/comet/models/sftpdestination_location.rb, line 126 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/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 = {})
click to toggle source
@return [String] The complete object as a JSON string
# File lib/comet/models/sftpdestination_location.rb, line 131 def to_json(options = {}) to_hash.to_json(options) end