Class: DatadogAPIClient::V2::GovernanceBestPracticeDefinition

Inherits:
Object
  • Object
show all
Includes:
BaseGenericModel
Defined in:
lib/datadog_api_client/v2/models/governance_best_practice_definition.rb

Overview

The best practice associated with an insight. Populated with the first active best practice matched to the insight; null when no best practice is attached.

Instance Attribute Summary collapse

Method Summary

Methods included from BaseGenericModel

included

Instance Attribute Details

#additional_properties ⇒ Object

Returns the value of attribute additional_properties.



68
69
70
 
# File 'lib/datadog_api_client/v2/models/governance_best_practice_definition.rb', line 68

def additional_properties
  @additional_properties
end

#category ⇒ Object

The value driver the best practice is grouped under, such as access_governance, security, compliance, or operational_hygiene.



27
28
29
 
# File 'lib/datadog_api_client/v2/models/governance_best_practice_definition.rb', line 27

def category
  @category
end

#deep_link ⇒ Object

A relative link to the configuration page where the best practice can be acted upon.



30
31
32
 
# File 'lib/datadog_api_client/v2/models/governance_best_practice_definition.rb', line 30

def deep_link
  @deep_link
end

#description ⇒ Object

The full rationale and guidance for the best practice.



33
34
35
 
# File 'lib/datadog_api_client/v2/models/governance_best_practice_definition.rb', line 33

def description
  @description
end

#detection_type ⇒ Object

An optional association to a control's detection type. null when not associated with a control.



36
37
38
 
# File 'lib/datadog_api_client/v2/models/governance_best_practice_definition.rb', line 36

def detection_type
  @detection_type
end

#id ⇒ Object

The unique identifier of the best practice.



39
40
41
 
# File 'lib/datadog_api_client/v2/models/governance_best_practice_definition.rb', line 39

def id
  @id
end

#impact ⇒ Object

The expected impact of following the best practice.



42
43
44
 
# File 'lib/datadog_api_client/v2/models/governance_best_practice_definition.rb', line 42

def impact
  @impact
end

#impact_hint ⇒ Object

A priority hint for ordering best practices by expected impact. Lower values indicate higher priority.



46
47
48
 
# File 'lib/datadog_api_client/v2/models/governance_best_practice_definition.rb', line 46

def impact_hint
  @impact_hint
end

#permissions ⇒ Object

The permissions required for the user to act on the best practice.



49
50
51
 
# File 'lib/datadog_api_client/v2/models/governance_best_practice_definition.rb', line 49

def permissions
  @permissions
end

#status ⇒ Object

Whether the best practice is currently active or deprecated.



52
53
54
 
# File 'lib/datadog_api_client/v2/models/governance_best_practice_definition.rb', line 52

def status
  @status
end

#summary ⇒ Object

A one-line explanation of why this best practice matters.



55
56
57
 
# File 'lib/datadog_api_client/v2/models/governance_best_practice_definition.rb', line 55

def summary
  @summary
end

#title ⇒ Object

A short, human-readable name for the best practice.



58
59
60
 
# File 'lib/datadog_api_client/v2/models/governance_best_practice_definition.rb', line 58

def title
  @title
end

#trigger_condition ⇒ Object

The condition that surfaces the best practice. For an insight trigger, the insight slug; for a static trigger, a descriptive condition key.



62
63
64
 
# File 'lib/datadog_api_client/v2/models/governance_best_practice_definition.rb', line 62

def trigger_condition
  @trigger_condition
end

#trigger_type ⇒ Object

How the best practice is surfaced. insight ties it to an insight; static surfaces it unless its condition is met.



66
67
68
 
# File 'lib/datadog_api_client/v2/models/governance_best_practice_definition.rb', line 66

def trigger_type
  @trigger_type
end