Class: DatadogAPIClient::V2::DashboardListsAPI

Inherits:
Object
  • Object
show all
Defined in:
lib/datadog_api_client/v2/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/v2/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/v2/api/dashboard_lists_api.rb', line 20

def api_client
  @api_client
end

Instance Method Details

#create_dashboard_list_items(dashboard_list_id, body, opts = {}) ⇒ Object

Add Items to a Dashboard List.

See Also:



31
32
33
34
 
# File 'lib/datadog_api_client/v2/api/dashboard_lists_api.rb', line 31

def create_dashboard_list_items(dashboard_list_id, body, opts = {})
  data, _status_code, _headers = create_dashboard_list_items_with_http_info(dashboard_list_id, body, opts)
  data
end

#create_dashboard_list_items_with_http_info(dashboard_list_id, body, opts = {}) ⇒ Array<(DashboardListAddItemsResponse, Integer, Hash)>

Add Items to a Dashboard List.

Add dashboards to an existing dashboard list.

Parameters:

  • dashboard_list_id (Integer) —

    ID of the dashboard list to add items to.

  • body (DashboardListAddItemsRequest) —

    Dashboards to add to the dashboard list.

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

    the optional parameters

Returns:



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
99
100
101
102
103
104
 
# File 'lib/datadog_api_client/v2/api/dashboard_lists_api.rb', line 42

def create_dashboard_list_items_with_http_info(dashboard_list_id, body, opts = {})

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

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

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

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

#delete_dashboard_list_items(dashboard_list_id, body, opts = {}) ⇒ Object

Delete items from a dashboard list.

See Also:



112
113
114
115
 
# File 'lib/datadog_api_client/v2/api/dashboard_lists_api.rb', line 112

def delete_dashboard_list_items(dashboard_list_id, body, opts = {})
  data, _status_code, _headers = delete_dashboard_list_items_with_http_info(dashboard_list_id, body, opts)
  data
end

#delete_dashboard_list_items_with_http_info(dashboard_list_id, body, opts = {}) ⇒ Array<(DashboardListDeleteItemsResponse, Integer, Hash)>

Delete items from a dashboard list.

Delete dashboards from an existing dashboard list.

Parameters:

  • dashboard_list_id (Integer) —

    ID of the dashboard list to delete items from.

  • body (DashboardListDeleteItemsRequest) —

    Dashboards to delete from the dashboard list.

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

    the optional parameters

Returns:



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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/datadog_api_client/v2/api/dashboard_lists_api.rb', line 123

def delete_dashboard_list_items_with_http_info(dashboard_list_id, body, opts = {})

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

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

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

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

#get_dashboard_list_items(dashboard_list_id, opts = {}) ⇒ Object

Get items of a Dashboard List.

See Also:



192
193
194
195
 
# File 'lib/datadog_api_client/v2/api/dashboard_lists_api.rb', line 192

def get_dashboard_list_items(dashboard_list_id, opts = {})
  data, _status_code, _headers = get_dashboard_list_items_with_http_info(dashboard_list_id, opts)
  data
end

#get_dashboard_list_items_with_http_info(dashboard_list_id, opts = {}) ⇒ Array<(DashboardListItems, Integer, Hash)>

Get items of a Dashboard List.

Fetch the dashboard list’s dashboard definitions.

Parameters:

  • dashboard_list_id (Integer) —

    ID of the dashboard list to get items from.

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

    the optional parameters

Returns:

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

    DashboardListItems data, response status code and response headers



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
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/datadog_api_client/v2/api/dashboard_lists_api.rb', line 202

def get_dashboard_list_items_with_http_info(dashboard_list_id, opts = {})

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

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

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

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

#update_dashboard_list_items(dashboard_list_id, body, opts = {}) ⇒ Object

Update items of a dashboard list.

See Also:



266
267
268
269
 
# File 'lib/datadog_api_client/v2/api/dashboard_lists_api.rb', line 266

def update_dashboard_list_items(dashboard_list_id, body, opts = {})
  data, _status_code, _headers = update_dashboard_list_items_with_http_info(dashboard_list_id, body, opts)
  data
end

#update_dashboard_list_items_with_http_info(dashboard_list_id, body, opts = {}) ⇒ Array<(DashboardListUpdateItemsResponse, Integer, Hash)>

Update items of a dashboard list.

Update dashboards of an existing dashboard list.

Parameters:

  • dashboard_list_id (Integer) —

    ID of the dashboard list to update items from.

  • body (DashboardListUpdateItemsRequest) —

    New dashboards of the dashboard list.

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

    the optional parameters

Returns:



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

def update_dashboard_list_items_with_http_info(dashboard_list_id, body, opts = {})

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

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

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

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