Class: Comet::FTPDestinationLocation

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ FTPDestinationLocation

Returns a new instance of FTPDestinationLocation.



47
48
49
 
# File 'lib/comet/models/ftpdestination_location.rb', line 47

def initialize
  clear
end

Instance Attribute Details

#ftpaccept_invalid_ssl ⇒ Object

Returns the value of attribute ftpaccept_invalid_ssl.



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

def ftpaccept_invalid_ssl
  @ftpaccept_invalid_ssl
end

#ftpbase_use_home_directory ⇒ Object

Returns the value of attribute ftpbase_use_home_directory.



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

def ftpbase_use_home_directory
  @ftpbase_use_home_directory
end

#ftpcustom_base_directory ⇒ Object

Returns the value of attribute ftpcustom_base_directory.



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

def ftpcustom_base_directory
  @ftpcustom_base_directory
end

#ftpmax_connections ⇒ Object

Returns the value of attribute ftpmax_connections.



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

def ftpmax_connections
  @ftpmax_connections
end

#ftppassword ⇒ Object

Returns the value of attribute ftppassword.



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

def ftppassword
  @ftppassword
end

#ftpport ⇒ Object

Returns the value of attribute ftpport.



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

def ftpport
  @ftpport
end

#ftpserver ⇒ Object

Returns the value of attribute ftpserver.



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

def ftpserver
  @ftpserver
end

#ftpsmode ⇒ Object

Returns the value of attribute ftpsmode.



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

def ftpsmode
  @ftpsmode
end

#ftpusername ⇒ Object

Returns the value of attribute ftpusername.



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

def ftpusername
  @ftpusername
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



45
46
47
 
# File 'lib/comet/models/ftpdestination_location.rb', line 45

def unknown_json_fields
  @unknown_json_fields
end

Instance Method Details

#clear ⇒ Object 



51
52
53
54
55
56
57
58
59
60
 
# File 'lib/comet/models/ftpdestination_location.rb', line 51

def clear
  @ftpserver = ''
  @ftpusername = ''
  @ftppassword = ''
  @ftpcustom_base_directory = ''
  @ftpsmode = 0
  @ftpport = 0
  @ftpmax_connections = 0
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash



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
107
108
109
110
111
 
# File 'lib/comet/models/ftpdestination_location.rb', line 70

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

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

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

      @ftppassword = v
    when 'FTPBaseUseHomeDirectory'
      @ftpbase_use_home_directory = v
    when 'FTPCustomBaseDirectory'
      raise TypeError "'v' expected String, got #{v.class}" unless v.is_a? String

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

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

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

      @ftpmax_connections = v
    when 'FTPAcceptInvalidSSL'
      @ftpaccept_invalid_ssl = 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



63
64
65
66
67
 
# File 'lib/comet/models/ftpdestination_location.rb', line 63

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



132
133
134
 
# File 'lib/comet/models/ftpdestination_location.rb', line 132

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



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/comet/models/ftpdestination_location.rb', line 114

def to_hash
  ret = {}
  ret['FTPServer'] = @ftpserver
  ret['FTPUsername'] = @ftpusername
  ret['FTPPassword'] = @ftppassword
  ret['FTPBaseUseHomeDirectory'] = @ftpbase_use_home_directory
  ret['FTPCustomBaseDirectory'] = @ftpcustom_base_directory
  ret['FTPSMode'] = @ftpsmode
  ret['FTPPort'] = @ftpport
  ret['FTPMaxConnections'] = @ftpmax_connections
  ret['FTPAcceptInvalidSSL'] = @ftpaccept_invalid_ssl
  @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



137
138
139
 
# File 'lib/comet/models/ftpdestination_location.rb', line 137

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