Class: DatadogAPIClient::V2::AnnotationsAPI

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of AnnotationsAPI.



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

def api_client
  @api_client
end

Instance Method Details

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

Create an annotation.

See Also:



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

def create_annotation(body, opts = {})
  data, _status_code, _headers = create_annotation_with_http_info(body, opts)
  data
end

#create_annotation_with_http_info(body, opts = {}) ⇒ Array<(AnnotationResponse, Integer, Hash)>

Create an annotation.

Creates a new annotation on a dashboard or notebook page. Valid color values: gray, blue, purple, green, yellow, red. Valid type values: pointInTime (marks a single moment) or timeRegion (spans a range and requires end_time).

Parameters:

  • body (AnnotationCreateRequest) —

    Annotation to create.

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

    the optional parameters

Returns:

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

    AnnotationResponse data, response status code and response headers



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

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AnnotationsAPI.create_annotation ...'
  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 AnnotationsAPI.create_annotation"
  end
  # resource path
  local_var_path = '/api/v2/annotation'

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

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

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

#delete_annotation(annotation_id, opts = {}) ⇒ Object

Delete an annotation.

See Also:



104
105
106
107
 
# File 'lib/datadog_api_client/v2/api/annotations_api.rb', line 104

def delete_annotation(annotation_id, opts = {})
  delete_annotation_with_http_info(annotation_id, opts)
  nil
end

#delete_annotation_with_http_info(annotation_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete an annotation.

Deletes an existing annotation by ID. Returns 204 No Content if the annotation does not exist (idempotent).

Parameters:

  • annotation_id (UUID) —

    The ID of the annotation.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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/v2/api/annotations_api.rb', line 117

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AnnotationsAPI.delete_annotation ...'
  end
  # verify the required parameter 'annotation_id' is set
  if @api_client.config.client_side_validation && annotation_id.nil?
    fail ArgumentError, "Missing the required parameter 'annotation_id' when calling AnnotationsAPI.delete_annotation"
  end
  # resource path
  local_var_path = '/api/v2/annotation/{annotation_id}'.sub('{annotation_id}', CGI.escape(annotation_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(['*/*'])

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

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

#get_page_annotations(page_id, start_time, end_time, opts = {}) ⇒ Object

Get annotations for a page.

See Also:



176
177
178
179
 
# File 'lib/datadog_api_client/v2/api/annotations_api.rb', line 176

def get_page_annotations(page_id, start_time, end_time, opts = {})
  data, _status_code, _headers = get_page_annotations_with_http_info(page_id, start_time, end_time, opts)
  data
end

#get_page_annotations_with_http_info(page_id, start_time, end_time, opts = {}) ⇒ Array<(PageAnnotationsResponse, Integer, Hash)>

Get annotations for a page.

Returns all annotations on a specific page for a given time window, grouped by widget. Unlike ListAnnotations, this endpoint returns a single structured object with annotations indexed by their ID and a widget-to-annotation mapping for easy UI rendering.

Parameters:

  • page_id (String) —

    The ID of the page, prefixed with the page type and joined by a colon (for example, dashboard:abc-def-xyz or notebook:1234567890).

  • start_time (Integer) —

    Start of the time window in milliseconds since the Unix epoch.

  • end_time (Integer) —

    End of the time window in milliseconds since the Unix epoch.

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

    the optional parameters

Returns:

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

    PageAnnotationsResponse data, response status code and response headers



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

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

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

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

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

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

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

#list_annotations(page_id, start_time, end_time, opts = {}) ⇒ Object

List annotations.

See Also:



261
262
263
264
 
# File 'lib/datadog_api_client/v2/api/annotations_api.rb', line 261

def list_annotations(page_id, start_time, end_time, opts = {})
  data, _status_code, _headers = list_annotations_with_http_info(page_id, start_time, end_time, opts)
  data
end

#list_annotations_with_http_info(page_id, start_time, end_time, opts = {}) ⇒ Array<(AnnotationsResponse, Integer, Hash)>

List annotations.

Returns a flat list of annotations matching the given page, time window, and optional widget filter.

Parameters:

  • page_id (String) —

    ID of the page to list annotations for, prefixed with the page type and joined by a colon (for example, dashboard:abc-def-xyz or notebook:1234567890).

  • start_time (Integer) —

    Start of the time window in milliseconds since the Unix epoch.

  • end_time (Integer) —

    End of the time window in milliseconds since the Unix epoch.

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

    the optional parameters

Options Hash (opts):

  • :widget_id (String) —

    Optional widget ID to restrict results to annotations on a specific widget.

Returns:

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

    AnnotationsResponse data, response status code and response headers



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

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AnnotationsAPI.list_annotations ...'
  end
  # verify the required parameter 'page_id' is set
  if @api_client.config.client_side_validation && page_id.nil?
    fail ArgumentError, "Missing the required parameter 'page_id' when calling AnnotationsAPI.list_annotations"
  end
  # verify the required parameter 'start_time' is set
  if @api_client.config.client_side_validation && start_time.nil?
    fail ArgumentError, "Missing the required parameter 'start_time' when calling AnnotationsAPI.list_annotations"
  end
  # verify the required parameter 'end_time' is set
  if @api_client.config.client_side_validation && end_time.nil?
    fail ArgumentError, "Missing the required parameter 'end_time' when calling AnnotationsAPI.list_annotations"
  end
  # resource path
  local_var_path = '/api/v2/annotation'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page_id'] = page_id
  query_params[:'start_time'] = start_time
  query_params[:'end_time'] = end_time
  query_params[:'widget_id'] = opts[:'widget_id'] if !opts[:'widget_id'].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] || 'AnnotationsResponse'

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

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

#update_annotation(annotation_id, body, opts = {}) ⇒ Object

Update an annotation.

See Also:



347
348
349
350
 
# File 'lib/datadog_api_client/v2/api/annotations_api.rb', line 347

def update_annotation(annotation_id, body, opts = {})
  data, _status_code, _headers = update_annotation_with_http_info(annotation_id, body, opts)
  data
end

#update_annotation_with_http_info(annotation_id, body, opts = {}) ⇒ Array<(AnnotationResponse, Integer, Hash)>

Update an annotation.

Updates an existing annotation. Valid color values: gray, blue, purple, green, yellow, red. Valid type values: pointInTime (marks a single moment) or timeRegion (spans a range and requires end_time).

Parameters:

  • annotation_id (UUID) —

    The ID of the annotation.

  • body (AnnotationUpdateRequest) —

    Updated annotation payload.

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

    the optional parameters

Returns:

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

    AnnotationResponse data, response status code and response headers



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
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
 
# File 'lib/datadog_api_client/v2/api/annotations_api.rb', line 362

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AnnotationsAPI.update_annotation ...'
  end
  # verify the required parameter 'annotation_id' is set
  if @api_client.config.client_side_validation && annotation_id.nil?
    fail ArgumentError, "Missing the required parameter 'annotation_id' when calling AnnotationsAPI.update_annotation"
  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 AnnotationsAPI.update_annotation"
  end
  # resource path
  local_var_path = '/api/v2/annotation/{annotation_id}'.sub('{annotation_id}', CGI.escape(annotation_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] || 'AnnotationResponse'

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

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