Class: IbmCloudPower::SSHKeysApi

Inherits:
Object
  • Object
show all
Defined in:
lib/ibm_cloud_power/api/ssh_keys_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SSHKeysApi

Returns a new instance of SSHKeysApi.



19
20
21
 
# File 'lib/ibm_cloud_power/api/ssh_keys_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/ibm_cloud_power/api/ssh_keys_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#v1_sshkeys_delete(sshkey_id, opts = {}) ⇒ Object

Delete ssh-key

Parameters:

  • sshkey_id (String) —

    SSH Key ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Object) 


26
27
28
29
 
# File 'lib/ibm_cloud_power/api/ssh_keys_api.rb', line 26

def v1_sshkeys_delete(sshkey_id, opts = {})
  data, _status_code, _headers = v1_sshkeys_delete_with_http_info(sshkey_id, opts)
  data
end

#v1_sshkeys_delete_with_http_info(sshkey_id, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Delete ssh-key

Parameters:

  • sshkey_id (String) —

    SSH Key ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/ibm_cloud_power/api/ssh_keys_api.rb', line 35

def v1_sshkeys_delete_with_http_info(sshkey_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SSHKeysApi.v1_sshkeys_delete ...'
  end
  # verify the required parameter 'sshkey_id' is set
  if @api_client.config.client_side_validation && sshkey_id.nil?
    fail ArgumentError, "Missing the required parameter 'sshkey_id' when calling SSHKeysApi.v1_sshkeys_delete"
  end
  # resource path
  local_var_path = '/v1/ssh-keys/{sshkey_id}'.sub('{sshkey_id}', CGI.escape(sshkey_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"SSHKeysApi.v1_sshkeys_delete",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SSHKeysApi#v1_sshkeys_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#v1_sshkeys_get(sshkey_id, opts = {}) ⇒ WorkspaceSSHKey

Get ssh-key information

Parameters:

  • sshkey_id (String) —

    SSH Key ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



87
88
89
90
 
# File 'lib/ibm_cloud_power/api/ssh_keys_api.rb', line 87

def v1_sshkeys_get(sshkey_id, opts = {})
  data, _status_code, _headers = v1_sshkeys_get_with_http_info(sshkey_id, opts)
  data
end

#v1_sshkeys_get_with_http_info(sshkey_id, opts = {}) ⇒ Array<(WorkspaceSSHKey, Integer, Hash)>

Get ssh-key information

Parameters:

  • sshkey_id (String) —

    SSH Key ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(WorkspaceSSHKey, Integer, Hash)>) —

    WorkspaceSSHKey data, response status code and response headers



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/ibm_cloud_power/api/ssh_keys_api.rb', line 96

def v1_sshkeys_get_with_http_info(sshkey_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SSHKeysApi.v1_sshkeys_get ...'
  end
  # verify the required parameter 'sshkey_id' is set
  if @api_client.config.client_side_validation && sshkey_id.nil?
    fail ArgumentError, "Missing the required parameter 'sshkey_id' when calling SSHKeysApi.v1_sshkeys_get"
  end
  # resource path
  local_var_path = '/v1/ssh-keys/{sshkey_id}'.sub('{sshkey_id}', CGI.escape(sshkey_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'WorkspaceSSHKey'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"SSHKeysApi.v1_sshkeys_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SSHKeysApi#v1_sshkeys_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#v1_sshkeys_getall(opts = {}) ⇒ WorkspaceSSHKeys

List SSH Keys

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



147
148
149
150
 
# File 'lib/ibm_cloud_power/api/ssh_keys_api.rb', line 147

def v1_sshkeys_getall(opts = {})
  data, _status_code, _headers = v1_sshkeys_getall_with_http_info(opts)
  data
end

#v1_sshkeys_getall_with_http_info(opts = {}) ⇒ Array<(WorkspaceSSHKeys, Integer, Hash)>

List SSH Keys

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(WorkspaceSSHKeys, Integer, Hash)>) —

    WorkspaceSSHKeys data, response status code and response headers



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/ibm_cloud_power/api/ssh_keys_api.rb', line 155

def v1_sshkeys_getall_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SSHKeysApi.v1_sshkeys_getall ...'
  end
  # resource path
  local_var_path = '/v1/ssh-keys'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'WorkspaceSSHKeys'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"SSHKeysApi.v1_sshkeys_getall",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SSHKeysApi#v1_sshkeys_getall\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#v1_sshkeys_post(body, opts = {}) ⇒ WorkspaceSSHKey

Add a new SSH key

Parameters:

  • body (CreateWorkspaceSSHKey) —

    Parameters for the creation of a new SSH key

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



203
204
205
206
 
# File 'lib/ibm_cloud_power/api/ssh_keys_api.rb', line 203

def v1_sshkeys_post(body, opts = {})
  data, _status_code, _headers = v1_sshkeys_post_with_http_info(body, opts)
  data
end

#v1_sshkeys_post_with_http_info(body, opts = {}) ⇒ Array<(WorkspaceSSHKey, Integer, Hash)>

Add a new SSH key

Parameters:

  • body (CreateWorkspaceSSHKey) —

    Parameters for the creation of a new SSH key

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(WorkspaceSSHKey, Integer, Hash)>) —

    WorkspaceSSHKey data, response status code and response headers



212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/ibm_cloud_power/api/ssh_keys_api.rb', line 212

def v1_sshkeys_post_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SSHKeysApi.v1_sshkeys_post ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling SSHKeysApi.v1_sshkeys_post"
  end
  # resource path
  local_var_path = '/v1/ssh-keys'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'WorkspaceSSHKey'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"SSHKeysApi.v1_sshkeys_post",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SSHKeysApi#v1_sshkeys_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#v1_sshkeys_put(sshkey_id, body, opts = {}) ⇒ WorkspaceSSHKey

Update the ssh key

Parameters:

  • sshkey_id (String) —

    SSH Key ID

  • body (UpdateWorkspaceSSHKey) —

    Parameter for updating SSH key

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



270
271
272
273
 
# File 'lib/ibm_cloud_power/api/ssh_keys_api.rb', line 270

def v1_sshkeys_put(sshkey_id, body, opts = {})
  data, _status_code, _headers = v1_sshkeys_put_with_http_info(sshkey_id, body, opts)
  data
end

#v1_sshkeys_put_with_http_info(sshkey_id, body, opts = {}) ⇒ Array<(WorkspaceSSHKey, Integer, Hash)>

Update the ssh key

Parameters:

  • sshkey_id (String) —

    SSH Key ID

  • body (UpdateWorkspaceSSHKey) —

    Parameter for updating SSH key

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(WorkspaceSSHKey, Integer, Hash)>) —

    WorkspaceSSHKey data, response status code and response headers



280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/ibm_cloud_power/api/ssh_keys_api.rb', line 280

def v1_sshkeys_put_with_http_info(sshkey_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SSHKeysApi.v1_sshkeys_put ...'
  end
  # verify the required parameter 'sshkey_id' is set
  if @api_client.config.client_side_validation && sshkey_id.nil?
    fail ArgumentError, "Missing the required parameter 'sshkey_id' when calling SSHKeysApi.v1_sshkeys_put"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling SSHKeysApi.v1_sshkeys_put"
  end
  # resource path
  local_var_path = '/v1/ssh-keys/{sshkey_id}'.sub('{sshkey_id}', CGI.escape(sshkey_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'WorkspaceSSHKey'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"SSHKeysApi.v1_sshkeys_put",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SSHKeysApi#v1_sshkeys_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end