Class: DatadogAPIClient::V2::APMRetentionFiltersAPI
- Inherits:
-
Object
- Object
- DatadogAPIClient::V2::APMRetentionFiltersAPI
- Defined in:
- lib/datadog_api_client/v2/api/apm_retention_filters_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#create_apm_retention_filter(body, opts = {}) ⇒ Object
Create a retention filter.
-
#create_apm_retention_filter_with_http_info(body, opts = {}) ⇒ Array<(RetentionFilterCreateResponse, Integer, Hash)>
Create a retention filter.
-
#delete_apm_retention_filter(filter_id, opts = {}) ⇒ Object
Delete a retention filter.
-
#delete_apm_retention_filter_with_http_info(filter_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete a retention filter.
-
#get_apm_retention_filter(filter_id, opts = {}) ⇒ Object
Get a given APM retention filter.
-
#get_apm_retention_filter_with_http_info(filter_id, opts = {}) ⇒ Array<(RetentionFilterResponse, Integer, Hash)>
Get a given APM retention filter.
-
#initialize(api_client = DatadogAPIClient::APIClient.default) ⇒ APMRetentionFiltersAPI
constructor
A new instance of APMRetentionFiltersAPI.
-
#list_apm_retention_filters(opts = {}) ⇒ Object
List all APM retention filters.
-
#list_apm_retention_filters_with_http_info(opts = {}) ⇒ Array<(RetentionFiltersResponse, Integer, Hash)>
List all APM retention filters.
-
#reorder_apm_retention_filters(body, opts = {}) ⇒ Object
Re-order retention filters.
-
#reorder_apm_retention_filters_with_http_info(body, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Re-order retention filters.
-
#update_apm_retention_filter(filter_id, body, opts = {}) ⇒ Object
Update a retention filter.
-
#update_apm_retention_filter_with_http_info(filter_id, body, opts = {}) ⇒ Array<(RetentionFilterResponse, Integer, Hash)>
Update a retention filter.
Constructor Details
#initialize(api_client = DatadogAPIClient::APIClient.default) ⇒ APMRetentionFiltersAPI
Returns a new instance of APMRetentionFiltersAPI.
22 23 24 |
# File 'lib/datadog_api_client/v2/api/apm_retention_filters_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/apm_retention_filters_api.rb', line 20 def api_client @api_client end |
Instance Method Details
#create_apm_retention_filter(body, opts = {}) ⇒ Object
Create a retention filter.
29 30 31 32 |
# File 'lib/datadog_api_client/v2/api/apm_retention_filters_api.rb', line 29 def create_apm_retention_filter(body, opts = {}) data, _status_code, _headers = create_apm_retention_filter_with_http_info(body, opts) data end |
#create_apm_retention_filter_with_http_info(body, opts = {}) ⇒ Array<(RetentionFilterCreateResponse, Integer, Hash)>
Create a retention filter.
Create a retention filter to index spans in your organization. Returns the retention filter definition when the request is successful.
Default filters with types spans-errors-sampling-processor and spans-appsec-sampling-processor cannot be created.
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 |
# File 'lib/datadog_api_client/v2/api/apm_retention_filters_api.rb', line 44 def create_apm_retention_filter_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: APMRetentionFiltersAPI.create_apm_retention_filter ...' 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 APMRetentionFiltersAPI.create_apm_retention_filter" end # resource path local_var_path = '/api/v2/apm/config/retention-filters' # 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] || 'RetentionFilterCreateResponse' # auth_names auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth] = opts.merge( :operation => :create_apm_retention_filter, :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: APMRetentionFiltersAPI#create_apm_retention_filter\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_apm_retention_filter(filter_id, opts = {}) ⇒ Object
Delete a retention filter.
99 100 101 102 |
# File 'lib/datadog_api_client/v2/api/apm_retention_filters_api.rb', line 99 def delete_apm_retention_filter(filter_id, opts = {}) delete_apm_retention_filter_with_http_info(filter_id, opts) nil end |
#delete_apm_retention_filter_with_http_info(filter_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete a retention filter.
Delete a specific retention filter from your organization.
Default filters with types spans-errors-sampling-processor and spans-appsec-sampling-processor cannot be deleted.
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 157 158 159 160 161 |
# File 'lib/datadog_api_client/v2/api/apm_retention_filters_api.rb', line 113 def delete_apm_retention_filter_with_http_info(filter_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: APMRetentionFiltersAPI.delete_apm_retention_filter ...' end # verify the required parameter 'filter_id' is set if @api_client.config.client_side_validation && filter_id.nil? fail ArgumentError, "Missing the required parameter 'filter_id' when calling APMRetentionFiltersAPI.delete_apm_retention_filter" end # resource path local_var_path = '/api/v2/apm/config/retention-filters/{filter_id}'.sub('{filter_id}', CGI.escape(filter_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] = opts.merge( :operation => :delete_apm_retention_filter, :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: APMRetentionFiltersAPI#delete_apm_retention_filter\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_apm_retention_filter(filter_id, opts = {}) ⇒ Object
Get a given APM retention filter.
166 167 168 169 |
# File 'lib/datadog_api_client/v2/api/apm_retention_filters_api.rb', line 166 def get_apm_retention_filter(filter_id, opts = {}) data, _status_code, _headers = get_apm_retention_filter_with_http_info(filter_id, opts) data end |
#get_apm_retention_filter_with_http_info(filter_id, opts = {}) ⇒ Array<(RetentionFilterResponse, Integer, Hash)>
Get a given APM retention filter.
Get an APM retention filter.
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 222 223 224 225 226 |
# File 'lib/datadog_api_client/v2/api/apm_retention_filters_api.rb', line 178 def get_apm_retention_filter_with_http_info(filter_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: APMRetentionFiltersAPI.get_apm_retention_filter ...' end # verify the required parameter 'filter_id' is set if @api_client.config.client_side_validation && filter_id.nil? fail ArgumentError, "Missing the required parameter 'filter_id' when calling APMRetentionFiltersAPI.get_apm_retention_filter" end # resource path local_var_path = '/api/v2/apm/config/retention-filters/{filter_id}'.sub('{filter_id}', CGI.escape(filter_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] || 'RetentionFilterResponse' # auth_names auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth] = opts.merge( :operation => :get_apm_retention_filter, :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: APMRetentionFiltersAPI#get_apm_retention_filter\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list_apm_retention_filters(opts = {}) ⇒ Object
List all APM retention filters.
231 232 233 234 |
# File 'lib/datadog_api_client/v2/api/apm_retention_filters_api.rb', line 231 def list_apm_retention_filters(opts = {}) data, _status_code, _headers = list_apm_retention_filters_with_http_info(opts) data end |
#list_apm_retention_filters_with_http_info(opts = {}) ⇒ Array<(RetentionFiltersResponse, Integer, Hash)>
List all APM retention filters.
Get the list of APM retention filters.
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 282 283 284 285 286 |
# File 'lib/datadog_api_client/v2/api/apm_retention_filters_api.rb', line 242 def list_apm_retention_filters_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: APMRetentionFiltersAPI.list_apm_retention_filters ...' end # resource path local_var_path = '/api/v2/apm/config/retention-filters' # 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] || 'RetentionFiltersResponse' # auth_names auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth] = opts.merge( :operation => :list_apm_retention_filters, :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: APMRetentionFiltersAPI#list_apm_retention_filters\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#reorder_apm_retention_filters(body, opts = {}) ⇒ Object
Re-order retention filters.
291 292 293 294 |
# File 'lib/datadog_api_client/v2/api/apm_retention_filters_api.rb', line 291 def reorder_apm_retention_filters(body, opts = {}) reorder_apm_retention_filters_with_http_info(body, opts) nil end |
#reorder_apm_retention_filters_with_http_info(body, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Re-order retention filters.
Re-order the execution order of retention filters.
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/apm_retention_filters_api.rb', line 303 def reorder_apm_retention_filters_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: APMRetentionFiltersAPI.reorder_apm_retention_filters ...' 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 APMRetentionFiltersAPI.reorder_apm_retention_filters" end # resource path local_var_path = '/api/v2/apm/config/retention-filters-execution-order' # 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(['*/*']) # 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] # auth_names auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth] = opts.merge( :operation => :reorder_apm_retention_filters, :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: APMRetentionFiltersAPI#reorder_apm_retention_filters\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update_apm_retention_filter(filter_id, body, opts = {}) ⇒ Object
Update a retention filter.
358 359 360 361 |
# File 'lib/datadog_api_client/v2/api/apm_retention_filters_api.rb', line 358 def update_apm_retention_filter(filter_id, body, opts = {}) data, _status_code, _headers = update_apm_retention_filter_with_http_info(filter_id, body, opts) data end |
#update_apm_retention_filter_with_http_info(filter_id, body, opts = {}) ⇒ Array<(RetentionFilterResponse, Integer, Hash)>
Update a retention filter.
Update a retention filter from your organization.
Default filters (filters with types spans-errors-sampling-processor and spans-appsec-sampling-processor) cannot be renamed or removed.
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 423 424 425 426 427 |
# File 'lib/datadog_api_client/v2/api/apm_retention_filters_api.rb', line 373 def update_apm_retention_filter_with_http_info(filter_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: APMRetentionFiltersAPI.update_apm_retention_filter ...' end # verify the required parameter 'filter_id' is set if @api_client.config.client_side_validation && filter_id.nil? fail ArgumentError, "Missing the required parameter 'filter_id' when calling APMRetentionFiltersAPI.update_apm_retention_filter" 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 APMRetentionFiltersAPI.update_apm_retention_filter" end # resource path local_var_path = '/api/v2/apm/config/retention-filters/{filter_id}'.sub('{filter_id}', CGI.escape(filter_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] || 'RetentionFilterResponse' # auth_names auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth] = opts.merge( :operation => :update_apm_retention_filter, :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: APMRetentionFiltersAPI#update_apm_retention_filter\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |