Class: Falcon::FoundryLogscaleApi

Inherits:
Object
  • Object
show all
Defined in:
lib/crimson-falcon/api/foundry_logscale_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ FoundryLogscaleApi

Returns a new instance of FoundryLogscaleApi.



36
37
38
 
# File 'lib/crimson-falcon/api/foundry_logscale_api.rb', line 36

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



34
35
36
 
# File 'lib/crimson-falcon/api/foundry_logscale_api.rb', line 34

def api_client
  @api_client
end

Instance Method Details

#create_saved_searches_dynamic_execute_alt_v1(body, opts = {}) ⇒ ApidomainQueryResponseWrapperV1

Execute a dynamic saved search

Parameters:

Options Hash (opts):

  • :app_id (String) —

    Application ID.

  • :include_schema_generation (Boolean) —

    Include generated schemas in the response (default to false)

  • :include_test_data (Boolean) —

    Include test data when executing searches (default to false)

  • :metadata (Boolean) —

    Whether to include metadata in the response (default to false)

  • :mode (String) —

    Mode to execute the query under.

Returns:



48
49
50
51
 
# File 'lib/crimson-falcon/api/foundry_logscale_api.rb', line 48

def create_saved_searches_dynamic_execute_alt_v1(body, opts = {})
  data, _status_code, _headers = create_saved_searches_dynamic_execute_alt_v1_with_http_info(body, opts)
  data
end

#create_saved_searches_dynamic_execute_alt_v1_with_http_info(body, opts = {}) ⇒ Array<(ApidomainQueryResponseWrapperV1, Integer, Hash)>

Execute a dynamic saved search

Parameters:

Options Hash (opts):

  • :app_id (String) —

    Application ID.

  • :include_schema_generation (Boolean) —

    Include generated schemas in the response (default to false)

  • :include_test_data (Boolean) —

    Include test data when executing searches (default to false)

  • :metadata (Boolean) —

    Whether to include metadata in the response (default to false)

  • :mode (String) —

    Mode to execute the query under.

Returns:



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
90
91
92
93
94
95
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
 
# File 'lib/crimson-falcon/api/foundry_logscale_api.rb', line 62

def create_saved_searches_dynamic_execute_alt_v1_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FoundryLogscaleApi.create_saved_searches_dynamic_execute_alt_v1 ...'
  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 FoundryLogscaleApi.create_saved_searches_dynamic_execute_alt_v1"
  end
  allowable_values = ["sync", "async"]
  if @api_client.config.client_side_validation && opts[:'mode'] && !allowable_values.include?(opts[:'mode'])
    fail ArgumentError, "invalid value for \"mode\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/loggingapi/entities/saved-searches-dynamic-execute/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'app_id'] = opts[:'app_id'] if !opts[:'app_id'].nil?
  query_params[:'include_schema_generation'] = opts[:'include_schema_generation'] if !opts[:'include_schema_generation'].nil?
  query_params[:'include_test_data'] = opts[:'include_test_data'] if !opts[:'include_test_data'].nil?
  query_params[:'metadata'] = opts[:'metadata'] if !opts[:'metadata'].nil?
  query_params[:'mode'] = opts[:'mode'] if !opts[:'mode'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # 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] || 'ApidomainQueryResponseWrapperV1'

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

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

#create_saved_searches_dynamic_execute_v1(body, opts = {}) ⇒ ApidomainQueryResponseWrapperV1

Execute a dynamic saved search

Parameters:

Options Hash (opts):

  • :app_id (String) —

    Application ID.

  • :include_schema_generation (Boolean) —

    Include generated schemas in the response (default to false)

  • :include_test_data (Boolean) —

    Include test data when executing searches (default to false)

  • :metadata (Boolean) —

    Whether to include metadata in the response (default to false)

  • :mode (String) —

    Mode to execute the query under.

Returns:



133
134
135
136
 
# File 'lib/crimson-falcon/api/foundry_logscale_api.rb', line 133

def create_saved_searches_dynamic_execute_v1(body, opts = {})
  data, _status_code, _headers = create_saved_searches_dynamic_execute_v1_with_http_info(body, opts)
  data
end

#create_saved_searches_dynamic_execute_v1_with_http_info(body, opts = {}) ⇒ Array<(ApidomainQueryResponseWrapperV1, Integer, Hash)>

Execute a dynamic saved search

Parameters:

Options Hash (opts):

  • :app_id (String) —

    Application ID.

  • :include_schema_generation (Boolean) —

    Include generated schemas in the response (default to false)

  • :include_test_data (Boolean) —

    Include test data when executing searches (default to false)

  • :metadata (Boolean) —

    Whether to include metadata in the response (default to false)

  • :mode (String) —

    Mode to execute the query under.

Returns:



147
148
149
150
151
152
153
154
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
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/crimson-falcon/api/foundry_logscale_api.rb', line 147

def create_saved_searches_dynamic_execute_v1_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FoundryLogscaleApi.create_saved_searches_dynamic_execute_v1 ...'
  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 FoundryLogscaleApi.create_saved_searches_dynamic_execute_v1"
  end
  allowable_values = ["sync", "async"]
  if @api_client.config.client_side_validation && opts[:'mode'] && !allowable_values.include?(opts[:'mode'])
    fail ArgumentError, "invalid value for \"mode\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/loggingapi/entities/saved-searches/execute-dynamic/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'app_id'] = opts[:'app_id'] if !opts[:'app_id'].nil?
  query_params[:'include_schema_generation'] = opts[:'include_schema_generation'] if !opts[:'include_schema_generation'].nil?
  query_params[:'include_test_data'] = opts[:'include_test_data'] if !opts[:'include_test_data'].nil?
  query_params[:'metadata'] = opts[:'metadata'] if !opts[:'metadata'].nil?
  query_params[:'mode'] = opts[:'mode'] if !opts[:'mode'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # 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] || 'ApidomainQueryResponseWrapperV1'

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

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

#create_saved_searches_execute_alt_v1(body, opts = {}) ⇒ ApidomainQueryResponseWrapperV1

Execute a saved search

Parameters:

Options Hash (opts):

  • :app_id (String) —

    Application ID.

  • :detailed (Boolean) —

    Whether to include search field details (default to false)

  • :include_test_data (Boolean) —

    Include test data when executing searches (default to false)

  • :metadata (Boolean) —

    Whether to include metadata in the response (default to false)

Returns:



217
218
219
220
 
# File 'lib/crimson-falcon/api/foundry_logscale_api.rb', line 217

def create_saved_searches_execute_alt_v1(body, opts = {})
  data, _status_code, _headers = create_saved_searches_execute_alt_v1_with_http_info(body, opts)
  data
end

#create_saved_searches_execute_alt_v1_with_http_info(body, opts = {}) ⇒ Array<(ApidomainQueryResponseWrapperV1, Integer, Hash)>

Execute a saved search

Parameters:

Options Hash (opts):

  • :app_id (String) —

    Application ID.

  • :detailed (Boolean) —

    Whether to include search field details (default to false)

  • :include_test_data (Boolean) —

    Include test data when executing searches (default to false)

  • :metadata (Boolean) —

    Whether to include metadata in the response (default to false)

Returns:



230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/crimson-falcon/api/foundry_logscale_api.rb', line 230

def create_saved_searches_execute_alt_v1_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FoundryLogscaleApi.create_saved_searches_execute_alt_v1 ...'
  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 FoundryLogscaleApi.create_saved_searches_execute_alt_v1"
  end
  # resource path
  local_var_path = '/loggingapi/entities/saved-searches-execute/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'app_id'] = opts[:'app_id'] if !opts[:'app_id'].nil?
  query_params[:'detailed'] = opts[:'detailed'] if !opts[:'detailed'].nil?
  query_params[:'include_test_data'] = opts[:'include_test_data'] if !opts[:'include_test_data'].nil?
  query_params[:'metadata'] = opts[:'metadata'] if !opts[:'metadata'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # 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] || 'ApidomainQueryResponseWrapperV1'

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

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

#create_saved_searches_execute_v1(body, opts = {}) ⇒ ApidomainQueryResponseWrapperV1

Execute a saved search

Parameters:

Options Hash (opts):

  • :app_id (String) —

    Application ID.

  • :detailed (Boolean) —

    Whether to include search field details (default to false)

  • :include_test_data (Boolean) —

    Include test data when executing searches (default to false)

  • :metadata (Boolean) —

    Whether to include metadata in the response (default to false)

Returns:



295
296
297
298
 
# File 'lib/crimson-falcon/api/foundry_logscale_api.rb', line 295

def create_saved_searches_execute_v1(body, opts = {})
  data, _status_code, _headers = create_saved_searches_execute_v1_with_http_info(body, opts)
  data
end

#create_saved_searches_execute_v1_with_http_info(body, opts = {}) ⇒ Array<(ApidomainQueryResponseWrapperV1, Integer, Hash)>

Execute a saved search

Parameters:

Options Hash (opts):

  • :app_id (String) —

    Application ID.

  • :detailed (Boolean) —

    Whether to include search field details (default to false)

  • :include_test_data (Boolean) —

    Include test data when executing searches (default to false)

  • :metadata (Boolean) —

    Whether to include metadata in the response (default to false)

Returns:



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
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
 
# File 'lib/crimson-falcon/api/foundry_logscale_api.rb', line 308

def create_saved_searches_execute_v1_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FoundryLogscaleApi.create_saved_searches_execute_v1 ...'
  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 FoundryLogscaleApi.create_saved_searches_execute_v1"
  end
  # resource path
  local_var_path = '/loggingapi/entities/saved-searches/execute/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'app_id'] = opts[:'app_id'] if !opts[:'app_id'].nil?
  query_params[:'detailed'] = opts[:'detailed'] if !opts[:'detailed'].nil?
  query_params[:'include_test_data'] = opts[:'include_test_data'] if !opts[:'include_test_data'].nil?
  query_params[:'metadata'] = opts[:'metadata'] if !opts[:'metadata'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # 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] || 'ApidomainQueryResponseWrapperV1'

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

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

#create_saved_searches_ingest_alt_v1(opts = {}) ⇒ ClientDataIngestResponseWrapperV1

Populate a saved search

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :app_id (String) —

    Application ID.

Returns:



369
370
371
372
 
# File 'lib/crimson-falcon/api/foundry_logscale_api.rb', line 369

def create_saved_searches_ingest_alt_v1(opts = {})
  data, _status_code, _headers = create_saved_searches_ingest_alt_v1_with_http_info(opts)
  data
end

#create_saved_searches_ingest_alt_v1_with_http_info(opts = {}) ⇒ Array<(ClientDataIngestResponseWrapperV1, Integer, Hash)>

Populate a saved search

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :app_id (String) —

    Application ID.

Returns:



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
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
 
# File 'lib/crimson-falcon/api/foundry_logscale_api.rb', line 378

def create_saved_searches_ingest_alt_v1_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FoundryLogscaleApi.create_saved_searches_ingest_alt_v1 ...'
  end
  # resource path
  local_var_path = '/loggingapi/entities/saved-searches-ingest/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'app_id'] = opts[:'app_id'] if !opts[:'app_id'].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[:debug_body]

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

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

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

#create_saved_searches_ingest_v1(opts = {}) ⇒ ClientDataIngestResponseWrapperV1

Populate a saved search

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :app_id (String) —

    Application ID.

Returns:



427
428
429
430
 
# File 'lib/crimson-falcon/api/foundry_logscale_api.rb', line 427

def create_saved_searches_ingest_v1(opts = {})
  data, _status_code, _headers = create_saved_searches_ingest_v1_with_http_info(opts)
  data
end

#create_saved_searches_ingest_v1_with_http_info(opts = {}) ⇒ Array<(ClientDataIngestResponseWrapperV1, Integer, Hash)>

Populate a saved search

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :app_id (String) —

    Application ID.

Returns:



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
 
# File 'lib/crimson-falcon/api/foundry_logscale_api.rb', line 436

def create_saved_searches_ingest_v1_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FoundryLogscaleApi.create_saved_searches_ingest_v1 ...'
  end
  # resource path
  local_var_path = '/loggingapi/entities/saved-searches/ingest/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'app_id'] = opts[:'app_id'] if !opts[:'app_id'].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[:debug_body]

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

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

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

#get_saved_searches_execute_alt_v1(job_id, opts = {}) ⇒ ApidomainQueryResponseWrapperV1

Get the results of a saved search

Parameters:

  • job_id (String) —

    Job ID for a previously executed async query

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

    the optional parameters

Options Hash (opts):

  • :app_id (String) —

    Application ID.

  • :limit (String) —

    Maximum number of records to return.

  • :metadata (Boolean) —

    Whether to include metadata in the response (default to false)

  • :offset (String) —

    Starting pagination offset of records to return.

Returns:



489
490
491
492
 
# File 'lib/crimson-falcon/api/foundry_logscale_api.rb', line 489

def get_saved_searches_execute_alt_v1(job_id, opts = {})
  data, _status_code, _headers = get_saved_searches_execute_alt_v1_with_http_info(job_id, opts)
  data
end

#get_saved_searches_execute_alt_v1_with_http_info(job_id, opts = {}) ⇒ Array<(ApidomainQueryResponseWrapperV1, Integer, Hash)>

Get the results of a saved search

Parameters:

  • job_id (String) —

    Job ID for a previously executed async query

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

    the optional parameters

Options Hash (opts):

  • :app_id (String) —

    Application ID.

  • :limit (String) —

    Maximum number of records to return.

  • :metadata (Boolean) —

    Whether to include metadata in the response (default to false)

  • :offset (String) —

    Starting pagination offset of records to return.

Returns:



502
503
504
505
506
507
508
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
 
# File 'lib/crimson-falcon/api/foundry_logscale_api.rb', line 502

def get_saved_searches_execute_alt_v1_with_http_info(job_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FoundryLogscaleApi.get_saved_searches_execute_alt_v1 ...'
  end
  # verify the required parameter 'job_id' is set
  if @api_client.config.client_side_validation && job_id.nil?
    fail ArgumentError, "Missing the required parameter 'job_id' when calling FoundryLogscaleApi.get_saved_searches_execute_alt_v1"
  end
  # resource path
  local_var_path = '/loggingapi/entities/saved-searches-execute/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'job_id'] = job_id
  query_params[:'app_id'] = opts[:'app_id'] if !opts[:'app_id'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'metadata'] = opts[:'metadata'] if !opts[:'metadata'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].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[:debug_body]

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

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

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

#get_saved_searches_execute_v1(job_id, opts = {}) ⇒ ApidomainQueryResponseWrapperV1

Get the results of a saved search

Parameters:

  • job_id (String) —

    Job ID for a previously executed async query

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

    the optional parameters

Options Hash (opts):

  • :app_id (String) —

    Application ID.

  • :limit (String) —

    Maximum number of records to return.

  • :metadata (Boolean) —

    Whether to include metadata in the response (default to false)

  • :offset (String) —

    Starting pagination offset of records to return.

Returns:



563
564
565
566
 
# File 'lib/crimson-falcon/api/foundry_logscale_api.rb', line 563

def get_saved_searches_execute_v1(job_id, opts = {})
  data, _status_code, _headers = get_saved_searches_execute_v1_with_http_info(job_id, opts)
  data
end

#get_saved_searches_execute_v1_with_http_info(job_id, opts = {}) ⇒ Array<(ApidomainQueryResponseWrapperV1, Integer, Hash)>

Get the results of a saved search

Parameters:

  • job_id (String) —

    Job ID for a previously executed async query

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

    the optional parameters

Options Hash (opts):

  • :app_id (String) —

    Application ID.

  • :limit (String) —

    Maximum number of records to return.

  • :metadata (Boolean) —

    Whether to include metadata in the response (default to false)

  • :offset (String) —

    Starting pagination offset of records to return.

Returns:



576
577
578
579
580
581
582
583
584
585
586
587
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
 
# File 'lib/crimson-falcon/api/foundry_logscale_api.rb', line 576

def get_saved_searches_execute_v1_with_http_info(job_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FoundryLogscaleApi.get_saved_searches_execute_v1 ...'
  end
  # verify the required parameter 'job_id' is set
  if @api_client.config.client_side_validation && job_id.nil?
    fail ArgumentError, "Missing the required parameter 'job_id' when calling FoundryLogscaleApi.get_saved_searches_execute_v1"
  end
  # resource path
  local_var_path = '/loggingapi/entities/saved-searches/execute/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'job_id'] = job_id
  query_params[:'app_id'] = opts[:'app_id'] if !opts[:'app_id'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'metadata'] = opts[:'metadata'] if !opts[:'metadata'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].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[:debug_body]

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

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

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

#get_saved_searches_job_results_download_alt_v1(job_id, opts = {}) ⇒ File

Get the results of a saved search as a file

Parameters:

  • job_id (String) —

    Job ID for a previously executed async query

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

    the optional parameters

Options Hash (opts):

  • :result_format (String) —

    Result Format

Returns:

  • (File) 


634
635
636
637
 
# File 'lib/crimson-falcon/api/foundry_logscale_api.rb', line 634

def get_saved_searches_job_results_download_alt_v1(job_id, opts = {})
  data, _status_code, _headers = get_saved_searches_job_results_download_alt_v1_with_http_info(job_id, opts)
  data
end

#get_saved_searches_job_results_download_alt_v1_with_http_info(job_id, opts = {}) ⇒ Array<(File, Integer, Hash)>

Get the results of a saved search as a file

Parameters:

  • job_id (String) —

    Job ID for a previously executed async query

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

    the optional parameters

Options Hash (opts):

  • :result_format (String) —

    Result Format

Returns:

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

    File data, response status code and response headers



644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
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
 
# File 'lib/crimson-falcon/api/foundry_logscale_api.rb', line 644

def get_saved_searches_job_results_download_alt_v1_with_http_info(job_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FoundryLogscaleApi.get_saved_searches_job_results_download_alt_v1 ...'
  end
  # verify the required parameter 'job_id' is set
  if @api_client.config.client_side_validation && job_id.nil?
    fail ArgumentError, "Missing the required parameter 'job_id' when calling FoundryLogscaleApi.get_saved_searches_job_results_download_alt_v1"
  end
  allowable_values = ["json", "csv"]
  if @api_client.config.client_side_validation && opts[:'result_format'] && !allowable_values.include?(opts[:'result_format'])
    fail ArgumentError, "invalid value for \"result_format\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/loggingapi/entities/saved-searches-job-results-download/v1'

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

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

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

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

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

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

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

#get_saved_searches_job_results_download_v1(job_id, opts = {}) ⇒ File

Get the results of a saved search as a file

Parameters:

  • job_id (String) —

    Job ID for a previously executed async query

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

    the optional parameters

Options Hash (opts):

  • :result_format (String) —

    Result Format

Returns:

  • (File) 


703
704
705
706
 
# File 'lib/crimson-falcon/api/foundry_logscale_api.rb', line 703

def get_saved_searches_job_results_download_v1(job_id, opts = {})
  data, _status_code, _headers = get_saved_searches_job_results_download_v1_with_http_info(job_id, opts)
  data
end

#get_saved_searches_job_results_download_v1_with_http_info(job_id, opts = {}) ⇒ Array<(File, Integer, Hash)>

Get the results of a saved search as a file

Parameters:

  • job_id (String) —

    Job ID for a previously executed async query

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

    the optional parameters

Options Hash (opts):

  • :result_format (String) —

    Result Format

Returns:

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

    File data, response status code and response headers



713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
 
# File 'lib/crimson-falcon/api/foundry_logscale_api.rb', line 713

def get_saved_searches_job_results_download_v1_with_http_info(job_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FoundryLogscaleApi.get_saved_searches_job_results_download_v1 ...'
  end
  # verify the required parameter 'job_id' is set
  if @api_client.config.client_side_validation && job_id.nil?
    fail ArgumentError, "Missing the required parameter 'job_id' when calling FoundryLogscaleApi.get_saved_searches_job_results_download_v1"
  end
  allowable_values = ["json", "csv"]
  if @api_client.config.client_side_validation && opts[:'result_format'] && !allowable_values.include?(opts[:'result_format'])
    fail ArgumentError, "invalid value for \"result_format\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/loggingapi/entities/saved-searches/job-results-download/v1'

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

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

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

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

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

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

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

#ingest_data_v1(data_file, opts = {}) ⇒ ClientDataIngestResponseWrapperV1

Ingest data into the application repository

Parameters:

  • data_file (File) —

    Data file to ingest

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

    the optional parameters

Options Hash (opts):

  • :tag (Array<String>) —

    Custom tag for ingested data in the form tag:value

  • :tag_source (String) —

    Tag the data with the specified source

  • :test_data (Boolean) —

    Tag the data with test-ingest (default to false)

Returns:



774
775
776
777
 
# File 'lib/crimson-falcon/api/foundry_logscale_api.rb', line 774

def ingest_data_v1(data_file, opts = {})
  data, _status_code, _headers = ingest_data_v1_with_http_info(data_file, opts)
  data
end

#ingest_data_v1_with_http_info(data_file, opts = {}) ⇒ Array<(ClientDataIngestResponseWrapperV1, Integer, Hash)>

Ingest data into the application repository

Parameters:

  • data_file (File) —

    Data file to ingest

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

    the optional parameters

Options Hash (opts):

  • :tag (Array<String>) —

    Custom tag for ingested data in the form tag:value

  • :tag_source (String) —

    Tag the data with the specified source

  • :test_data (Boolean) —

    Tag the data with test-ingest (default to false)

Returns:



786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
 
# File 'lib/crimson-falcon/api/foundry_logscale_api.rb', line 786

def ingest_data_v1_with_http_info(data_file, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FoundryLogscaleApi.ingest_data_v1 ...'
  end
  # verify the required parameter 'data_file' is set
  if @api_client.config.client_side_validation && data_file.nil?
    fail ArgumentError, "Missing the required parameter 'data_file' when calling FoundryLogscaleApi.ingest_data_v1"
  end
  # resource path
  local_var_path = '/loggingapi/entities/data-ingestion/ingest/v1'

  # 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'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['multipart/form-data'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['data_file'] = data_file
  form_params['tag'] = @api_client.build_collection_param(opts[:'tag'], :csv) if !opts[:'tag'].nil?
  form_params['tag_source'] = opts[:'tag_source'] if !opts[:'tag_source'].nil?
  form_params['test_data'] = opts[:'test_data'] if !opts[:'test_data'].nil?

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

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

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

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

#list_repos_v1(opts = {}) ⇒ ApidomainRepoViewListItemWrapperV1

Lists available repositories and views

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :check_test_data (Boolean) —

    Include whether test data is present in the application repository (default to false)

Returns:



847
848
849
850
 
# File 'lib/crimson-falcon/api/foundry_logscale_api.rb', line 847

def list_repos_v1(opts = {})
  data, _status_code, _headers = list_repos_v1_with_http_info(opts)
  data
end

#list_repos_v1_with_http_info(opts = {}) ⇒ Array<(ApidomainRepoViewListItemWrapperV1, Integer, Hash)>

Lists available repositories and views

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :check_test_data (Boolean) —

    Include whether test data is present in the application repository (default to false)

Returns:



856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
 
# File 'lib/crimson-falcon/api/foundry_logscale_api.rb', line 856

def list_repos_v1_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FoundryLogscaleApi.list_repos_v1 ...'
  end
  # resource path
  local_var_path = '/loggingapi/combined/repos/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'check_test_data'] = opts[:'check_test_data'] if !opts[:'check_test_data'].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[:debug_body]

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

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

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

#list_view_v1(opts = {}) ⇒ ApidomainRepoViewListItemWrapperV1

List views

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :check_test_data (Boolean) —

    Include whether test data is present in the application repository (default to false)

Returns:



905
906
907
908
 
# File 'lib/crimson-falcon/api/foundry_logscale_api.rb', line 905

def list_view_v1(opts = {})
  data, _status_code, _headers = list_view_v1_with_http_info(opts)
  data
end

#list_view_v1_with_http_info(opts = {}) ⇒ Array<(ApidomainRepoViewListItemWrapperV1, Integer, Hash)>

List views

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :check_test_data (Boolean) —

    Include whether test data is present in the application repository (default to false)

Returns:



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
 
# File 'lib/crimson-falcon/api/foundry_logscale_api.rb', line 914

def list_view_v1_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FoundryLogscaleApi.list_view_v1 ...'
  end
  # resource path
  local_var_path = '/loggingapi/entities/views/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'check_test_data'] = opts[:'check_test_data'] if !opts[:'check_test_data'].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[:debug_body]

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

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

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