Class: DatadogAPIClient::V2::TagPoliciesAPI
- Inherits:
-
Object
- Object
- DatadogAPIClient::V2::TagPoliciesAPI
- Defined in:
- lib/datadog_api_client/v2/api/tag_policies_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#create_tag_policy(body, opts = {}) ⇒ Object
Create a tag policy.
-
#create_tag_policy_with_http_info(body, opts = {}) ⇒ Array<(TagPolicyResponse, Integer, Hash)>
Create a tag policy.
-
#delete_tag_policy(policy_id, opts = {}) ⇒ Object
Delete a tag policy.
-
#delete_tag_policy_with_http_info(policy_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete a tag policy.
-
#get_tag_policy(policy_id, opts = {}) ⇒ Object
Get a tag policy.
-
#get_tag_policy_score(policy_id, opts = {}) ⇒ Object
Get a tag policy compliance score.
-
#get_tag_policy_score_with_http_info(policy_id, opts = {}) ⇒ Array<(TagPolicyScoreResponse, Integer, Hash)>
Get a tag policy compliance score.
-
#get_tag_policy_with_http_info(policy_id, opts = {}) ⇒ Array<(TagPolicyResponse, Integer, Hash)>
Get a tag policy.
-
#initialize(api_client = DatadogAPIClient::APIClient.default) ⇒ TagPoliciesAPI
constructor
A new instance of TagPoliciesAPI.
-
#list_tag_policies(opts = {}) ⇒ Object
List tag policies.
-
#list_tag_policies_with_http_info(opts = {}) ⇒ Array<(TagPoliciesListResponse, Integer, Hash)>
List tag policies.
-
#update_tag_policy(policy_id, body, opts = {}) ⇒ Object
Update a tag policy.
-
#update_tag_policy_with_http_info(policy_id, body, opts = {}) ⇒ Array<(TagPolicyResponse, Integer, Hash)>
Update a tag policy.
Constructor Details
#initialize(api_client = DatadogAPIClient::APIClient.default) ⇒ TagPoliciesAPI
Returns a new instance of TagPoliciesAPI.
22 23 24 |
# File 'lib/datadog_api_client/v2/api/tag_policies_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/tag_policies_api.rb', line 20 def api_client @api_client end |
Instance Method Details
#create_tag_policy(body, opts = {}) ⇒ Object
Create a tag policy.
29 30 31 32 |
# File 'lib/datadog_api_client/v2/api/tag_policies_api.rb', line 29 def create_tag_policy(body, opts = {}) data, _status_code, _headers = create_tag_policy_with_http_info(body, opts) data end |
#create_tag_policy_with_http_info(body, opts = {}) ⇒ Array<(TagPolicyResponse, Integer, Hash)>
Create a tag policy.
Create a new tag policy for the organization. The caller's organization is derived from
the authenticated user; cross-organization creation is not supported. Fields such as
policy_id, version, and the timestamp/audit fields are assigned by the server.
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/tag_policies_api.rb', line 43 def create_tag_policy_with_http_info(body, opts = {}) unstable_enabled = @api_client.config.unstable_operations["v2.create_tag_policy".to_sym] if unstable_enabled @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.create_tag_policy") else raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.create_tag_policy")) end if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TagPoliciesAPI.create_tag_policy ...' 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 TagPoliciesAPI.create_tag_policy" end # resource path local_var_path = '/api/v2/tag_policies' # 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] || 'TagPolicyResponse' # auth_names auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth] = opts.merge( :operation => :create_tag_policy, :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: TagPoliciesAPI#create_tag_policy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_tag_policy(policy_id, opts = {}) ⇒ Object
Delete a tag policy.
104 105 106 107 |
# File 'lib/datadog_api_client/v2/api/tag_policies_api.rb', line 104 def delete_tag_policy(policy_id, opts = {}) delete_tag_policy_with_http_info(policy_id, opts) nil end |
#delete_tag_policy_with_http_info(policy_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete a tag policy.
Delete a tag policy. By default the policy is soft-deleted so it can be recovered later
and so that historical score data remains queryable. Pass hard_delete=true to remove
the policy permanently.
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 172 173 174 |
# File 'lib/datadog_api_client/v2/api/tag_policies_api.rb', line 119 def delete_tag_policy_with_http_info(policy_id, opts = {}) unstable_enabled = @api_client.config.unstable_operations["v2.delete_tag_policy".to_sym] if unstable_enabled @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.delete_tag_policy") else raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.delete_tag_policy")) end if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TagPoliciesAPI.delete_tag_policy ...' end # verify the required parameter 'policy_id' is set if @api_client.config.client_side_validation && policy_id.nil? fail ArgumentError, "Missing the required parameter 'policy_id' when calling TagPoliciesAPI.delete_tag_policy" end # resource path local_var_path = '/api/v2/tag_policies/{policy_id}'.sub('{policy_id}', CGI.escape(policy_id.to_s).gsub('%2F', '/')) # query parameters query_params = opts[:query_params] || {} query_params[:'hard_delete'] = opts[:'hard_delete'] if !opts[:'hard_delete'].nil? # 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_tag_policy, :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: TagPoliciesAPI#delete_tag_policy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_tag_policy(policy_id, opts = {}) ⇒ Object
Get a tag policy.
179 180 181 182 |
# File 'lib/datadog_api_client/v2/api/tag_policies_api.rb', line 179 def get_tag_policy(policy_id, opts = {}) data, _status_code, _headers = get_tag_policy_with_http_info(policy_id, opts) data end |
#get_tag_policy_score(policy_id, opts = {}) ⇒ Object
Get a tag policy compliance score.
262 263 264 265 |
# File 'lib/datadog_api_client/v2/api/tag_policies_api.rb', line 262 def get_tag_policy_score(policy_id, opts = {}) data, _status_code, _headers = get_tag_policy_score_with_http_info(policy_id, opts) data end |
#get_tag_policy_score_with_http_info(policy_id, opts = {}) ⇒ Array<(TagPolicyScoreResponse, Integer, Hash)>
Get a tag policy compliance score.
Retrieve the compliance score for a single tag policy. The score is computed over the
requested time window (or a source-appropriate default) and represents the percentage of
telemetry within that window that conforms to the policy. A null score indicates that
no relevant telemetry was found.
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 |
# File 'lib/datadog_api_client/v2/api/tag_policies_api.rb', line 279 def get_tag_policy_score_with_http_info(policy_id, opts = {}) unstable_enabled = @api_client.config.unstable_operations["v2.get_tag_policy_score".to_sym] if unstable_enabled @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.get_tag_policy_score") else raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.get_tag_policy_score")) end if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TagPoliciesAPI.get_tag_policy_score ...' end # verify the required parameter 'policy_id' is set if @api_client.config.client_side_validation && policy_id.nil? fail ArgumentError, "Missing the required parameter 'policy_id' when calling TagPoliciesAPI.get_tag_policy_score" end # resource path local_var_path = '/api/v2/tag_policies/{policy_id}/score'.sub('{policy_id}', CGI.escape(policy_id.to_s).gsub('%2F', '/')) # query parameters query_params = opts[:query_params] || {} query_params[:'ts_start'] = opts[:'ts_start'] if !opts[:'ts_start'].nil? query_params[:'ts_end'] = opts[:'ts_end'] if !opts[:'ts_end'].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] || 'TagPolicyScoreResponse' # auth_names auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth] = opts.merge( :operation => :get_tag_policy_score, :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: TagPoliciesAPI#get_tag_policy_score\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_tag_policy_with_http_info(policy_id, opts = {}) ⇒ Array<(TagPolicyResponse, Integer, Hash)>
Get a tag policy.
Retrieve a single tag policy by ID. Optionally include the policy's current compliance
score via the include=score query parameter. Policies belonging to other organizations
cannot be retrieved.
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 257 |
# File 'lib/datadog_api_client/v2/api/tag_policies_api.rb', line 196 def get_tag_policy_with_http_info(policy_id, opts = {}) unstable_enabled = @api_client.config.unstable_operations["v2.get_tag_policy".to_sym] if unstable_enabled @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.get_tag_policy") else raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.get_tag_policy")) end if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TagPoliciesAPI.get_tag_policy ...' end # verify the required parameter 'policy_id' is set if @api_client.config.client_side_validation && policy_id.nil? fail ArgumentError, "Missing the required parameter 'policy_id' when calling TagPoliciesAPI.get_tag_policy" end allowable_values = ['score'] if @api_client.config.client_side_validation && opts[:'include'] && !allowable_values.include?(opts[:'include']) fail ArgumentError, "invalid value for \"include\", must be one of #{allowable_values}" end # resource path local_var_path = '/api/v2/tag_policies/{policy_id}'.sub('{policy_id}', CGI.escape(policy_id.to_s).gsub('%2F', '/')) # query parameters query_params = opts[:query_params] || {} query_params[:'include'] = opts[:'include'] if !opts[:'include'].nil? query_params[:'ts_start'] = opts[:'ts_start'] if !opts[:'ts_start'].nil? query_params[:'ts_end'] = opts[:'ts_end'] if !opts[:'ts_end'].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] || 'TagPolicyResponse' # auth_names auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth] = opts.merge( :operation => :get_tag_policy, :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: TagPoliciesAPI#get_tag_policy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list_tag_policies(opts = {}) ⇒ Object
List tag policies.
340 341 342 343 |
# File 'lib/datadog_api_client/v2/api/tag_policies_api.rb', line 340 def list_tag_policies(opts = {}) data, _status_code, _headers = list_tag_policies_with_http_info(opts) data end |
#list_tag_policies_with_http_info(opts = {}) ⇒ Array<(TagPoliciesListResponse, Integer, Hash)>
List tag policies.
Retrieve all tag policies for the organization. Optionally include disabled or deleted
policies, filter by telemetry source, and include each policy's current compliance score
via the include=score query parameter.
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 414 415 416 417 418 419 420 421 422 423 |
# File 'lib/datadog_api_client/v2/api/tag_policies_api.rb', line 359 def list_tag_policies_with_http_info(opts = {}) unstable_enabled = @api_client.config.unstable_operations["v2.list_tag_policies".to_sym] if unstable_enabled @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.list_tag_policies") else raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.list_tag_policies")) end if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TagPoliciesAPI.list_tag_policies ...' end allowable_values = ['score'] if @api_client.config.client_side_validation && opts[:'include'] && !allowable_values.include?(opts[:'include']) fail ArgumentError, "invalid value for \"include\", must be one of #{allowable_values}" end allowable_values = ['logs', 'spans', 'metrics', 'rum', 'feed'] if @api_client.config.client_side_validation && opts[:'filter_source'] && !allowable_values.include?(opts[:'filter_source']) fail ArgumentError, "invalid value for \"filter_source\", must be one of #{allowable_values}" end # resource path local_var_path = '/api/v2/tag_policies' # query parameters query_params = opts[:query_params] || {} query_params[:'include_disabled'] = opts[:'include_disabled'] if !opts[:'include_disabled'].nil? query_params[:'include_deleted'] = opts[:'include_deleted'] if !opts[:'include_deleted'].nil? query_params[:'include'] = opts[:'include'] if !opts[:'include'].nil? query_params[:'filter[source]'] = opts[:'filter_source'] if !opts[:'filter_source'].nil? query_params[:'ts_start'] = opts[:'ts_start'] if !opts[:'ts_start'].nil? query_params[:'ts_end'] = opts[:'ts_end'] if !opts[:'ts_end'].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] || 'TagPoliciesListResponse' # auth_names auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth] = opts.merge( :operation => :list_tag_policies, :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: TagPoliciesAPI#list_tag_policies\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update_tag_policy(policy_id, body, opts = {}) ⇒ Object
Update a tag policy.
428 429 430 431 |
# File 'lib/datadog_api_client/v2/api/tag_policies_api.rb', line 428 def update_tag_policy(policy_id, body, opts = {}) data, _status_code, _headers = update_tag_policy_with_http_info(policy_id, body, opts) data end |
#update_tag_policy_with_http_info(policy_id, body, opts = {}) ⇒ Array<(TagPolicyResponse, Integer, Hash)>
Update a tag policy.
Update one or more attributes of an existing tag policy. Only the fields supplied in the
request body are modified; omitted fields retain their current values. The policy's
source cannot be changed after creation.
443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 |
# File 'lib/datadog_api_client/v2/api/tag_policies_api.rb', line 443 def update_tag_policy_with_http_info(policy_id, body, opts = {}) unstable_enabled = @api_client.config.unstable_operations["v2.update_tag_policy".to_sym] if unstable_enabled @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.update_tag_policy") else raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.update_tag_policy")) end if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TagPoliciesAPI.update_tag_policy ...' end # verify the required parameter 'policy_id' is set if @api_client.config.client_side_validation && policy_id.nil? fail ArgumentError, "Missing the required parameter 'policy_id' when calling TagPoliciesAPI.update_tag_policy" 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 TagPoliciesAPI.update_tag_policy" end # resource path local_var_path = '/api/v2/tag_policies/{policy_id}'.sub('{policy_id}', CGI.escape(policy_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] || 'TagPolicyResponse' # auth_names auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth] = opts.merge( :operation => :update_tag_policy, :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: TagPoliciesAPI#update_tag_policy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |