Class: DatadogAPIClient::V1::TagsAPI

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of TagsAPI.



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

def api_client
  @api_client
end

Instance Method Details

#create_host_tags(host_name, body, opts = {}) ⇒ Object

Add tags to a host.

See Also:



32
33
34
35
 
# File 'lib/datadog_api_client/v1/api/tags_api.rb', line 32

def create_host_tags(host_name, body, opts = {})
  data, _status_code, _headers = create_host_tags_with_http_info(host_name, body, opts)
  data
end

#create_host_tags_with_http_info(host_name, body, opts = {}) ⇒ Array<(HostTags, Integer, Hash)>

Add tags to a host.

This endpoint allows you to add new tags to a host, optionally specifying where these tags come from.

Parameters:

  • host_name (String) —

    This endpoint allows you to add new tags to a host, optionally specifying where the tags came from.

  • body (HostTags) —

    Update host tags request body.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    HostTags data, response status code and response headers



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
105
106
107
 
# File 'lib/datadog_api_client/v1/api/tags_api.rb', line 44

def create_host_tags_with_http_info(host_name, body, opts = {})

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

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

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'source'] = opts[:'source'] if !opts[:'source'].nil?

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

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

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

#delete_host_tags(host_name, opts = {}) ⇒ Object

Remove host tags.

See Also:



115
116
117
118
 
# File 'lib/datadog_api_client/v1/api/tags_api.rb', line 115

def delete_host_tags(host_name, opts = {})
  delete_host_tags_with_http_info(host_name, opts)
  nil
end

#delete_host_tags_with_http_info(host_name, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Remove host tags.

This endpoint allows you to remove all user-assigned tags for a single host.

Parameters:

  • host_name (String) —

    This endpoint allows you to remove all user-assigned tags for a single host.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



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

def delete_host_tags_with_http_info(host_name, opts = {})

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

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

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'source'] = opts[:'source'] if !opts[:'source'].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]

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

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

#get_host_tags(host_name, opts = {}) ⇒ Object

Get host tags.

See Also:



191
192
193
194
 
# File 'lib/datadog_api_client/v1/api/tags_api.rb', line 191

def get_host_tags(host_name, opts = {})
  data, _status_code, _headers = get_host_tags_with_http_info(host_name, opts)
  data
end

#get_host_tags_with_http_info(host_name, opts = {}) ⇒ Array<(HostTags, Integer, Hash)>

Get host tags.

Return the list of tags that apply to a given host.

Parameters:

  • host_name (String) —

    When specified, filters list of tags to those tags with the specified source.

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

    the optional parameters

Options Hash (opts):

  • :source (String) —

    Source to filter.

Returns:

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

    HostTags 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
259
 
# File 'lib/datadog_api_client/v1/api/tags_api.rb', line 202

def get_host_tags_with_http_info(host_name, opts = {})

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

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

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'source'] = opts[:'source'] if !opts[:'source'].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] || 'HostTags'

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

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

#list_host_tags(opts = {}) ⇒ Object

Get Tags.

See Also:



266
267
268
269
 
# File 'lib/datadog_api_client/v1/api/tags_api.rb', line 266

def list_host_tags(opts = {})
  data, _status_code, _headers = list_host_tags_with_http_info(opts)
  data
end

#list_host_tags_with_http_info(opts = {}) ⇒ Array<(TagToHosts, Integer, Hash)>

Get Tags.

Return a mapping of tags to hosts for your whole infrastructure.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :source (String) —

    When specified, filters host list to those tags with the specified source.

Returns:

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

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

def list_host_tags_with_http_info(opts = {})

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TagsAPI.list_host_tags ...'
  end
  # resource path
  local_var_path = '/api/v1/tags/hosts'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'source'] = opts[:'source'] if !opts[:'source'].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] || 'TagToHosts'

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

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

#update_host_tags(host_name, body, opts = {}) ⇒ Object

Update host tags.

See Also:



338
339
340
341
 
# File 'lib/datadog_api_client/v1/api/tags_api.rb', line 338

def update_host_tags(host_name, body, opts = {})
  data, _status_code, _headers = update_host_tags_with_http_info(host_name, body, opts)
  data
end

#update_host_tags_with_http_info(host_name, body, opts = {}) ⇒ Array<(HostTags, Integer, Hash)>

Update host tags.

This endpoint allows you to update/replace all tags in an integration source with those supplied in the request.

Parameters:

  • host_name (String) —

    This endpoint allows you to update/replace all in an integration source with those supplied in the request.

  • body (HostTags) —

    Add tags to host

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

    the optional parameters

Options Hash (opts):

Returns:

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

    HostTags data, response status code and response headers



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
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
 
# File 'lib/datadog_api_client/v1/api/tags_api.rb', line 350

def update_host_tags_with_http_info(host_name, body, opts = {})

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

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

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'source'] = opts[:'source'] if !opts[:'source'].nil?

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

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

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