Class: DatadogAPIClient::V2::LogsCustomDestinationsAPI

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of LogsCustomDestinationsAPI.



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

def api_client
  @api_client
end

Instance Method Details

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

Create a custom destination.

See Also:



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

def create_logs_custom_destination(body, opts = {})
  data, _status_code, _headers = create_logs_custom_destination_with_http_info(body, opts)
  data
end

#create_logs_custom_destination_with_http_info(body, opts = {}) ⇒ Array<(CustomDestinationResponse, Integer, Hash)>

Create a custom destination.

Create a custom destination in your organization.

Parameters:

Returns:

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

    CustomDestinationResponse data, response status code and response headers



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

def create_logs_custom_destination_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LogsCustomDestinationsAPI.create_logs_custom_destination ...'
  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 LogsCustomDestinationsAPI.create_logs_custom_destination"
  end
  # resource path
  local_var_path = '/api/v2/logs/config/custom-destinations'

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

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

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

#delete_logs_custom_destination(custom_destination_id, opts = {}) ⇒ Object

Delete a custom destination.

See Also:



96
97
98
99
 
# File 'lib/datadog_api_client/v2/api/logs_custom_destinations_api.rb', line 96

def delete_logs_custom_destination(custom_destination_id, opts = {})
  delete_logs_custom_destination_with_http_info(custom_destination_id, opts)
  nil
end

#delete_logs_custom_destination_with_http_info(custom_destination_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete a custom destination.

Delete a specific custom destination in your organization.

Parameters:

  • custom_destination_id (String) —

    The ID of the custom destination.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



108
109
110
111
112
113
114
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
 
# File 'lib/datadog_api_client/v2/api/logs_custom_destinations_api.rb', line 108

def delete_logs_custom_destination_with_http_info(custom_destination_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LogsCustomDestinationsAPI.delete_logs_custom_destination ...'
  end
  # verify the required parameter 'custom_destination_id' is set
  if @api_client.config.client_side_validation && custom_destination_id.nil?
    fail ArgumentError, "Missing the required parameter 'custom_destination_id' when calling LogsCustomDestinationsAPI.delete_logs_custom_destination"
  end
  # resource path
  local_var_path = '/api/v2/logs/config/custom-destinations/{custom_destination_id}'.sub('{custom_destination_id}', CGI.escape(custom_destination_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_logs_custom_destination,
    :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: LogsCustomDestinationsAPI#delete_logs_custom_destination\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_logs_custom_destination(custom_destination_id, opts = {}) ⇒ Object

Get a custom destination.

See Also:



161
162
163
164
 
# File 'lib/datadog_api_client/v2/api/logs_custom_destinations_api.rb', line 161

def get_logs_custom_destination(custom_destination_id, opts = {})
  data, _status_code, _headers = get_logs_custom_destination_with_http_info(custom_destination_id, opts)
  data
end

#get_logs_custom_destination_with_http_info(custom_destination_id, opts = {}) ⇒ Array<(CustomDestinationResponse, Integer, Hash)>

Get a custom destination.

Get a specific custom destination in your organization.

Parameters:

  • custom_destination_id (String) —

    The ID of the custom destination.

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

    the optional parameters

Returns:

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

    CustomDestinationResponse data, response status code and response headers



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

def get_logs_custom_destination_with_http_info(custom_destination_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LogsCustomDestinationsAPI.get_logs_custom_destination ...'
  end
  # verify the required parameter 'custom_destination_id' is set
  if @api_client.config.client_side_validation && custom_destination_id.nil?
    fail ArgumentError, "Missing the required parameter 'custom_destination_id' when calling LogsCustomDestinationsAPI.get_logs_custom_destination"
  end
  # resource path
  local_var_path = '/api/v2/logs/config/custom-destinations/{custom_destination_id}'.sub('{custom_destination_id}', CGI.escape(custom_destination_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'])

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'CustomDestinationResponse'

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

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

#list_logs_custom_destinations(opts = {}) ⇒ Object

Get all custom destinations.

See Also:



226
227
228
229
 
# File 'lib/datadog_api_client/v2/api/logs_custom_destinations_api.rb', line 226

def list_logs_custom_destinations(opts = {})
  data, _status_code, _headers = list_logs_custom_destinations_with_http_info(opts)
  data
end

#list_logs_custom_destinations_with_http_info(opts = {}) ⇒ Array<(CustomDestinationsResponse, Integer, Hash)>

Get all custom destinations.

Get the list of configured custom destinations in your organization with their definitions.

Parameters:

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

    the optional parameters

Returns:

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

    CustomDestinationsResponse data, response status code and response headers



237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/datadog_api_client/v2/api/logs_custom_destinations_api.rb', line 237

def list_logs_custom_destinations_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LogsCustomDestinationsAPI.list_logs_custom_destinations ...'
  end
  # resource path
  local_var_path = '/api/v2/logs/config/custom-destinations'

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

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

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

#update_logs_custom_destination(custom_destination_id, body, opts = {}) ⇒ Object

Update a custom destination.

See Also:



286
287
288
289
 
# File 'lib/datadog_api_client/v2/api/logs_custom_destinations_api.rb', line 286

def update_logs_custom_destination(custom_destination_id, body, opts = {})
  data, _status_code, _headers = update_logs_custom_destination_with_http_info(custom_destination_id, body, opts)
  data
end

#update_logs_custom_destination_with_http_info(custom_destination_id, body, opts = {}) ⇒ Array<(CustomDestinationResponse, Integer, Hash)>

Update a custom destination.

Update the given fields of a specific custom destination in your organization.

Parameters:

  • custom_destination_id (String) —

    The ID of the custom destination.

  • body (CustomDestinationUpdateRequest) —

    New definition of the custom destination’s fields.

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

    the optional parameters

Returns:

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

    CustomDestinationResponse data, response status code and response headers



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
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/datadog_api_client/v2/api/logs_custom_destinations_api.rb', line 299

def update_logs_custom_destination_with_http_info(custom_destination_id, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LogsCustomDestinationsAPI.update_logs_custom_destination ...'
  end
  # verify the required parameter 'custom_destination_id' is set
  if @api_client.config.client_side_validation && custom_destination_id.nil?
    fail ArgumentError, "Missing the required parameter 'custom_destination_id' when calling LogsCustomDestinationsAPI.update_logs_custom_destination"
  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 LogsCustomDestinationsAPI.update_logs_custom_destination"
  end
  # resource path
  local_var_path = '/api/v2/logs/config/custom-destinations/{custom_destination_id}'.sub('{custom_destination_id}', CGI.escape(custom_destination_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] || 'CustomDestinationResponse'

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

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