Class: DatadogAPIClient::V2::EndUserDeviceMonitoringAPI

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of EndUserDeviceMonitoringAPI.



22
23
24
 
# File 'lib/datadog_api_client/v2/api/end_user_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/end_user_device_monitoring_api.rb', line 20

def api_client
  @api_client
end

Instance Method Details

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

Get a device.

See Also:



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

def get_eudm_device(device_id, opts = {})
  data, _status_code, _headers = get_eudm_device_with_http_info(device_id, opts)
  data
end

#get_eudm_device_with_http_info(device_id, opts = {}) ⇒ Array<(DeviceDetails, Integer, Hash)>

Get a device.

Parameters:

  • device_id (String) —

    Unique identifier of the device to fetch. Matches the Datadog host identifier.

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

    the optional parameters

Returns:

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

    DeviceDetails data, response status code and response headers



38
39
40
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
90
91
92
 
# File 'lib/datadog_api_client/v2/api/end_user_device_monitoring_api.rb', line 38

def get_eudm_device_with_http_info(device_id, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.get_eudm_device".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.get_eudm_device")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.get_eudm_device"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EndUserDeviceMonitoringAPI.get_eudm_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 EndUserDeviceMonitoringAPI.get_eudm_device"
  end
  # resource path
  local_var_path = '/api/v2/eudm/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] || 'DeviceDetails'

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

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

#get_eudm_devices(opts = {}) ⇒ Object

Get all devices.

See Also:



97
98
99
100
 
# File 'lib/datadog_api_client/v2/api/end_user_device_monitoring_api.rb', line 97

def get_eudm_devices(opts = {})
  data, _status_code, _headers = get_eudm_devices_with_http_info(opts)
  data
end

#get_eudm_devices_with_http_info(opts = {}) ⇒ Array<(DeviceBaseArray, Integer, Hash)>

Get all devices.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :bssid (Array<String>) —

    Filter devices to those currently associated with any of the given BSSID values. Each value must be a MAC-48 address; repeat the parameter to pass several values.

  • :page_limit (Integer) —

    Maximum number of devices to return in one page. Must be a positive integer. If not set, the response contains all matching devices.

  • :page_cursor (String) —

    Opaque cursor that selects the next page. Use the meta.page.after value of the previous response. Devices are ordered by ID.

Returns:

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

    DeviceBaseArray data, response status code and response headers



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
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/datadog_api_client/v2/api/end_user_device_monitoring_api.rb', line 108

def get_eudm_devices_with_http_info(opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.get_eudm_devices".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.get_eudm_devices")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.get_eudm_devices"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EndUserDeviceMonitoringAPI.get_eudm_devices ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page_limit'].nil? && opts[:'page_limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_limit"]" when calling EndUserDeviceMonitoringAPI.get_eudm_devices, must be greater than or equal to 1.'
  end
  # resource path
  local_var_path = '/api/v2/eudm/devices'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'bssid'] = @api_client.build_collection_param(opts[:'bssid'], :multi) if !opts[:'bssid'].nil?
  query_params[:'page[limit]'] = opts[:'page_limit'] if !opts[:'page_limit'].nil?
  query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].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] || 'DeviceBaseArray'

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

  new_options = opts.merge(
    :operation => :get_eudm_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"
  )
  new_options[:query_string_normalizer] = HTTParty::Request::NON_RAILS_QUERY_STRING_NORMALIZER

  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: EndUserDeviceMonitoringAPI#get_eudm_devices\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end