Class: DatadogAPIClient::V2::NetworkDeviceMonitoringAPI

Inherits:
Object
  • Object
show all
Defined in:
lib/datadog_api_client/v2/api/network_device_monitoring_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = DatadogAPIClient::APIClient.default) ⇒ NetworkDeviceMonitoringAPI

Returns a new instance of NetworkDeviceMonitoringAPI.



22
23
24
 
# File 'lib/datadog_api_client/v2/api/network_device_monitoring_api.rb', line 22

def initialize(api_client = DatadogAPIClient::APIClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



20
21
22
 
# File 'lib/datadog_api_client/v2/api/network_device_monitoring_api.rb', line 20

def api_client
  @api_client
end

Instance Method Details

#get_device(device_id, opts = {}) ⇒ Object

Get the device details.

See Also:



29
30
31
32
 
# File 'lib/datadog_api_client/v2/api/network_device_monitoring_api.rb', line 29

def get_device(device_id, opts = {})
  data, _status_code, _headers = get_device_with_http_info(device_id, opts)
  data
end

#get_device_with_http_info(device_id, opts = {}) ⇒ Array<(GetDeviceResponse, Integer, Hash)>

Get the device details.

Get the device details.

Parameters:

  • device_id (String) —

    The id of the device to fetch.

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

    the optional parameters

Returns:

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

    GetDeviceResponse 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/datadog_api_client/v2/api/network_device_monitoring_api.rb', line 41

def get_device_with_http_info(device_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NetworkDeviceMonitoringAPI.get_device ...'
  end
  # verify the required parameter 'device_id' is set
  if @api_client.config.client_side_validation && device_id.nil?
    fail ArgumentError, "Missing the required parameter 'device_id' when calling NetworkDeviceMonitoringAPI.get_device"
  end
  # resource path
  local_var_path = '/api/v2/ndm/devices/{device_id}'.sub('{device_id}', CGI.escape(device_id.to_s).gsub('%2F', '/'))

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

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :get_device,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: NetworkDeviceMonitoringAPI#get_device\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_interfaces(device_id, opts = {}) ⇒ Object

Get the list of interfaces of the device.

See Also:



94
95
96
97
 
# File 'lib/datadog_api_client/v2/api/network_device_monitoring_api.rb', line 94

def get_interfaces(device_id, opts = {})
  data, _status_code, _headers = get_interfaces_with_http_info(device_id, opts)
  data
end

#get_interfaces_with_http_info(device_id, opts = {}) ⇒ Array<(GetInterfacesResponse, Integer, Hash)>

Get the list of interfaces of the device.

Get the list of interfaces of the device.

Parameters:

  • device_id (String) —

    The ID of the device to get interfaces from.

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

    the optional parameters

Returns:

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

    GetInterfacesResponse data, response status code and response headers



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/datadog_api_client/v2/api/network_device_monitoring_api.rb', line 106

def get_interfaces_with_http_info(device_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NetworkDeviceMonitoringAPI.get_interfaces ...'
  end
  # verify the required parameter 'device_id' is set
  if @api_client.config.client_side_validation && device_id.nil?
    fail ArgumentError, "Missing the required parameter 'device_id' when calling NetworkDeviceMonitoringAPI.get_interfaces"
  end
  # resource path
  local_var_path = '/api/v2/ndm/interfaces'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'device_id'] = device_id

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

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :get_interfaces,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: NetworkDeviceMonitoringAPI#get_interfaces\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_device_user_tags(device_id, opts = {}) ⇒ Object

Get the list of tags for a device.

See Also:



228
229
230
231
 
# File 'lib/datadog_api_client/v2/api/network_device_monitoring_api.rb', line 228

def list_device_user_tags(device_id, opts = {})
  data, _status_code, _headers = list_device_user_tags_with_http_info(device_id, opts)
  data
end

#list_device_user_tags_with_http_info(device_id, opts = {}) ⇒ Array<(ListTagsResponse, Integer, Hash)>

Get the list of tags for a device.

Get the list of tags for a device.

Parameters:

  • device_id (String) —

    The id of the device to fetch tags for.

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

    the optional parameters

Returns:

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

    ListTagsResponse data, response status code and response headers



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
286
287
288
 
# File 'lib/datadog_api_client/v2/api/network_device_monitoring_api.rb', line 240

def list_device_user_tags_with_http_info(device_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NetworkDeviceMonitoringAPI.list_device_user_tags ...'
  end
  # verify the required parameter 'device_id' is set
  if @api_client.config.client_side_validation && device_id.nil?
    fail ArgumentError, "Missing the required parameter 'device_id' when calling NetworkDeviceMonitoringAPI.list_device_user_tags"
  end
  # resource path
  local_var_path = '/api/v2/ndm/tags/devices/{device_id}'.sub('{device_id}', CGI.escape(device_id.to_s).gsub('%2F', '/'))

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

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :list_device_user_tags,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: NetworkDeviceMonitoringAPI#list_device_user_tags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_devices(opts = {}) ⇒ Object

Get the list of devices.

See Also:



160
161
162
163
 
# File 'lib/datadog_api_client/v2/api/network_device_monitoring_api.rb', line 160

def list_devices(opts = {})
  data, _status_code, _headers = list_devices_with_http_info(opts)
  data
end

#list_devices_with_http_info(opts = {}) ⇒ Array<(ListDevicesResponse, Integer, Hash)>

Get the list of devices.

Get the list of devices.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_number (Integer) —

    The page number to fetch.

  • :page_size (Integer) —

    The number of devices to return per page.

  • :sort (String) —

    The field to sort the devices by.

  • :filter_tag (String) —

    Filter devices by tag.

Returns:

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

    ListDevicesResponse data, response status code and response headers



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
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/datadog_api_client/v2/api/network_device_monitoring_api.rb', line 175

def list_devices_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NetworkDeviceMonitoringAPI.list_devices ...'
  end
  # resource path
  local_var_path = '/api/v2/ndm/devices'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page[number]'] = opts[:'page_number'] if !opts[:'page_number'].nil?
  query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'filter[tag]'] = opts[:'filter_tag'] if !opts[:'filter_tag'].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] || 'ListDevicesResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :list_devices,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: NetworkDeviceMonitoringAPI#list_devices\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_device_user_tags(device_id, body, opts = {}) ⇒ Object

Update the tags for a device.

See Also:



293
294
295
296
 
# File 'lib/datadog_api_client/v2/api/network_device_monitoring_api.rb', line 293

def update_device_user_tags(device_id, body, opts = {})
  data, _status_code, _headers = update_device_user_tags_with_http_info(device_id, body, opts)
  data
end

#update_device_user_tags_with_http_info(device_id, body, opts = {}) ⇒ Array<(ListTagsResponse, Integer, Hash)>

Update the tags for a device.

Update the tags for a device.

Parameters:

  • device_id (String) —

    The id of the device to update tags for.

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

    the optional parameters

Returns:

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

    ListTagsResponse data, response status code and response headers



306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
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
 
# File 'lib/datadog_api_client/v2/api/network_device_monitoring_api.rb', line 306

def update_device_user_tags_with_http_info(device_id, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NetworkDeviceMonitoringAPI.update_device_user_tags ...'
  end
  # verify the required parameter 'device_id' is set
  if @api_client.config.client_side_validation && device_id.nil?
    fail ArgumentError, "Missing the required parameter 'device_id' when calling NetworkDeviceMonitoringAPI.update_device_user_tags"
  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 NetworkDeviceMonitoringAPI.update_device_user_tags"
  end
  # resource path
  local_var_path = '/api/v2/ndm/tags/devices/{device_id}'.sub('{device_id}', CGI.escape(device_id.to_s).gsub('%2F', '/'))

  # 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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :update_device_user_tags,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Patch, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: NetworkDeviceMonitoringAPI#update_device_user_tags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end