Class: TriglavClient::ResourcesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/triglav_client/api/resources_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ResourcesApi

Returns a new instance of ResourcesApi.



30
31
32
 
# File 'lib/triglav_client/api/resources_api.rb', line 30

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



28
29
30
 
# File 'lib/triglav_client/api/resources_api.rb', line 28

def api_client
  @api_client
end

Instance Method Details

#create_resource(resource, opts = {}) ⇒ ResourceResponse

Creates a new resource

Parameters:

  • resource —

    Resource to add

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

    the optional parameters

Returns:



39
40
41
42
 
# File 'lib/triglav_client/api/resources_api.rb', line 39

def create_resource(resource, opts = {})
  data, _status_code, _headers = create_resource_with_http_info(resource, opts)
  return data
end

#create_resource_with_http_info(resource, opts = {}) ⇒ Array<(ResourceResponse, Fixnum, Hash)>

Creates a new resource

Parameters:

  • resource —

    Resource to add

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

    the optional parameters

Returns:

  • (Array<(ResourceResponse, Fixnum, Hash)>) —

    ResourceResponse data, response status code and response headers



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
82
83
84
85
86
87
88
89
 
# File 'lib/triglav_client/api/resources_api.rb', line 49

def create_resource_with_http_info(resource, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ResourcesApi.create_resource ..."
  end
  # verify the required parameter 'resource' is set
  fail ArgumentError, "Missing the required parameter 'resource' when calling ResourcesApi.create_resource" if resource.nil?
  # resource path
  local_var_path = "/resources".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(resource)
  auth_names = ['api_key']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ResourceResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ResourcesApi#create_resource\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_resource(id_or_uri, opts = {}) ⇒ nil

Deletes single resource

Parameters:

  • id_or_uri —

    ID or URI of resource to fetch

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

    the optional parameters

Returns:

  • (nil) 


96
97
98
99
 
# File 'lib/triglav_client/api/resources_api.rb', line 96

def delete_resource(id_or_uri, opts = {})
  delete_resource_with_http_info(id_or_uri, opts)
  return nil
end

#delete_resource_with_http_info(id_or_uri, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Deletes single resource

Parameters:

  • id_or_uri —

    ID or URI of resource to fetch

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

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



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
143
144
145
 
# File 'lib/triglav_client/api/resources_api.rb', line 106

def delete_resource_with_http_info(id_or_uri, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ResourcesApi.delete_resource ..."
  end
  # verify the required parameter 'id_or_uri' is set
  fail ArgumentError, "Missing the required parameter 'id_or_uri' when calling ResourcesApi.delete_resource" if id_or_uri.nil?
  # resource path
  local_var_path = "/resources/{id_or_uri}".sub('{format}','json').sub('{' + 'id_or_uri' + '}', id_or_uri.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_key']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ResourcesApi#delete_resource\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_resource(id_or_uri, opts = {}) ⇒ ResourceResponse

Returns a single resource

Parameters:

  • id_or_uri —

    ID or URI of resource to fetch

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

    the optional parameters

Returns:



152
153
154
155
 
# File 'lib/triglav_client/api/resources_api.rb', line 152

def get_resource(id_or_uri, opts = {})
  data, _status_code, _headers = get_resource_with_http_info(id_or_uri, opts)
  return data
end

#get_resource_with_http_info(id_or_uri, opts = {}) ⇒ Array<(ResourceResponse, Fixnum, Hash)>

Returns a single resource

Parameters:

  • id_or_uri —

    ID or URI of resource to fetch

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

    the optional parameters

Returns:

  • (Array<(ResourceResponse, Fixnum, Hash)>) —

    ResourceResponse data, response status code and response headers



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
198
199
200
201
202
 
# File 'lib/triglav_client/api/resources_api.rb', line 162

def get_resource_with_http_info(id_or_uri, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ResourcesApi.get_resource ..."
  end
  # verify the required parameter 'id_or_uri' is set
  fail ArgumentError, "Missing the required parameter 'id_or_uri' when calling ResourcesApi.get_resource" if id_or_uri.nil?
  # resource path
  local_var_path = "/resources/{id_or_uri}".sub('{format}','json').sub('{' + 'id_or_uri' + '}', id_or_uri.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_key']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ResourceResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ResourcesApi#get_resource\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_aggregated_resources(uri_prefix, opts = {}) ⇒ Array<AggregatedResourceEachResponse>

Returns aggregated resources to be monitored

Parameters:

  • uri_prefix —

    Prefix of Resource URI

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

    the optional parameters

Returns:



209
210
211
212
 
# File 'lib/triglav_client/api/resources_api.rb', line 209

def list_aggregated_resources(uri_prefix, opts = {})
  data, _status_code, _headers = list_aggregated_resources_with_http_info(uri_prefix, opts)
  return data
end

#list_aggregated_resources_with_http_info(uri_prefix, opts = {}) ⇒ Array<(Array<AggregatedResourceEachResponse>, Fixnum, Hash)>

Returns aggregated resources to be monitored

Parameters:

  • uri_prefix —

    Prefix of Resource URI

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

    the optional parameters

Returns:

  • (Array<(Array<AggregatedResourceEachResponse>, Fixnum, Hash)>) —

    Array<AggregatedResourceEachResponse> data, response status code and response headers



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
 
# File 'lib/triglav_client/api/resources_api.rb', line 219

def list_aggregated_resources_with_http_info(uri_prefix, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ResourcesApi.list_aggregated_resources ..."
  end
  # verify the required parameter 'uri_prefix' is set
  fail ArgumentError, "Missing the required parameter 'uri_prefix' when calling ResourcesApi.list_aggregated_resources" if uri_prefix.nil?
  # resource path
  local_var_path = "/aggregated_resources".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'uri_prefix'] = uri_prefix

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_key']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<AggregatedResourceEachResponse>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ResourcesApi#list_aggregated_resources\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_resources(opts = {}) ⇒ Array<ResourceEachResponse>

Returns all resources

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :uri_prefix (String) —

    Prefix of Resource URI

Returns:



267
268
269
270
 
# File 'lib/triglav_client/api/resources_api.rb', line 267

def list_resources(opts = {})
  data, _status_code, _headers = list_resources_with_http_info(opts)
  return data
end

#list_resources_with_http_info(opts = {}) ⇒ Array<(Array<ResourceEachResponse>, Fixnum, Hash)>

Returns all resources

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :uri_prefix (String) —

    Prefix of Resource URI

Returns:

  • (Array<(Array<ResourceEachResponse>, Fixnum, Hash)>) —

    Array<ResourceEachResponse> data, response status code and response headers



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
 
# File 'lib/triglav_client/api/resources_api.rb', line 277

def list_resources_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ResourcesApi.list_resources ..."
  end
  # resource path
  local_var_path = "/resources".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'uri_prefix'] = opts[:'uri_prefix'] if !opts[:'uri_prefix'].nil?

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_key']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<ResourceEachResponse>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ResourcesApi#list_resources\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_resource(id_or_uri, resource, opts = {}) ⇒ ResourceResponse

Updates a single resource

Parameters:

  • id_or_uri —

    ID or URI of resource to fetch

  • resource —

    Resource parameters to update

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

    the optional parameters

Returns:



324
325
326
327
 
# File 'lib/triglav_client/api/resources_api.rb', line 324

def update_resource(id_or_uri, resource, opts = {})
  data, _status_code, _headers = update_resource_with_http_info(id_or_uri, resource, opts)
  return data
end

#update_resource_with_http_info(id_or_uri, resource, opts = {}) ⇒ Array<(ResourceResponse, Fixnum, Hash)>

Updates a single resource

Parameters:

  • id_or_uri —

    ID or URI of resource to fetch

  • resource —

    Resource parameters to update

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

    the optional parameters

Returns:

  • (Array<(ResourceResponse, Fixnum, Hash)>) —

    ResourceResponse data, response status code and response headers



335
336
337
338
339
340
341
342
343
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
 
# File 'lib/triglav_client/api/resources_api.rb', line 335

def update_resource_with_http_info(id_or_uri, resource, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ResourcesApi.update_resource ..."
  end
  # verify the required parameter 'id_or_uri' is set
  fail ArgumentError, "Missing the required parameter 'id_or_uri' when calling ResourcesApi.update_resource" if id_or_uri.nil?
  # verify the required parameter 'resource' is set
  fail ArgumentError, "Missing the required parameter 'resource' when calling ResourcesApi.update_resource" if resource.nil?
  # resource path
  local_var_path = "/resources/{id_or_uri}".sub('{format}','json').sub('{' + 'id_or_uri' + '}', id_or_uri.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(resource)
  auth_names = ['api_key']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ResourceResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ResourcesApi#update_resource\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end