Class: Files::SftpHostKey

Inherits:
Object
  • Object
show all
Defined in:
lib/files.com/models/sftp_host_key.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}, options = {}) ⇒ SftpHostKey

Returns a new instance of SftpHostKey.



7
8
9
10
 
# File 'lib/files.com/models/sftp_host_key.rb', line 7

def initialize(attributes = {}, options = {})
  @attributes = attributes || {}
  @options = options || {}
end

Instance Attribute Details

#attributes ⇒ Object (readonly)

Returns the value of attribute attributes.



5
6
7
 
# File 'lib/files.com/models/sftp_host_key.rb', line 5

def attributes
  @attributes
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



5
6
7
 
# File 'lib/files.com/models/sftp_host_key.rb', line 5

def options
  @options
end

Class Method Details

.all(params = {}, options = {}) ⇒ Object 



110
111
112
 
# File 'lib/files.com/models/sftp_host_key.rb', line 110

def self.all(params = {}, options = {})
  list(params, options)
end

.create(params = {}, options = {}) ⇒ Object

Parameters:

name - string - The friendly name of this SFTP Host Key.
private_key - string - The private key data.

Raises:



133
134
135
136
137
138
139
 
# File 'lib/files.com/models/sftp_host_key.rb', line 133

def self.create(params = {}, options = {})
  raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: private_key must be an String") if params[:private_key] and !params[:private_key].is_a?(String)

  response, options = Api.send_request("/sftp_host_keys", :post, params, options)
  SftpHostKey.new(response.data, options)
end

.delete(id, params = {}, options = {}) ⇒ Object

Raises:



156
157
158
159
160
161
162
163
164
 
# File 'lib/files.com/models/sftp_host_key.rb', line 156

def self.delete(id, params = {}, options = {})
  params ||= {}
  params[:id] = id
  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]

  Api.send_request("/sftp_host_keys/#{params[:id]}", :delete, params, options)
  nil
end

.destroy(id, params = {}, options = {}) ⇒ Object 



166
167
168
169
 
# File 'lib/files.com/models/sftp_host_key.rb', line 166

def self.destroy(id, params = {}, options = {})
  delete(id, params, options)
  nil
end

.find(id, params = {}, options = {}) ⇒ Object

Parameters:

id (required) - int64 - Sftp Host Key ID.

Raises:



116
117
118
119
120
121
122
123
124
 
# File 'lib/files.com/models/sftp_host_key.rb', line 116

def self.find(id, params = {}, options = {})
  params ||= {}
  params[:id] = id
  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]

  response, options = Api.send_request("/sftp_host_keys/#{params[:id]}", :get, params, options)
  SftpHostKey.new(response.data, options)
end

.get(id, params = {}, options = {}) ⇒ Object 



126
127
128
 
# File 'lib/files.com/models/sftp_host_key.rb', line 126

def self.get(id, params = {}, options = {})
  find(id, params, options)
end

.list(params = {}, options = {}) ⇒ Object

Parameters:

cursor - string - Used for pagination.  When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`.  Send one of those cursor value here to resume an existing list from the next available record.  Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).

Raises:



101
102
103
104
105
106
107
108
 
# File 'lib/files.com/models/sftp_host_key.rb', line 101

def self.list(params = {}, options = {})
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)

  List.new(SftpHostKey, params) do
    Api.send_request("/sftp_host_keys", :get, params, options)
  end
end

.update(id, params = {}, options = {}) ⇒ Object

Parameters:

name - string - The friendly name of this SFTP Host Key.
private_key - string - The private key data.

Raises:



144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/files.com/models/sftp_host_key.rb', line 144

def self.update(id, params = {}, options = {})
  params ||= {}
  params[:id] = id
  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: private_key must be an String") if params[:private_key] and !params[:private_key].is_a?(String)
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]

  response, options = Api.send_request("/sftp_host_keys/#{params[:id]}", :patch, params, options)
  SftpHostKey.new(response.data, options)
end

Instance Method Details

#delete(params = {}) ⇒ Object

Raises:



72
73
74
75
76
77
78
79
80
 
# File 'lib/files.com/models/sftp_host_key.rb', line 72

def delete(params = {})
  params ||= {}
  params[:id] = @attributes[:id]
  raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]

  Api.send_request("/sftp_host_keys/#{@attributes[:id]}", :delete, params, @options)
end

#destroy(params = {}) ⇒ Object 



82
83
84
85
 
# File 'lib/files.com/models/sftp_host_key.rb', line 82

def destroy(params = {})
  delete(params)
  nil
end

#fingerprint_md5 ⇒ Object

string - MD5 Fingerpint of the public key



31
32
33
 
# File 'lib/files.com/models/sftp_host_key.rb', line 31

def fingerprint_md5
  @attributes[:fingerprint_md5]
end

#fingerprint_md5=(value) ⇒ Object 



35
36
37
 
# File 'lib/files.com/models/sftp_host_key.rb', line 35

def fingerprint_md5=(value)
  @attributes[:fingerprint_md5] = value
end

#fingerprint_sha256 ⇒ Object

string - SHA256 Fingerpint of the public key



40
41
42
 
# File 'lib/files.com/models/sftp_host_key.rb', line 40

def fingerprint_sha256
  @attributes[:fingerprint_sha256]
end

#fingerprint_sha256=(value) ⇒ Object 



44
45
46
 
# File 'lib/files.com/models/sftp_host_key.rb', line 44

def fingerprint_sha256=(value)
  @attributes[:fingerprint_sha256] = value
end

#id ⇒ Object

int64 - Sftp Host Key ID



13
14
15
 
# File 'lib/files.com/models/sftp_host_key.rb', line 13

def id
  @attributes[:id]
end

#id=(value) ⇒ Object 



17
18
19
 
# File 'lib/files.com/models/sftp_host_key.rb', line 17

def id=(value)
  @attributes[:id] = value
end

#name ⇒ Object

string - The friendly name of this SFTP Host Key.



22
23
24
 
# File 'lib/files.com/models/sftp_host_key.rb', line 22

def name
  @attributes[:name]
end

#name=(value) ⇒ Object 



26
27
28
 
# File 'lib/files.com/models/sftp_host_key.rb', line 26

def name=(value)
  @attributes[:name] = value
end

#private_key ⇒ Object

string - The private key data.



49
50
51
 
# File 'lib/files.com/models/sftp_host_key.rb', line 49

def private_key
  @attributes[:private_key]
end

#private_key=(value) ⇒ Object 



53
54
55
 
# File 'lib/files.com/models/sftp_host_key.rb', line 53

def private_key=(value)
  @attributes[:private_key] = value
end

#save ⇒ Object 



87
88
89
90
91
92
93
94
95
96
 
# File 'lib/files.com/models/sftp_host_key.rb', line 87

def save
  if @attributes[:id]
    new_obj = update(@attributes)
  else
    new_obj = SftpHostKey.create(@attributes, @options)
  end

  @attributes = new_obj.attributes
  true
end

#update(params = {}) ⇒ Object

Parameters:

name - string - The friendly name of this SFTP Host Key.
private_key - string - The private key data.

Raises:



60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/files.com/models/sftp_host_key.rb', line 60

def update(params = {})
  params ||= {}
  params[:id] = @attributes[:id]
  raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: private_key must be an String") if params[:private_key] and !params[:private_key].is_a?(String)
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]

  Api.send_request("/sftp_host_keys/#{@attributes[:id]}", :patch, params, @options)
end