Class: DatadogAPIClient::V1::DashboardListsAPI

Inherits:
Object
  • Object
show all
Defined in:
lib/datadog_api_client/v1/api/dashboard_lists_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of DashboardListsAPI.



22
23
24
 
# File 'lib/datadog_api_client/v1/api/dashboard_lists_api.rb', line 22

def initialize(api_client = 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/v1/api/dashboard_lists_api.rb', line 20

def api_client
  @api_client
end

Instance Method Details

#create_dashboard_list(body, opts = {}) ⇒ Object

Create a dashboard list.

See Also:



30
31
32
33
 
# File 'lib/datadog_api_client/v1/api/dashboard_lists_api.rb', line 30

def create_dashboard_list(body, opts = {})
  data, _status_code, _headers = create_dashboard_list_with_http_info(body, opts)
  data
end

#create_dashboard_list_with_http_info(body, opts = {}) ⇒ Array<(DashboardList, Integer, Hash)>

Create a dashboard list.

Create an empty dashboard list.

Parameters:

  • body (DashboardList) —

    Create a dashboard list request body.

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

    the optional parameters

Returns:

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

    DashboardList data, response status code and response headers



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
93
94
95
96
97
98
 
# File 'lib/datadog_api_client/v1/api/dashboard_lists_api.rb', line 40

def create_dashboard_list_with_http_info(body, opts = {})

  if @api_client.config.unstable_operations.has_key?(:create_dashboard_list)
    unstable_enabled = @api_client.config.unstable_operations[:create_dashboard_list]
    if unstable_enabled
      @api_client.config.logger.warn format("Using unstable operation '%s'", "create_dashboard_list")
    else
      raise APIError.new(message: format("Unstable operation '%s' is disabled", "create_dashboard_list"))
    end
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DashboardListsAPI.create_dashboard_list ...'
  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 DashboardListsAPI.create_dashboard_list"
  end
  # resource path
  local_var_path = '/api/v1/dashboard/lists/manual'

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

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

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

#delete_dashboard_list(list_id, opts = {}) ⇒ Object

Delete a dashboard list.

See Also:



105
106
107
108
 
# File 'lib/datadog_api_client/v1/api/dashboard_lists_api.rb', line 105

def delete_dashboard_list(list_id, opts = {})
  data, _status_code, _headers = delete_dashboard_list_with_http_info(list_id, opts)
  data
end

#delete_dashboard_list_with_http_info(list_id, opts = {}) ⇒ Array<(DashboardListDeleteResponse, Integer, Hash)>

Delete a dashboard list.

Delete a dashboard list.

Parameters:

  • list_id (Integer) —

    ID of the dashboard list to delete.

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

    the optional parameters

Returns:

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

    DashboardListDeleteResponse data, response status code and response headers



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
169
170
171
 
# File 'lib/datadog_api_client/v1/api/dashboard_lists_api.rb', line 115

def delete_dashboard_list_with_http_info(list_id, opts = {})

  if @api_client.config.unstable_operations.has_key?(:delete_dashboard_list)
    unstable_enabled = @api_client.config.unstable_operations[:delete_dashboard_list]
    if unstable_enabled
      @api_client.config.logger.warn format("Using unstable operation '%s'", "delete_dashboard_list")
    else
      raise APIError.new(message: format("Unstable operation '%s' is disabled", "delete_dashboard_list"))
    end
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DashboardListsAPI.delete_dashboard_list ...'
  end
  # verify the required parameter 'list_id' is set
  if @api_client.config.client_side_validation && list_id.nil?
    fail ArgumentError, "Missing the required parameter 'list_id' when calling DashboardListsAPI.delete_dashboard_list"
  end
  # resource path
  local_var_path = '/api/v1/dashboard/lists/manual/{list_id}'.sub('{' + 'list_id' + '}', CGI.escape(list_id.to_s))

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

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

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

#get_dashboard_list(list_id, opts = {}) ⇒ Object

Get a dashboard list.

See Also:



178
179
180
181
 
# File 'lib/datadog_api_client/v1/api/dashboard_lists_api.rb', line 178

def get_dashboard_list(list_id, opts = {})
  data, _status_code, _headers = get_dashboard_list_with_http_info(list_id, opts)
  data
end

#get_dashboard_list_with_http_info(list_id, opts = {}) ⇒ Array<(DashboardList, Integer, Hash)>

Get a dashboard list.

Fetch an existing dashboard list's definition.

Parameters:

  • list_id (Integer) —

    ID of the dashboard list to fetch.

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

    the optional parameters

Returns:

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

    DashboardList data, response status code and response headers



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
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/datadog_api_client/v1/api/dashboard_lists_api.rb', line 188

def get_dashboard_list_with_http_info(list_id, opts = {})

  if @api_client.config.unstable_operations.has_key?(:get_dashboard_list)
    unstable_enabled = @api_client.config.unstable_operations[:get_dashboard_list]
    if unstable_enabled
      @api_client.config.logger.warn format("Using unstable operation '%s'", "get_dashboard_list")
    else
      raise APIError.new(message: format("Unstable operation '%s' is disabled", "get_dashboard_list"))
    end
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DashboardListsAPI.get_dashboard_list ...'
  end
  # verify the required parameter 'list_id' is set
  if @api_client.config.client_side_validation && list_id.nil?
    fail ArgumentError, "Missing the required parameter 'list_id' when calling DashboardListsAPI.get_dashboard_list"
  end
  # resource path
  local_var_path = '/api/v1/dashboard/lists/manual/{list_id}'.sub('{' + 'list_id' + '}', CGI.escape(list_id.to_s))

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

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

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

#list_dashboard_lists(opts = {}) ⇒ Object

Get all dashboard lists.

See Also:



250
251
252
253
 
# File 'lib/datadog_api_client/v1/api/dashboard_lists_api.rb', line 250

def list_dashboard_lists(opts = {})
  data, _status_code, _headers = list_dashboard_lists_with_http_info(opts)
  data
end

#list_dashboard_lists_with_http_info(opts = {}) ⇒ Array<(DashboardListListResponse, Integer, Hash)>

Get all dashboard lists.

Fetch all of your existing dashboard list definitions.

Parameters:

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

    the optional parameters

Returns:

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

    DashboardListListResponse data, response status code and response headers



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
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/datadog_api_client/v1/api/dashboard_lists_api.rb', line 259

def list_dashboard_lists_with_http_info(opts = {})

  if @api_client.config.unstable_operations.has_key?(:list_dashboard_lists)
    unstable_enabled = @api_client.config.unstable_operations[:list_dashboard_lists]
    if unstable_enabled
      @api_client.config.logger.warn format("Using unstable operation '%s'", "list_dashboard_lists")
    else
      raise APIError.new(message: format("Unstable operation '%s' is disabled", "list_dashboard_lists"))
    end
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DashboardListsAPI.list_dashboard_lists ...'
  end
  # resource path
  local_var_path = '/api/v1/dashboard/lists/manual'

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

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

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

#update_dashboard_list(list_id, body, opts = {}) ⇒ Object

Update a dashboard list.

See Also:



319
320
321
322
 
# File 'lib/datadog_api_client/v1/api/dashboard_lists_api.rb', line 319

def update_dashboard_list(list_id, body, opts = {})
  data, _status_code, _headers = update_dashboard_list_with_http_info(list_id, body, opts)
  data
end

#update_dashboard_list_with_http_info(list_id, body, opts = {}) ⇒ Array<(DashboardList, Integer, Hash)>

Update a dashboard list.

Update the name of a dashboard list.

Parameters:

  • list_id (Integer) —

    ID of the dashboard list to update.

  • body (DashboardList) —

    Update a dashboard list request body.

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

    the optional parameters

Returns:

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

    DashboardList data, response status code and response headers



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
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
 
# File 'lib/datadog_api_client/v1/api/dashboard_lists_api.rb', line 330

def update_dashboard_list_with_http_info(list_id, body, opts = {})

  if @api_client.config.unstable_operations.has_key?(:update_dashboard_list)
    unstable_enabled = @api_client.config.unstable_operations[:update_dashboard_list]
    if unstable_enabled
      @api_client.config.logger.warn format("Using unstable operation '%s'", "update_dashboard_list")
    else
      raise APIError.new(message: format("Unstable operation '%s' is disabled", "update_dashboard_list"))
    end
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DashboardListsAPI.update_dashboard_list ...'
  end
  # verify the required parameter 'list_id' is set
  if @api_client.config.client_side_validation && list_id.nil?
    fail ArgumentError, "Missing the required parameter 'list_id' when calling DashboardListsAPI.update_dashboard_list"
  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 DashboardListsAPI.update_dashboard_list"
  end
  # resource path
  local_var_path = '/api/v1/dashboard/lists/manual/{list_id}'.sub('{' + 'list_id' + '}', CGI.escape(list_id.to_s))

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

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

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