Class: IbmCloudPower::RoutesApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ RoutesApi

Returns a new instance of RoutesApi.



19
20
21
 
# File 'lib/ibm_cloud_power/api/routes_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/routes_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#v1_routes_delete(route_id, opts = {}) ⇒ Object

Delete a route

Parameters:

  • route_id (String) —

    Route ID

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

    the optional parameters

Returns:

  • (Object) 


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

def v1_routes_delete(route_id, opts = {})
  data, _status_code, _headers = v1_routes_delete_with_http_info(route_id, opts)
  data
end

#v1_routes_delete_with_http_info(route_id, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Delete a route

Parameters:

  • route_id (String) —

    Route 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/routes_api.rb', line 35

def v1_routes_delete_with_http_info(route_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RoutesApi.v1_routes_delete ...'
  end
  # verify the required parameter 'route_id' is set
  if @api_client.config.client_side_validation && route_id.nil?
    fail ArgumentError, "Missing the required parameter 'route_id' when calling RoutesApi.v1_routes_delete"
  end
  # resource path
  local_var_path = '/v1/routes/{route_id}'.sub('{route_id}', CGI.escape(route_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 => :"RoutesApi.v1_routes_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: RoutesApi#v1_routes_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#v1_routes_get(route_id, opts = {}) ⇒ Route

Get a route's information

Parameters:

  • route_id (String) —

    Route ID

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

    the optional parameters

Returns:



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

def v1_routes_get(route_id, opts = {})
  data, _status_code, _headers = v1_routes_get_with_http_info(route_id, opts)
  data
end

#v1_routes_get_with_http_info(route_id, opts = {}) ⇒ Array<(Route, Integer, Hash)>

Get a route's information

Parameters:

  • route_id (String) —

    Route ID

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

    the optional parameters

Returns:

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

    Route 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/routes_api.rb', line 96

def v1_routes_get_with_http_info(route_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RoutesApi.v1_routes_get ...'
  end
  # verify the required parameter 'route_id' is set
  if @api_client.config.client_side_validation && route_id.nil?
    fail ArgumentError, "Missing the required parameter 'route_id' when calling RoutesApi.v1_routes_get"
  end
  # resource path
  local_var_path = '/v1/routes/{route_id}'.sub('{route_id}', CGI.escape(route_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] || 'Route'

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

  new_options = opts.merge(
    :operation => :"RoutesApi.v1_routes_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: RoutesApi#v1_routes_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#v1_routes_getall(opts = {}) ⇒ Routes

Get all routes in the workspace

Parameters:

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

    the optional parameters

Returns:



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

def v1_routes_getall(opts = {})
  data, _status_code, _headers = v1_routes_getall_with_http_info(opts)
  data
end

#v1_routes_getall_with_http_info(opts = {}) ⇒ Array<(Routes, Integer, Hash)>

Get all routes in the workspace

Parameters:

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

    the optional parameters

Returns:

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

    Routes 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/routes_api.rb', line 155

def v1_routes_getall_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RoutesApi.v1_routes_getall ...'
  end
  # resource path
  local_var_path = '/v1/routes'

  # 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] || 'Routes'

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

  new_options = opts.merge(
    :operation => :"RoutesApi.v1_routes_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: RoutesApi#v1_routes_getall\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#v1_routes_post(opts = {}) ⇒ Route

Perform a route creation

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (RouteCreate) —

    Create a route based on the inputs

Returns:



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

def v1_routes_post(opts = {})
  data, _status_code, _headers = v1_routes_post_with_http_info(opts)
  data
end

#v1_routes_post_with_http_info(opts = {}) ⇒ Array<(Route, Integer, Hash)>

Perform a route creation

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (RouteCreate) —

    Create a route based on the inputs

Returns:

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

    Route 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
 
# File 'lib/ibm_cloud_power/api/routes_api.rb', line 212

def v1_routes_post_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RoutesApi.v1_routes_post ...'
  end
  # resource path
  local_var_path = '/v1/routes'

  # 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(opts[:'body'])

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

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

  new_options = opts.merge(
    :operation => :"RoutesApi.v1_routes_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: RoutesApi#v1_routes_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#v1_routes_put(route_id, body, opts = {}) ⇒ Route

Update a route's information

Parameters:

  • route_id (String) —

    Route ID

  • body (RouteUpdate) —

    Parameters for updating a route

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

    the optional parameters

Returns:



266
267
268
269
 
# File 'lib/ibm_cloud_power/api/routes_api.rb', line 266

def v1_routes_put(route_id, body, opts = {})
  data, _status_code, _headers = v1_routes_put_with_http_info(route_id, body, opts)
  data
end

#v1_routes_put_with_http_info(route_id, body, opts = {}) ⇒ Array<(Route, Integer, Hash)>

Update a route's information

Parameters:

  • route_id (String) —

    Route ID

  • body (RouteUpdate) —

    Parameters for updating a route

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

    the optional parameters

Returns:

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

    Route data, response status code and response headers



276
277
278
279
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
 
# File 'lib/ibm_cloud_power/api/routes_api.rb', line 276

def v1_routes_put_with_http_info(route_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RoutesApi.v1_routes_put ...'
  end
  # verify the required parameter 'route_id' is set
  if @api_client.config.client_side_validation && route_id.nil?
    fail ArgumentError, "Missing the required parameter 'route_id' when calling RoutesApi.v1_routes_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 RoutesApi.v1_routes_put"
  end
  # resource path
  local_var_path = '/v1/routes/{route_id}'.sub('{route_id}', CGI.escape(route_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] || 'Route'

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

  new_options = opts.merge(
    :operation => :"RoutesApi.v1_routes_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: RoutesApi#v1_routes_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#v1_routes_report_get(opts = {}) ⇒ RouteReport

Get the route report for a workspace

Parameters:

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

    the optional parameters

Returns:



336
337
338
339
 
# File 'lib/ibm_cloud_power/api/routes_api.rb', line 336

def v1_routes_report_get(opts = {})
  data, _status_code, _headers = v1_routes_report_get_with_http_info(opts)
  data
end

#v1_routes_report_get_with_http_info(opts = {}) ⇒ Array<(RouteReport, Integer, Hash)>

Get the route report for a workspace

Parameters:

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

    the optional parameters

Returns:

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

    RouteReport data, response status code and response headers



344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
 
# File 'lib/ibm_cloud_power/api/routes_api.rb', line 344

def v1_routes_report_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RoutesApi.v1_routes_report_get ...'
  end
  # resource path
  local_var_path = '/v1/routes/report'

  # 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] || 'RouteReport'

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

  new_options = opts.merge(
    :operation => :"RoutesApi.v1_routes_report_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: RoutesApi#v1_routes_report_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end