Class: DatadogAPIClient::V1::NotebooksAPI

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = APIClient.default) ⇒ NotebooksAPI 



22
23
24
 
# File 'lib/datadog_api_client/v1/api/notebooks_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/notebooks_api.rb', line 20

def api_client
  @api_client
end

Instance Method Details

#create_notebook(body, opts = {}) ⇒ NotebookResponse

Create a notebook Create a notebook using the specified options.



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

def create_notebook(body, opts = {})
  data, _status_code, _headers = create_notebook_with_http_info(body, opts)
  data
end

#create_notebook_with_http_info(body, opts = {}) ⇒ Array<(NotebookResponse, Integer, Hash)>

Create a notebook Create a notebook using the specified options.



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/notebooks_api.rb', line 40

def create_notebook_with_http_info(body, opts = {})

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NotebooksAPI.create_notebook ...'
  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 NotebooksAPI.create_notebook"
  end
  # resource path
  local_var_path = '/api/v1/notebooks'

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

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

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

#delete_notebook(notebook_id, opts = {}) ⇒ nil

Delete a notebook Delete a notebook using the specified ID.



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

def delete_notebook(notebook_id, opts = {})
  delete_notebook_with_http_info(notebook_id, opts)
  nil
end

#delete_notebook_with_http_info(notebook_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete a notebook Delete a notebook using the specified ID.



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/notebooks_api.rb', line 115

def delete_notebook_with_http_info(notebook_id, opts = {})

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NotebooksAPI.delete_notebook ...'
  end
  # verify the required parameter 'notebook_id' is set
  if @api_client.config.client_side_validation && notebook_id.nil?
    fail ArgumentError, "Missing the required parameter 'notebook_id' when calling NotebooksAPI.delete_notebook"
  end
  # resource path
  local_var_path = '/api/v1/notebooks/{notebook_id}'.sub('{' + 'notebook_id' + '}', CGI.escape(notebook_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]

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

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

#get_notebook(notebook_id, opts = {}) ⇒ NotebookResponse

Get a notebook Get a notebook using the specified notebook ID.



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

def get_notebook(notebook_id, opts = {})
  data, _status_code, _headers = get_notebook_with_http_info(notebook_id, opts)
  data
end

#get_notebook_with_http_info(notebook_id, opts = {}) ⇒ Array<(NotebookResponse, Integer, Hash)>

Get a notebook Get a notebook using the specified notebook ID.



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/notebooks_api.rb', line 188

def get_notebook_with_http_info(notebook_id, opts = {})

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NotebooksAPI.get_notebook ...'
  end
  # verify the required parameter 'notebook_id' is set
  if @api_client.config.client_side_validation && notebook_id.nil?
    fail ArgumentError, "Missing the required parameter 'notebook_id' when calling NotebooksAPI.get_notebook"
  end
  # resource path
  local_var_path = '/api/v1/notebooks/{notebook_id}'.sub('{' + 'notebook_id' + '}', CGI.escape(notebook_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] || 'NotebookResponse'

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

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

#list_notebooks(opts = {}) ⇒ NotebooksResponse

Get all notebooks Get all notebooks. This can also be used to search for notebooks with a particular ‘query` in the notebook `name` or author `handle`.

Options Hash (opts):

  • :author_handle (String) —

    Return notebooks created by the given &#x60;author_handle&#x60;.

  • :exclude_author_handle (String) —

    Return notebooks not created by the given &#x60;author_handle&#x60;.

  • :start (Integer) —

    The index of the first notebook you want returned.

  • :count (Integer) —

    The number of notebooks to be returned.

  • :sort_field (String) —

    Sort by field &#x60;modified&#x60;, &#x60;name&#x60;, or &#x60;created&#x60;. (default to ‘modified’)

  • :sort_dir (String) —

    Sort by direction &#x60;asc&#x60; or &#x60;desc&#x60;. (default to ‘desc’)

  • :query (String) —

    Return only notebooks with &#x60;query&#x60; string in notebook name or author handle.

  • :include_cells (Boolean) —

    Value of &#x60;false&#x60; excludes the &#x60;cells&#x60; and global &#x60;time&#x60; for each notebook. (default to true)

  • :is_template (Boolean) —

    True value returns only template notebooks. Default is false (returns only non-template notebooks). (default to false)

  • :type (String) —

    If type is provided, returns only notebooks with that metadata type. Default does not have type filtering.



260
261
262
263
 
# File 'lib/datadog_api_client/v1/api/notebooks_api.rb', line 260

def list_notebooks(opts = {})
  data, _status_code, _headers = list_notebooks_with_http_info(opts)
  data
end

#list_notebooks_with_http_info(opts = {}) ⇒ Array<(NotebooksResponse, Integer, Hash)>

Get all notebooks Get all notebooks. This can also be used to search for notebooks with a particular &#x60;query&#x60; in the notebook &#x60;name&#x60; or author &#x60;handle&#x60;.

Options Hash (opts):

  • :author_handle (String) —

    Return notebooks created by the given &#x60;author_handle&#x60;.

  • :exclude_author_handle (String) —

    Return notebooks not created by the given &#x60;author_handle&#x60;.

  • :start (Integer) —

    The index of the first notebook you want returned.

  • :count (Integer) —

    The number of notebooks to be returned.

  • :sort_field (String) —

    Sort by field &#x60;modified&#x60;, &#x60;name&#x60;, or &#x60;created&#x60;.

  • :sort_dir (String) —

    Sort by direction &#x60;asc&#x60; or &#x60;desc&#x60;.

  • :query (String) —

    Return only notebooks with &#x60;query&#x60; string in notebook name or author handle.

  • :include_cells (Boolean) —

    Value of &#x60;false&#x60; excludes the &#x60;cells&#x60; and global &#x60;time&#x60; for each notebook.

  • :is_template (Boolean) —

    True value returns only template notebooks. Default is false (returns only non-template notebooks).

  • :type (String) —

    If type is provided, returns only notebooks with that metadata type. Default does not have type filtering.



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

def list_notebooks_with_http_info(opts = {})

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NotebooksAPI.list_notebooks ...'
  end
  # resource path
  local_var_path = '/api/v1/notebooks'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'author_handle'] = opts[:'author_handle'] if !opts[:'author_handle'].nil?
  query_params[:'exclude_author_handle'] = opts[:'exclude_author_handle'] if !opts[:'exclude_author_handle'].nil?
  query_params[:'start'] = opts[:'start'] if !opts[:'start'].nil?
  query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
  query_params[:'sort_field'] = opts[:'sort_field'] if !opts[:'sort_field'].nil?
  query_params[:'sort_dir'] = opts[:'sort_dir'] if !opts[:'sort_dir'].nil?
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?
  query_params[:'include_cells'] = opts[:'include_cells'] if !opts[:'include_cells'].nil?
  query_params[:'is_template'] = opts[:'is_template'] if !opts[:'is_template'].nil?
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].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] || 'NotebooksResponse'

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

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

#update_notebook(notebook_id, body, opts = {}) ⇒ NotebookResponse

Update a notebook Update a notebook using the specified ID.



349
350
351
352
 
# File 'lib/datadog_api_client/v1/api/notebooks_api.rb', line 349

def update_notebook(notebook_id, body, opts = {})
  data, _status_code, _headers = update_notebook_with_http_info(notebook_id, body, opts)
  data
end

#update_notebook_with_http_info(notebook_id, body, opts = {}) ⇒ Array<(NotebookResponse, Integer, Hash)>

Update a notebook Update a notebook using the specified ID.



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
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/v1/api/notebooks_api.rb', line 360

def update_notebook_with_http_info(notebook_id, body, opts = {})

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NotebooksAPI.update_notebook ...'
  end
  # verify the required parameter 'notebook_id' is set
  if @api_client.config.client_side_validation && notebook_id.nil?
    fail ArgumentError, "Missing the required parameter 'notebook_id' when calling NotebooksAPI.update_notebook"
  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 NotebooksAPI.update_notebook"
  end
  # resource path
  local_var_path = '/api/v1/notebooks/{notebook_id}'.sub('{' + 'notebook_id' + '}', CGI.escape(notebook_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] || 'NotebookResponse'

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

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