Class: Falcon::SensorVisibilityExclusionsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SensorVisibilityExclusionsApi

Returns a new instance of SensorVisibilityExclusionsApi.



36
37
38
 
# File 'lib/crimson-falcon/api/sensor_visibility_exclusions_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/sensor_visibility_exclusions_api.rb', line 34

def api_client
  @api_client
end

Instance Method Details

#create_sv_exclusions_v1(body, opts = {}) ⇒ ExclusionsRespV1

Create the sensor visibility exclusions

Parameters:

Returns:



43
44
45
46
 
# File 'lib/crimson-falcon/api/sensor_visibility_exclusions_api.rb', line 43

def create_sv_exclusions_v1(body, opts = {})
  data, _status_code, _headers = create_sv_exclusions_v1_with_http_info(body, opts)
  data
end

#create_sv_exclusions_v1_with_http_info(body, opts = {}) ⇒ Array<(ExclusionsRespV1, Integer, Hash)>

Create the sensor visibility exclusions

Parameters:

Returns:

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

    ExclusionsRespV1 data, response status code and response headers



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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/crimson-falcon/api/sensor_visibility_exclusions_api.rb', line 52

def create_sv_exclusions_v1_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SensorVisibilityExclusionsApi.create_sv_exclusions_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 SensorVisibilityExclusionsApi.create_sv_exclusions_v1"
  end
  # resource path
  local_var_path = '/policy/entities/sv-exclusions/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(['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] || 'ExclusionsRespV1'

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

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

#delete_sensor_visibility_exclusions_v1(ids, opts = {}) ⇒ MsaQueryResponse

Delete the sensor visibility exclusions by id

Parameters:

  • ids (Array<String>) —

    The ids of the exclusions to delete

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

    the optional parameters

Options Hash (opts):

  • :comment (String) —

    Explains why this exclusions was deleted

Returns:



110
111
112
113
 
# File 'lib/crimson-falcon/api/sensor_visibility_exclusions_api.rb', line 110

def delete_sensor_visibility_exclusions_v1(ids, opts = {})
  data, _status_code, _headers = delete_sensor_visibility_exclusions_v1_with_http_info(ids, opts)
  data
end

#delete_sensor_visibility_exclusions_v1_with_http_info(ids, opts = {}) ⇒ Array<(MsaQueryResponse, Integer, Hash)>

Delete the sensor visibility exclusions by id

Parameters:

  • ids (Array<String>) —

    The ids of the exclusions to delete

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

    the optional parameters

Options Hash (opts):

  • :comment (String) —

    Explains why this exclusions was deleted

Returns:

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

    MsaQueryResponse data, response status code and response headers



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/crimson-falcon/api/sensor_visibility_exclusions_api.rb', line 120

def delete_sensor_visibility_exclusions_v1_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SensorVisibilityExclusionsApi.delete_sensor_visibility_exclusions_v1 ...'
  end
  # verify the required parameter 'ids' is set
  if @api_client.config.client_side_validation && ids.nil?
    fail ArgumentError, "Missing the required parameter 'ids' when calling SensorVisibilityExclusionsApi.delete_sensor_visibility_exclusions_v1"
  end
  # resource path
  local_var_path = '/policy/entities/sv-exclusions/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'ids'] = @api_client.build_collection_param(ids, :multi)
  query_params[:'comment'] = opts[:'comment'] if !opts[:'comment'].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] || 'MsaQueryResponse'

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

  new_options = opts.merge(
    :operation => :"SensorVisibilityExclusionsApi.delete_sensor_visibility_exclusions_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(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SensorVisibilityExclusionsApi#delete_sensor_visibility_exclusions_v1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_sensor_visibility_exclusions_v1(ids, opts = {}) ⇒ SvExclusionsRespV1

Get a set of Sensor Visibility Exclusions by specifying their IDs

Parameters:

  • ids (Array<String>) —

    The ids of the exclusions to retrieve

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

    the optional parameters

Returns:



174
175
176
177
 
# File 'lib/crimson-falcon/api/sensor_visibility_exclusions_api.rb', line 174

def get_sensor_visibility_exclusions_v1(ids, opts = {})
  data, _status_code, _headers = get_sensor_visibility_exclusions_v1_with_http_info(ids, opts)
  data
end

#get_sensor_visibility_exclusions_v1_with_http_info(ids, opts = {}) ⇒ Array<(SvExclusionsRespV1, Integer, Hash)>

Get a set of Sensor Visibility Exclusions by specifying their IDs

Parameters:

  • ids (Array<String>) —

    The ids of the exclusions to retrieve

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

    the optional parameters

Returns:

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

    SvExclusionsRespV1 data, response status code and response headers



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
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/crimson-falcon/api/sensor_visibility_exclusions_api.rb', line 183

def get_sensor_visibility_exclusions_v1_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SensorVisibilityExclusionsApi.get_sensor_visibility_exclusions_v1 ...'
  end
  # verify the required parameter 'ids' is set
  if @api_client.config.client_side_validation && ids.nil?
    fail ArgumentError, "Missing the required parameter 'ids' when calling SensorVisibilityExclusionsApi.get_sensor_visibility_exclusions_v1"
  end
  # resource path
  local_var_path = '/policy/entities/sv-exclusions/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'ids'] = @api_client.build_collection_param(ids, :multi)

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

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

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

#query_sensor_visibility_exclusions_v1(opts = {}) ⇒ MsaQueryResponse

Search for sensor visibility exclusions.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    The filter expression that should be used to limit the results.

  • :offset (Integer) —

    The offset to start retrieving records from

  • :limit (Integer) —

    The maximum records to return. [1-500]

  • :sort (String) —

    The sort expression that should be used to sort the results.

Returns:



239
240
241
242
 
# File 'lib/crimson-falcon/api/sensor_visibility_exclusions_api.rb', line 239

def query_sensor_visibility_exclusions_v1(opts = {})
  data, _status_code, _headers = query_sensor_visibility_exclusions_v1_with_http_info(opts)
  data
end

#query_sensor_visibility_exclusions_v1_with_http_info(opts = {}) ⇒ Array<(MsaQueryResponse, Integer, Hash)>

Search for sensor visibility exclusions.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    The filter expression that should be used to limit the results.

  • :offset (Integer) —

    The offset to start retrieving records from

  • :limit (Integer) —

    The maximum records to return. [1-500]

  • :sort (String) —

    The sort expression that should be used to sort the results.

Returns:

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

    MsaQueryResponse data, response status code and response headers



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
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/crimson-falcon/api/sensor_visibility_exclusions_api.rb', line 251

def query_sensor_visibility_exclusions_v1_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SensorVisibilityExclusionsApi.query_sensor_visibility_exclusions_v1 ...'
  end
  allowable_values = ["applied_globally.asc", "applied_globally.desc", "created_by.asc", "created_by.desc", "created_on.asc", "created_on.desc", "last_modified.asc", "last_modified.desc", "modified_by.asc", "modified_by.desc", "value.asc", "value.desc"]
  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 = '/policy/queries/sv-exclusions/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].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] || 'MsaQueryResponse'

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

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

#update_sensor_visibility_exclusions_v1(body, opts = {}) ⇒ SvExclusionsRespV1

Update the sensor visibility exclusions

Parameters:

Returns:



307
308
309
310
 
# File 'lib/crimson-falcon/api/sensor_visibility_exclusions_api.rb', line 307

def update_sensor_visibility_exclusions_v1(body, opts = {})
  data, _status_code, _headers = update_sensor_visibility_exclusions_v1_with_http_info(body, opts)
  data
end

#update_sensor_visibility_exclusions_v1_with_http_info(body, opts = {}) ⇒ Array<(SvExclusionsRespV1, Integer, Hash)>

Update the sensor visibility exclusions

Parameters:

Returns:

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

    SvExclusionsRespV1 data, response status code and response headers



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
364
365
366
367
 
# File 'lib/crimson-falcon/api/sensor_visibility_exclusions_api.rb', line 316

def update_sensor_visibility_exclusions_v1_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SensorVisibilityExclusionsApi.update_sensor_visibility_exclusions_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 SensorVisibilityExclusionsApi.update_sensor_visibility_exclusions_v1"
  end
  # resource path
  local_var_path = '/policy/entities/sv-exclusions/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(['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] || 'SvExclusionsRespV1'

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

  new_options = opts.merge(
    :operation => :"SensorVisibilityExclusionsApi.update_sensor_visibility_exclusions_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(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SensorVisibilityExclusionsApi#update_sensor_visibility_exclusions_v1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end