Class: Nodeum::StatisticsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/nodeum_sdk/api/statistics_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ StatisticsApi

Returns a new instance of StatisticsApi.



19
20
21
 
# File 'lib/nodeum_sdk/api/statistics_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/nodeum_sdk/api/statistics_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#statistics_by_date(opts = {}) ⇒ ByDateFacet

Get statistics about files, grouped by date **API Key Scope**: statistics / by_date

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :q (String) —

    Solr query

  • :fq (Array<String>) —

    Solr filter query Multiple query can be separated by &#x60;|&#x60;.

  • :date_attr (String) —

    Type of date to facet on

Returns:



29
30
31
32
 
# File 'lib/nodeum_sdk/api/statistics_api.rb', line 29

def statistics_by_date(opts = {})
  data, _status_code, _headers = statistics_by_date_with_http_info(opts)
  data
end

#statistics_by_date_with_http_info(opts = {}) ⇒ Array<(ByDateFacet, Integer, Hash)>

Get statistics about files, grouped by date **API Key Scope**: statistics / by_date

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :q (String) —

    Solr query

  • :fq (Array<String>) —

    Solr filter query Multiple query can be separated by &#x60;|&#x60;.

  • :date_attr (String) —

    Type of date to facet on

Returns:

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

    ByDateFacet data, response status code and response headers



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

def statistics_by_date_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StatisticsApi.statistics_by_date ...'
  end
  allowable_values = ["file_change_dt", "file_modification_dt", "file_access_dt"]
  if @api_client.config.client_side_validation && opts[:'date_attr'] && !allowable_values.include?(opts[:'date_attr'])
    fail ArgumentError, "invalid value for \"date_attr\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/statistics/by_date'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
  query_params[:'fq'] = @api_client.build_collection_param(opts[:'fq'], :pipe) if !opts[:'fq'].nil?
  query_params[:'date_attr'] = opts[:'date_attr'] if !opts[:'date_attr'].nil?

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

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

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

  # return_type
  return_type = opts[:return_type] || 'ByDateFacet' 

  # auth_names
  auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']

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

#statistics_by_file_extension(opts = {}) ⇒ ByFileExtensionFacet

Get statistics about files, grouped by file extension **API Key Scope**: statistics / by_file_extension

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :q (String) —

    Solr query

  • :fq (Array<String>) —

    Solr filter query Multiple query can be separated by &#x60;|&#x60;.

  • :date_attr (String) —

    Type of date to facet on

  • :sort (String) —

    Sort results of facet (default to ‘count’)

  • :limit (Integer) —

    Limit results of facet (default to 10)

Returns:



100
101
102
103
 
# File 'lib/nodeum_sdk/api/statistics_api.rb', line 100

def statistics_by_file_extension(opts = {})
  data, _status_code, _headers = statistics_by_file_extension_with_http_info(opts)
  data
end

#statistics_by_file_extension_with_http_info(opts = {}) ⇒ Array<(ByFileExtensionFacet, Integer, Hash)>

Get statistics about files, grouped by file extension **API Key Scope**: statistics / by_file_extension

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :q (String) —

    Solr query

  • :fq (Array<String>) —

    Solr filter query Multiple query can be separated by &#x60;|&#x60;.

  • :date_attr (String) —

    Type of date to facet on

  • :sort (String) —

    Sort results of facet

  • :limit (Integer) —

    Limit results of facet

Returns:

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

    ByFileExtensionFacet data, response status code and response headers



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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/nodeum_sdk/api/statistics_api.rb', line 114

def statistics_by_file_extension_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StatisticsApi.statistics_by_file_extension ...'
  end
  allowable_values = ["file_change_dt", "file_modification_dt", "file_access_dt"]
  if @api_client.config.client_side_validation && opts[:'date_attr'] && !allowable_values.include?(opts[:'date_attr'])
    fail ArgumentError, "invalid value for \"date_attr\", must be one of #{allowable_values}"
  end
  allowable_values = ["count", "files_count", "file_size_sum", "cost"]
  if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
    fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/statistics/by_file_extension'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
  query_params[:'fq'] = @api_client.build_collection_param(opts[:'fq'], :pipe) if !opts[:'fq'].nil?
  query_params[:'date_attr'] = opts[:'date_attr'] if !opts[:'date_attr'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

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

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

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

  # return_type
  return_type = opts[:return_type] || 'ByFileExtensionFacet' 

  # auth_names
  auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']

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

#statistics_by_group_owner(opts = {}) ⇒ ByGroupOwnerFacet

Get statistics about files, grouped by owner (group) **API Key Scope**: statistics / by_group_owner

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :q (String) —

    Solr query

  • :fq (Array<String>) —

    Solr filter query Multiple query can be separated by &#x60;|&#x60;.

  • :date_attr (String) —

    Type of date to facet on

  • :sort (String) —

    Sort results of facet (default to ‘count’)

  • :limit (Integer) —

    Limit results of facet (default to 10)

Returns:



179
180
181
182
 
# File 'lib/nodeum_sdk/api/statistics_api.rb', line 179

def statistics_by_group_owner(opts = {})
  data, _status_code, _headers = statistics_by_group_owner_with_http_info(opts)
  data
end

#statistics_by_group_owner_with_http_info(opts = {}) ⇒ Array<(ByGroupOwnerFacet, Integer, Hash)>

Get statistics about files, grouped by owner (group) **API Key Scope**: statistics / by_group_owner

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :q (String) —

    Solr query

  • :fq (Array<String>) —

    Solr filter query Multiple query can be separated by &#x60;|&#x60;.

  • :date_attr (String) —

    Type of date to facet on

  • :sort (String) —

    Sort results of facet

  • :limit (Integer) —

    Limit results of facet

Returns:

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

    ByGroupOwnerFacet data, response status code and response headers



193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
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
 
# File 'lib/nodeum_sdk/api/statistics_api.rb', line 193

def statistics_by_group_owner_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StatisticsApi.statistics_by_group_owner ...'
  end
  allowable_values = ["file_change_dt", "file_modification_dt", "file_access_dt"]
  if @api_client.config.client_side_validation && opts[:'date_attr'] && !allowable_values.include?(opts[:'date_attr'])
    fail ArgumentError, "invalid value for \"date_attr\", must be one of #{allowable_values}"
  end
  allowable_values = ["count", "files_count", "file_size_sum", "cost"]
  if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
    fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/statistics/by_group_owner'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
  query_params[:'fq'] = @api_client.build_collection_param(opts[:'fq'], :pipe) if !opts[:'fq'].nil?
  query_params[:'date_attr'] = opts[:'date_attr'] if !opts[:'date_attr'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

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

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

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

  # return_type
  return_type = opts[:return_type] || 'ByGroupOwnerFacet' 

  # auth_names
  auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']

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

#statistics_by_metadata(opts = {}) ⇒ ByMetadataFacet

Get statistics about files, grouped by metadata **API Key Scope**: statistics / by_metadata

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :q (String) —

    Solr query

  • :fq (Array<String>) —

    Solr filter query Multiple query can be separated by &#x60;|&#x60;.

  • :date_attr (String) —

    Type of date to facet on

  • :sort (String) —

    Sort results of facet (default to ‘count’)

  • :limit (Integer) —

    Limit results of facet (default to 10)

Returns:



258
259
260
261
 
# File 'lib/nodeum_sdk/api/statistics_api.rb', line 258

def statistics_by_metadata(opts = {})
  data, _status_code, _headers = statistics_by_metadata_with_http_info(opts)
  data
end

#statistics_by_metadata_with_http_info(opts = {}) ⇒ Array<(ByMetadataFacet, Integer, Hash)>

Get statistics about files, grouped by metadata **API Key Scope**: statistics / by_metadata

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :q (String) —

    Solr query

  • :fq (Array<String>) —

    Solr filter query Multiple query can be separated by &#x60;|&#x60;.

  • :date_attr (String) —

    Type of date to facet on

  • :sort (String) —

    Sort results of facet

  • :limit (Integer) —

    Limit results of facet

Returns:

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

    ByMetadataFacet data, response status code and response headers



272
273
274
275
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
 
# File 'lib/nodeum_sdk/api/statistics_api.rb', line 272

def statistics_by_metadata_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StatisticsApi.statistics_by_metadata ...'
  end
  allowable_values = ["file_change_dt", "file_modification_dt", "file_access_dt"]
  if @api_client.config.client_side_validation && opts[:'date_attr'] && !allowable_values.include?(opts[:'date_attr'])
    fail ArgumentError, "invalid value for \"date_attr\", must be one of #{allowable_values}"
  end
  allowable_values = ["count", "files_count", "file_size_sum", "cost"]
  if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
    fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/statistics/by_metadata'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
  query_params[:'fq'] = @api_client.build_collection_param(opts[:'fq'], :pipe) if !opts[:'fq'].nil?
  query_params[:'date_attr'] = opts[:'date_attr'] if !opts[:'date_attr'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

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

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

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

  # return_type
  return_type = opts[:return_type] || 'ByMetadataFacet' 

  # auth_names
  auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']

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

#statistics_by_primary_cloud(opts = {}) ⇒ ByPrimaryCloudFacet

Get statistics about files, grouped by primary Cloud **API Key Scope**: statistics / by_primary_cloud

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :q (String) —

    Solr query

  • :fq (Array<String>) —

    Solr filter query Multiple query can be separated by &#x60;|&#x60;.

  • :date_attr (String) —

    Type of date to facet on

  • :sort (String) —

    Sort results of facet (default to ‘count’)

  • :limit (Integer) —

    Limit results of facet (default to 10)

Returns:



337
338
339
340
 
# File 'lib/nodeum_sdk/api/statistics_api.rb', line 337

def statistics_by_primary_cloud(opts = {})
  data, _status_code, _headers = statistics_by_primary_cloud_with_http_info(opts)
  data
end

#statistics_by_primary_cloud_with_http_info(opts = {}) ⇒ Array<(ByPrimaryCloudFacet, Integer, Hash)>

Get statistics about files, grouped by primary Cloud **API Key Scope**: statistics / by_primary_cloud

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :q (String) —

    Solr query

  • :fq (Array<String>) —

    Solr filter query Multiple query can be separated by &#x60;|&#x60;.

  • :date_attr (String) —

    Type of date to facet on

  • :sort (String) —

    Sort results of facet

  • :limit (Integer) —

    Limit results of facet

Returns:

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

    ByPrimaryCloudFacet data, response status code and response headers



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
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
 
# File 'lib/nodeum_sdk/api/statistics_api.rb', line 351

def statistics_by_primary_cloud_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StatisticsApi.statistics_by_primary_cloud ...'
  end
  allowable_values = ["file_change_dt", "file_modification_dt", "file_access_dt"]
  if @api_client.config.client_side_validation && opts[:'date_attr'] && !allowable_values.include?(opts[:'date_attr'])
    fail ArgumentError, "invalid value for \"date_attr\", must be one of #{allowable_values}"
  end
  allowable_values = ["count", "files_count", "file_size_sum", "cost"]
  if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
    fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/statistics/by_primary_cloud'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
  query_params[:'fq'] = @api_client.build_collection_param(opts[:'fq'], :pipe) if !opts[:'fq'].nil?
  query_params[:'date_attr'] = opts[:'date_attr'] if !opts[:'date_attr'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

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

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

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

  # return_type
  return_type = opts[:return_type] || 'ByPrimaryCloudFacet' 

  # auth_names
  auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']

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

#statistics_by_primary_name(opts = {}) ⇒ ByPrimaryFacet

Get statistics about files, grouped by primary storages **API Key Scope**: statistics / by_primary_name

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :q (String) —

    Solr query

  • :fq (Array<String>) —

    Solr filter query Multiple query can be separated by &#x60;|&#x60;.

  • :date_attr (String) —

    Type of date to facet on

  • :sort (String) —

    Sort results of facet (default to ‘count’)

  • :limit (Integer) —

    Limit results of facet (default to 10)

Returns:



416
417
418
419
 
# File 'lib/nodeum_sdk/api/statistics_api.rb', line 416

def statistics_by_primary_name(opts = {})
  data, _status_code, _headers = statistics_by_primary_name_with_http_info(opts)
  data
end

#statistics_by_primary_name_with_http_info(opts = {}) ⇒ Array<(ByPrimaryFacet, Integer, Hash)>

Get statistics about files, grouped by primary storages **API Key Scope**: statistics / by_primary_name

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :q (String) —

    Solr query

  • :fq (Array<String>) —

    Solr filter query Multiple query can be separated by &#x60;|&#x60;.

  • :date_attr (String) —

    Type of date to facet on

  • :sort (String) —

    Sort results of facet

  • :limit (Integer) —

    Limit results of facet

Returns:

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

    ByPrimaryFacet data, response status code and response headers



430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
 
# File 'lib/nodeum_sdk/api/statistics_api.rb', line 430

def statistics_by_primary_name_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StatisticsApi.statistics_by_primary_name ...'
  end
  allowable_values = ["file_change_dt", "file_modification_dt", "file_access_dt"]
  if @api_client.config.client_side_validation && opts[:'date_attr'] && !allowable_values.include?(opts[:'date_attr'])
    fail ArgumentError, "invalid value for \"date_attr\", must be one of #{allowable_values}"
  end
  allowable_values = ["count", "files_count", "file_size_sum", "cost"]
  if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
    fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/statistics/by_primary_name'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
  query_params[:'fq'] = @api_client.build_collection_param(opts[:'fq'], :pipe) if !opts[:'fq'].nil?
  query_params[:'date_attr'] = opts[:'date_attr'] if !opts[:'date_attr'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

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

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

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

  # return_type
  return_type = opts[:return_type] || 'ByPrimaryFacet' 

  # auth_names
  auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']

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

#statistics_by_primary_nas(opts = {}) ⇒ ByPrimaryNasFacet

Get statistics about files, grouped by primary NAS **API Key Scope**: statistics / by_primary_nas

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :q (String) —

    Solr query

  • :fq (Array<String>) —

    Solr filter query Multiple query can be separated by &#x60;|&#x60;.

  • :date_attr (String) —

    Type of date to facet on

  • :sort (String) —

    Sort results of facet (default to ‘count’)

  • :limit (Integer) —

    Limit results of facet (default to 10)

Returns:



495
496
497
498
 
# File 'lib/nodeum_sdk/api/statistics_api.rb', line 495

def statistics_by_primary_nas(opts = {})
  data, _status_code, _headers = statistics_by_primary_nas_with_http_info(opts)
  data
end

#statistics_by_primary_nas_with_http_info(opts = {}) ⇒ Array<(ByPrimaryNasFacet, Integer, Hash)>

Get statistics about files, grouped by primary NAS **API Key Scope**: statistics / by_primary_nas

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :q (String) —

    Solr query

  • :fq (Array<String>) —

    Solr filter query Multiple query can be separated by &#x60;|&#x60;.

  • :date_attr (String) —

    Type of date to facet on

  • :sort (String) —

    Sort results of facet

  • :limit (Integer) —

    Limit results of facet

Returns:

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

    ByPrimaryNasFacet data, response status code and response headers



509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
 
# File 'lib/nodeum_sdk/api/statistics_api.rb', line 509

def statistics_by_primary_nas_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StatisticsApi.statistics_by_primary_nas ...'
  end
  allowable_values = ["file_change_dt", "file_modification_dt", "file_access_dt"]
  if @api_client.config.client_side_validation && opts[:'date_attr'] && !allowable_values.include?(opts[:'date_attr'])
    fail ArgumentError, "invalid value for \"date_attr\", must be one of #{allowable_values}"
  end
  allowable_values = ["count", "files_count", "file_size_sum", "cost"]
  if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
    fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/statistics/by_primary_nas'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
  query_params[:'fq'] = @api_client.build_collection_param(opts[:'fq'], :pipe) if !opts[:'fq'].nil?
  query_params[:'date_attr'] = opts[:'date_attr'] if !opts[:'date_attr'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

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

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

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

  # return_type
  return_type = opts[:return_type] || 'ByPrimaryNasFacet' 

  # auth_names
  auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']

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

#statistics_by_primary_storage(opts = {}) ⇒ ByPrimaryStorageFacet

Get statistics about files, grouped by primary storage **API Key Scope**: statistics / by_primary_storage

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :q (String) —

    Solr query

  • :fq (Array<String>) —

    Solr filter query Multiple query can be separated by &#x60;|&#x60;.

  • :date_attr (String) —

    Type of date to facet on

  • :sort (String) —

    Sort results of facet (default to ‘count’)

  • :limit (Integer) —

    Limit results of facet (default to 10)

Returns:



574
575
576
577
 
# File 'lib/nodeum_sdk/api/statistics_api.rb', line 574

def statistics_by_primary_storage(opts = {})
  data, _status_code, _headers = statistics_by_primary_storage_with_http_info(opts)
  data
end

#statistics_by_primary_storage_with_http_info(opts = {}) ⇒ Array<(ByPrimaryStorageFacet, Integer, Hash)>

Get statistics about files, grouped by primary storage **API Key Scope**: statistics / by_primary_storage

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :q (String) —

    Solr query

  • :fq (Array<String>) —

    Solr filter query Multiple query can be separated by &#x60;|&#x60;.

  • :date_attr (String) —

    Type of date to facet on

  • :sort (String) —

    Sort results of facet

  • :limit (Integer) —

    Limit results of facet

Returns:

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

    ByPrimaryStorageFacet data, response status code and response headers



588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
 
# File 'lib/nodeum_sdk/api/statistics_api.rb', line 588

def statistics_by_primary_storage_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StatisticsApi.statistics_by_primary_storage ...'
  end
  allowable_values = ["file_change_dt", "file_modification_dt", "file_access_dt"]
  if @api_client.config.client_side_validation && opts[:'date_attr'] && !allowable_values.include?(opts[:'date_attr'])
    fail ArgumentError, "invalid value for \"date_attr\", must be one of #{allowable_values}"
  end
  allowable_values = ["count", "files_count", "file_size_sum", "cost"]
  if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
    fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/statistics/by_primary_storage'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
  query_params[:'fq'] = @api_client.build_collection_param(opts[:'fq'], :pipe) if !opts[:'fq'].nil?
  query_params[:'date_attr'] = opts[:'date_attr'] if !opts[:'date_attr'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

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

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

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

  # return_type
  return_type = opts[:return_type] || 'ByPrimaryStorageFacet' 

  # auth_names
  auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']

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

#statistics_by_secondary_cloud(opts = {}) ⇒ BySecondaryCloudFacet

Get statistics about files, grouped by secondary Cloud **API Key Scope**: statistics / by_secondary_cloud

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :q (String) —

    Solr query

  • :fq (Array<String>) —

    Solr filter query Multiple query can be separated by &#x60;|&#x60;.

  • :date_attr (String) —

    Type of date to facet on

  • :sort (String) —

    Sort results of facet (default to ‘count’)

  • :limit (Integer) —

    Limit results of facet (default to 10)

Returns:



653
654
655
656
 
# File 'lib/nodeum_sdk/api/statistics_api.rb', line 653

def statistics_by_secondary_cloud(opts = {})
  data, _status_code, _headers = statistics_by_secondary_cloud_with_http_info(opts)
  data
end

#statistics_by_secondary_cloud_with_http_info(opts = {}) ⇒ Array<(BySecondaryCloudFacet, Integer, Hash)>

Get statistics about files, grouped by secondary Cloud **API Key Scope**: statistics / by_secondary_cloud

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :q (String) —

    Solr query

  • :fq (Array<String>) —

    Solr filter query Multiple query can be separated by &#x60;|&#x60;.

  • :date_attr (String) —

    Type of date to facet on

  • :sort (String) —

    Sort results of facet

  • :limit (Integer) —

    Limit results of facet

Returns:

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

    BySecondaryCloudFacet data, response status code and response headers



667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
 
# File 'lib/nodeum_sdk/api/statistics_api.rb', line 667

def statistics_by_secondary_cloud_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StatisticsApi.statistics_by_secondary_cloud ...'
  end
  allowable_values = ["file_change_dt", "file_modification_dt", "file_access_dt"]
  if @api_client.config.client_side_validation && opts[:'date_attr'] && !allowable_values.include?(opts[:'date_attr'])
    fail ArgumentError, "invalid value for \"date_attr\", must be one of #{allowable_values}"
  end
  allowable_values = ["count", "files_count", "file_size_sum", "cost"]
  if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
    fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/statistics/by_secondary_cloud'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
  query_params[:'fq'] = @api_client.build_collection_param(opts[:'fq'], :pipe) if !opts[:'fq'].nil?
  query_params[:'date_attr'] = opts[:'date_attr'] if !opts[:'date_attr'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

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

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

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

  # return_type
  return_type = opts[:return_type] || 'BySecondaryCloudFacet' 

  # auth_names
  auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']

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

#statistics_by_secondary_nas(opts = {}) ⇒ BySecondaryNasFacet

Get statistics about files, grouped by secondary NAS **API Key Scope**: statistics / by_secondary_nas

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :q (String) —

    Solr query

  • :fq (Array<String>) —

    Solr filter query Multiple query can be separated by &#x60;|&#x60;.

  • :date_attr (String) —

    Type of date to facet on

  • :sort (String) —

    Sort results of facet (default to ‘count’)

  • :limit (Integer) —

    Limit results of facet (default to 10)

Returns:



732
733
734
735
 
# File 'lib/nodeum_sdk/api/statistics_api.rb', line 732

def statistics_by_secondary_nas(opts = {})
  data, _status_code, _headers = statistics_by_secondary_nas_with_http_info(opts)
  data
end

#statistics_by_secondary_nas_with_http_info(opts = {}) ⇒ Array<(BySecondaryNasFacet, Integer, Hash)>

Get statistics about files, grouped by secondary NAS **API Key Scope**: statistics / by_secondary_nas

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :q (String) —

    Solr query

  • :fq (Array<String>) —

    Solr filter query Multiple query can be separated by &#x60;|&#x60;.

  • :date_attr (String) —

    Type of date to facet on

  • :sort (String) —

    Sort results of facet

  • :limit (Integer) —

    Limit results of facet

Returns:

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

    BySecondaryNasFacet data, response status code and response headers



746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
 
# File 'lib/nodeum_sdk/api/statistics_api.rb', line 746

def statistics_by_secondary_nas_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StatisticsApi.statistics_by_secondary_nas ...'
  end
  allowable_values = ["file_change_dt", "file_modification_dt", "file_access_dt"]
  if @api_client.config.client_side_validation && opts[:'date_attr'] && !allowable_values.include?(opts[:'date_attr'])
    fail ArgumentError, "invalid value for \"date_attr\", must be one of #{allowable_values}"
  end
  allowable_values = ["count", "files_count", "file_size_sum", "cost"]
  if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
    fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/statistics/by_secondary_nas'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
  query_params[:'fq'] = @api_client.build_collection_param(opts[:'fq'], :pipe) if !opts[:'fq'].nil?
  query_params[:'date_attr'] = opts[:'date_attr'] if !opts[:'date_attr'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

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

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

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

  # return_type
  return_type = opts[:return_type] || 'BySecondaryNasFacet' 

  # auth_names
  auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']

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

#statistics_by_secondary_storage(opts = {}) ⇒ BySecondaryStorageFacet

Get statistics about files, grouped by secondary storage **API Key Scope**: statistics / by_secondary_storage

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :q (String) —

    Solr query

  • :fq (Array<String>) —

    Solr filter query Multiple query can be separated by &#x60;|&#x60;.

  • :date_attr (String) —

    Type of date to facet on

  • :sort (String) —

    Sort results of facet (default to ‘count’)

  • :limit (Integer) —

    Limit results of facet (default to 10)

Returns:



811
812
813
814
 
# File 'lib/nodeum_sdk/api/statistics_api.rb', line 811

def statistics_by_secondary_storage(opts = {})
  data, _status_code, _headers = statistics_by_secondary_storage_with_http_info(opts)
  data
end

#statistics_by_secondary_storage_with_http_info(opts = {}) ⇒ Array<(BySecondaryStorageFacet, Integer, Hash)>

Get statistics about files, grouped by secondary storage **API Key Scope**: statistics / by_secondary_storage

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :q (String) —

    Solr query

  • :fq (Array<String>) —

    Solr filter query Multiple query can be separated by &#x60;|&#x60;.

  • :date_attr (String) —

    Type of date to facet on

  • :sort (String) —

    Sort results of facet

  • :limit (Integer) —

    Limit results of facet

Returns:

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

    BySecondaryStorageFacet data, response status code and response headers



825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
 
# File 'lib/nodeum_sdk/api/statistics_api.rb', line 825

def statistics_by_secondary_storage_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StatisticsApi.statistics_by_secondary_storage ...'
  end
  allowable_values = ["file_change_dt", "file_modification_dt", "file_access_dt"]
  if @api_client.config.client_side_validation && opts[:'date_attr'] && !allowable_values.include?(opts[:'date_attr'])
    fail ArgumentError, "invalid value for \"date_attr\", must be one of #{allowable_values}"
  end
  allowable_values = ["count", "files_count", "file_size_sum", "cost"]
  if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
    fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/statistics/by_secondary_storage'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
  query_params[:'fq'] = @api_client.build_collection_param(opts[:'fq'], :pipe) if !opts[:'fq'].nil?
  query_params[:'date_attr'] = opts[:'date_attr'] if !opts[:'date_attr'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

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

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

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

  # return_type
  return_type = opts[:return_type] || 'BySecondaryStorageFacet' 

  # auth_names
  auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']

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

#statistics_by_secondary_tape(opts = {}) ⇒ BySecondaryTapeFacet

Get statistics about files, grouped by secondary Tape **API Key Scope**: statistics / by_secondary_tape

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :q (String) —

    Solr query

  • :fq (Array<String>) —

    Solr filter query Multiple query can be separated by &#x60;|&#x60;.

  • :date_attr (String) —

    Type of date to facet on

  • :sort (String) —

    Sort results of facet (default to ‘count’)

  • :limit (Integer) —

    Limit results of facet (default to 10)

Returns:



890
891
892
893
 
# File 'lib/nodeum_sdk/api/statistics_api.rb', line 890

def statistics_by_secondary_tape(opts = {})
  data, _status_code, _headers = statistics_by_secondary_tape_with_http_info(opts)
  data
end

#statistics_by_secondary_tape_with_http_info(opts = {}) ⇒ Array<(BySecondaryTapeFacet, Integer, Hash)>

Get statistics about files, grouped by secondary Tape **API Key Scope**: statistics / by_secondary_tape

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :q (String) —

    Solr query

  • :fq (Array<String>) —

    Solr filter query Multiple query can be separated by &#x60;|&#x60;.

  • :date_attr (String) —

    Type of date to facet on

  • :sort (String) —

    Sort results of facet

  • :limit (Integer) —

    Limit results of facet

Returns:

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

    BySecondaryTapeFacet data, response status code and response headers



904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
 
# File 'lib/nodeum_sdk/api/statistics_api.rb', line 904

def statistics_by_secondary_tape_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StatisticsApi.statistics_by_secondary_tape ...'
  end
  allowable_values = ["file_change_dt", "file_modification_dt", "file_access_dt"]
  if @api_client.config.client_side_validation && opts[:'date_attr'] && !allowable_values.include?(opts[:'date_attr'])
    fail ArgumentError, "invalid value for \"date_attr\", must be one of #{allowable_values}"
  end
  allowable_values = ["count", "files_count", "file_size_sum", "cost"]
  if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
    fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/statistics/by_secondary_tape'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
  query_params[:'fq'] = @api_client.build_collection_param(opts[:'fq'], :pipe) if !opts[:'fq'].nil?
  query_params[:'date_attr'] = opts[:'date_attr'] if !opts[:'date_attr'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

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

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

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

  # return_type
  return_type = opts[:return_type] || 'BySecondaryTapeFacet' 

  # auth_names
  auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']

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

#statistics_by_size(opts = {}) ⇒ BySizeFacet

Get statistics about files, grouped by size **API Key Scope**: statistics / by_size

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :q (String) —

    Solr query

  • :fq (Array<String>) —

    Solr filter query Multiple query can be separated by &#x60;|&#x60;.

  • :date_attr (String) —

    Type of date to facet on

Returns:



967
968
969
970
 
# File 'lib/nodeum_sdk/api/statistics_api.rb', line 967

def statistics_by_size(opts = {})
  data, _status_code, _headers = statistics_by_size_with_http_info(opts)
  data
end

#statistics_by_size_with_http_info(opts = {}) ⇒ Array<(BySizeFacet, Integer, Hash)>

Get statistics about files, grouped by size **API Key Scope**: statistics / by_size

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :q (String) —

    Solr query

  • :fq (Array<String>) —

    Solr filter query Multiple query can be separated by &#x60;|&#x60;.

  • :date_attr (String) —

    Type of date to facet on

Returns:

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

    BySizeFacet data, response status code and response headers



979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
 
# File 'lib/nodeum_sdk/api/statistics_api.rb', line 979

def statistics_by_size_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StatisticsApi.statistics_by_size ...'
  end
  allowable_values = ["file_change_dt", "file_modification_dt", "file_access_dt"]
  if @api_client.config.client_side_validation && opts[:'date_attr'] && !allowable_values.include?(opts[:'date_attr'])
    fail ArgumentError, "invalid value for \"date_attr\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/statistics/by_size'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
  query_params[:'fq'] = @api_client.build_collection_param(opts[:'fq'], :pipe) if !opts[:'fq'].nil?
  query_params[:'date_attr'] = opts[:'date_attr'] if !opts[:'date_attr'].nil?

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

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

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

  # return_type
  return_type = opts[:return_type] || 'BySizeFacet' 

  # auth_names
  auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']

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

#statistics_by_user_owner(opts = {}) ⇒ ByUserOwnerFacet

Get statistics about files, grouped by owner (user) **API Key Scope**: statistics / by_user_owner

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :q (String) —

    Solr query

  • :fq (Array<String>) —

    Solr filter query Multiple query can be separated by &#x60;|&#x60;.

  • :date_attr (String) —

    Type of date to facet on

  • :sort (String) —

    Sort results of facet (default to ‘count’)

  • :limit (Integer) —

    Limit results of facet (default to 10)

Returns:



1038
1039
1040
1041
 
# File 'lib/nodeum_sdk/api/statistics_api.rb', line 1038

def statistics_by_user_owner(opts = {})
  data, _status_code, _headers = statistics_by_user_owner_with_http_info(opts)
  data
end

#statistics_by_user_owner_with_http_info(opts = {}) ⇒ Array<(ByUserOwnerFacet, Integer, Hash)>

Get statistics about files, grouped by owner (user) **API Key Scope**: statistics / by_user_owner

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :q (String) —

    Solr query

  • :fq (Array<String>) —

    Solr filter query Multiple query can be separated by &#x60;|&#x60;.

  • :date_attr (String) —

    Type of date to facet on

  • :sort (String) —

    Sort results of facet

  • :limit (Integer) —

    Limit results of facet

Returns:

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

    ByUserOwnerFacet data, response status code and response headers



1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
 
# File 'lib/nodeum_sdk/api/statistics_api.rb', line 1052

def statistics_by_user_owner_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StatisticsApi.statistics_by_user_owner ...'
  end
  allowable_values = ["file_change_dt", "file_modification_dt", "file_access_dt"]
  if @api_client.config.client_side_validation && opts[:'date_attr'] && !allowable_values.include?(opts[:'date_attr'])
    fail ArgumentError, "invalid value for \"date_attr\", must be one of #{allowable_values}"
  end
  allowable_values = ["count", "files_count", "file_size_sum", "cost"]
  if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
    fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/statistics/by_user_owner'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
  query_params[:'fq'] = @api_client.build_collection_param(opts[:'fq'], :pipe) if !opts[:'fq'].nil?
  query_params[:'date_attr'] = opts[:'date_attr'] if !opts[:'date_attr'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

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

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

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

  # return_type
  return_type = opts[:return_type] || 'ByUserOwnerFacet' 

  # auth_names
  auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']

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

#statistics_storage(opts = {}) ⇒ StorageFacet

Get statistics about storages, grouped by types **API Key Scope**: statistics / storages

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :q (String) —

    Solr query

  • :fq (Array<String>) —

    Solr filter query Multiple query can be separated by &#x60;|&#x60;.

Returns:



1114
1115
1116
1117
 
# File 'lib/nodeum_sdk/api/statistics_api.rb', line 1114

def statistics_storage(opts = {})
  data, _status_code, _headers = statistics_storage_with_http_info(opts)
  data
end

#statistics_storage_with_http_info(opts = {}) ⇒ Array<(StorageFacet, Integer, Hash)>

Get statistics about storages, grouped by types **API Key Scope**: statistics / storages

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :q (String) —

    Solr query

  • :fq (Array<String>) —

    Solr filter query Multiple query can be separated by &#x60;|&#x60;.

Returns:

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

    StorageFacet data, response status code and response headers



1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
 
# File 'lib/nodeum_sdk/api/statistics_api.rb', line 1125

def statistics_storage_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StatisticsApi.statistics_storage ...'
  end
  # resource path
  local_var_path = '/statistics/storage'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
  query_params[:'fq'] = @api_client.build_collection_param(opts[:'fq'], :pipe) if !opts[:'fq'].nil?

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

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

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

  # return_type
  return_type = opts[:return_type] || 'StorageFacet' 

  # auth_names
  auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']

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

#statistics_task_by_metadata(opts = {}) ⇒ ByTaskMetadataFacet

Get statistics about tasks executions, grouped by metadata **API Key Scope**: statistics / task_by_metadata

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :q (String) —

    Solr query

  • :fq (Array<String>) —

    Solr filter query Multiple query can be separated by &#x60;|&#x60;.

  • :sort (String) —

    Sort results of facet on task (default to ‘count’)

  • :limit (Integer) —

    Limit results of facet (default to 10)

Returns:



1178
1179
1180
1181
 
# File 'lib/nodeum_sdk/api/statistics_api.rb', line 1178

def statistics_task_by_metadata(opts = {})
  data, _status_code, _headers = statistics_task_by_metadata_with_http_info(opts)
  data
end

#statistics_task_by_metadata_with_http_info(opts = {}) ⇒ Array<(ByTaskMetadataFacet, Integer, Hash)>

Get statistics about tasks executions, grouped by metadata **API Key Scope**: statistics / task_by_metadata

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :q (String) —

    Solr query

  • :fq (Array<String>) —

    Solr filter query Multiple query can be separated by &#x60;|&#x60;.

  • :sort (String) —

    Sort results of facet on task

  • :limit (Integer) —

    Limit results of facet

Returns:

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

    ByTaskMetadataFacet data, response status code and response headers



1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
 
# File 'lib/nodeum_sdk/api/statistics_api.rb', line 1191

def statistics_task_by_metadata_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StatisticsApi.statistics_task_by_metadata ...'
  end
  allowable_values = ["count", "tasks_count", "to_process_size_sum", "processed_size_sum", "to_process_files_sum", "processed_files_sum", "finalized_files_sum", "bandwidth_avg", "bandwidth_count"]
  if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
    fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/statistics/task_by_metadata'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
  query_params[:'fq'] = @api_client.build_collection_param(opts[:'fq'], :pipe) if !opts[:'fq'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

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

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

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

  # return_type
  return_type = opts[:return_type] || 'ByTaskMetadataFacet' 

  # auth_names
  auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']

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

#statistics_task_by_status(opts = {}) ⇒ ByTaskStatusFacet

Get statistics about tasks executions, grouped by status **API Key Scope**: statistics / task_by_status

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :q (String) —

    Solr query

  • :fq (Array<String>) —

    Solr filter query Multiple query can be separated by &#x60;|&#x60;.

Returns:



1248
1249
1250
1251
 
# File 'lib/nodeum_sdk/api/statistics_api.rb', line 1248

def statistics_task_by_status(opts = {})
  data, _status_code, _headers = statistics_task_by_status_with_http_info(opts)
  data
end

#statistics_task_by_status_with_http_info(opts = {}) ⇒ Array<(ByTaskStatusFacet, Integer, Hash)>

Get statistics about tasks executions, grouped by status **API Key Scope**: statistics / task_by_status

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :q (String) —

    Solr query

  • :fq (Array<String>) —

    Solr filter query Multiple query can be separated by &#x60;|&#x60;.

Returns:

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

    ByTaskStatusFacet data, response status code and response headers



1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
 
# File 'lib/nodeum_sdk/api/statistics_api.rb', line 1259

def statistics_task_by_status_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StatisticsApi.statistics_task_by_status ...'
  end
  # resource path
  local_var_path = '/statistics/task_by_status'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
  query_params[:'fq'] = @api_client.build_collection_param(opts[:'fq'], :pipe) if !opts[:'fq'].nil?

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

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

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

  # return_type
  return_type = opts[:return_type] || 'ByTaskStatusFacet' 

  # auth_names
  auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']

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

#statistics_task_by_storage(opts = {}) ⇒ ByTaskStorageFacet

Get statistics about tasks executions, grouped by source and destination **API Key Scope**: statistics / task_by_storage

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :q (String) —

    Solr query

  • :fq (Array<String>) —

    Solr filter query Multiple query can be separated by &#x60;|&#x60;.

Returns:



1310
1311
1312
1313
 
# File 'lib/nodeum_sdk/api/statistics_api.rb', line 1310

def statistics_task_by_storage(opts = {})
  data, _status_code, _headers = statistics_task_by_storage_with_http_info(opts)
  data
end

#statistics_task_by_storage_with_http_info(opts = {}) ⇒ Array<(ByTaskStorageFacet, Integer, Hash)>

Get statistics about tasks executions, grouped by source and destination **API Key Scope**: statistics / task_by_storage

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :q (String) —

    Solr query

  • :fq (Array<String>) —

    Solr filter query Multiple query can be separated by &#x60;|&#x60;.

Returns:

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

    ByTaskStorageFacet data, response status code and response headers



1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
 
# File 'lib/nodeum_sdk/api/statistics_api.rb', line 1321

def statistics_task_by_storage_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StatisticsApi.statistics_task_by_storage ...'
  end
  # resource path
  local_var_path = '/statistics/task_by_storage'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
  query_params[:'fq'] = @api_client.build_collection_param(opts[:'fq'], :pipe) if !opts[:'fq'].nil?

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

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

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

  # return_type
  return_type = opts[:return_type] || 'ByTaskStorageFacet' 

  # auth_names
  auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']

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

#statistics_task_by_workflow(opts = {}) ⇒ ByTaskWorkflowFacet

Get statistics about tasks executions, grouped by workflow **API Key Scope**: statistics / task_by_workflow

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :q (String) —

    Solr query

  • :fq (Array<String>) —

    Solr filter query Multiple query can be separated by &#x60;|&#x60;.

Returns:



1372
1373
1374
1375
 
# File 'lib/nodeum_sdk/api/statistics_api.rb', line 1372

def statistics_task_by_workflow(opts = {})
  data, _status_code, _headers = statistics_task_by_workflow_with_http_info(opts)
  data
end

#statistics_task_by_workflow_with_http_info(opts = {}) ⇒ Array<(ByTaskWorkflowFacet, Integer, Hash)>

Get statistics about tasks executions, grouped by workflow **API Key Scope**: statistics / task_by_workflow

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :q (String) —

    Solr query

  • :fq (Array<String>) —

    Solr filter query Multiple query can be separated by &#x60;|&#x60;.

Returns:

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

    ByTaskWorkflowFacet data, response status code and response headers



1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
 
# File 'lib/nodeum_sdk/api/statistics_api.rb', line 1383

def statistics_task_by_workflow_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StatisticsApi.statistics_task_by_workflow ...'
  end
  # resource path
  local_var_path = '/statistics/task_by_workflow'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
  query_params[:'fq'] = @api_client.build_collection_param(opts[:'fq'], :pipe) if !opts[:'fq'].nil?

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

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

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

  # return_type
  return_type = opts[:return_type] || 'ByTaskWorkflowFacet' 

  # auth_names
  auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']

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