Class: DatadogAPIClient::V2::GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItems

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

Overview

A static analysis rule within a ruleset, including its definition, metadata, and associated test cases.

Instance Attribute Summary collapse

Method Summary

Methods included from BaseGenericModel

included

Instance Attribute Details

#additional_properties ⇒ Object

Returns the value of attribute additional_properties.



99
100
101
 
# File 'lib/datadog_api_client/v2/models/get_multiple_rulesets_response_data_attributes_rulesets_items_rules_items.rb', line 99

def additional_properties
  @additional_properties
end

#arguments ⇒ Object

The list of configurable arguments accepted by this rule.



25
26
27
 
# File 'lib/datadog_api_client/v2/models/get_multiple_rulesets_response_data_attributes_rulesets_items_rules_items.rb', line 25

def arguments
  @arguments
end

#category ⇒ Object

The category classifying the type of issue this rule detects (e.g., security, style, performance).



28
29
30
 
# File 'lib/datadog_api_client/v2/models/get_multiple_rulesets_response_data_attributes_rulesets_items_rules_items.rb', line 28

def category
  @category
end

#checksum ⇒ Object

A checksum of the rule definition used to detect changes.



31
32
33
 
# File 'lib/datadog_api_client/v2/models/get_multiple_rulesets_response_data_attributes_rulesets_items_rules_items.rb', line 31

def checksum
  @checksum
end

#code ⇒ Object

The rule implementation code used by the static analysis engine.



34
35
36
 
# File 'lib/datadog_api_client/v2/models/get_multiple_rulesets_response_data_attributes_rulesets_items_rules_items.rb', line 34

def code
  @code
end

#created_at ⇒ Object

The date and time when the rule was created.



37
38
39
 
# File 'lib/datadog_api_client/v2/models/get_multiple_rulesets_response_data_attributes_rulesets_items_rules_items.rb', line 37

def created_at
  @created_at
end

#created_by ⇒ Object

The identifier of the user or system that created the rule.



40
41
42
 
# File 'lib/datadog_api_client/v2/models/get_multiple_rulesets_response_data_attributes_rulesets_items_rules_items.rb', line 40

def created_by
  @created_by
end

#cve ⇒ Object

The CVE identifier associated with the vulnerability this rule detects, if applicable.



43
44
45
 
# File 'lib/datadog_api_client/v2/models/get_multiple_rulesets_response_data_attributes_rulesets_items_rules_items.rb', line 43

def cve
  @cve
end

#cwe ⇒ Object

The CWE identifier associated with the weakness category this rule detects, if applicable.



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

def cwe
  @cwe
end

#description ⇒ Object

A detailed explanation of what the rule detects and why it matters.



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

def description
  @description
end

#documentation_url ⇒ Object

A URL pointing to additional documentation for this rule.



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

def documentation_url
  @documentation_url
end

#entity_checked ⇒ Object

The code entity type (e.g., function, class, variable) that this rule inspects.



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

def entity_checked
  @entity_checked
end

#id ⇒ Object

The unique identifier of the rule, which is the same as its name.



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

def id
  @id
end

#is_published ⇒ Object

Indicates whether the rule is publicly published and available to all users.



61
62
63
 
# File 'lib/datadog_api_client/v2/models/get_multiple_rulesets_response_data_attributes_rulesets_items_rules_items.rb', line 61

def is_published
  @is_published
end

#is_testing ⇒ Object

Indicates whether the rule is in testing mode and not yet promoted to production.



64
65
66
 
# File 'lib/datadog_api_client/v2/models/get_multiple_rulesets_response_data_attributes_rulesets_items_rules_items.rb', line 64

def is_testing
  @is_testing
end

#language ⇒ Object

The programming language this rule applies to.



67
68
69
 
# File 'lib/datadog_api_client/v2/models/get_multiple_rulesets_response_data_attributes_rulesets_items_rules_items.rb', line 67

def language
  @language
end

#last_updated_at ⇒ Object

The date and time when the rule was last modified.



70
71
72
 
# File 'lib/datadog_api_client/v2/models/get_multiple_rulesets_response_data_attributes_rulesets_items_rules_items.rb', line 70

def last_updated_at
  @last_updated_at
end

#last_updated_by ⇒ Object

The identifier of the user or system that last updated the rule.



73
74
75
 
# File 'lib/datadog_api_client/v2/models/get_multiple_rulesets_response_data_attributes_rulesets_items_rules_items.rb', line 73

def last_updated_by
  @last_updated_by
end

#name ⇒ Object

The unique name identifying this rule within its ruleset.



76
77
78
 
# File 'lib/datadog_api_client/v2/models/get_multiple_rulesets_response_data_attributes_rulesets_items_rules_items.rb', line 76

def name
  @name
end

#regex ⇒ Object

A regular expression pattern used by the rule for pattern-based detection.



79
80
81
 
# File 'lib/datadog_api_client/v2/models/get_multiple_rulesets_response_data_attributes_rulesets_items_rules_items.rb', line 79

def regex
  @regex
end

#severity ⇒ Object

The severity level of findings produced by this rule (e.g., ERROR, WARNING, NOTICE).



82
83
84
 
# File 'lib/datadog_api_client/v2/models/get_multiple_rulesets_response_data_attributes_rulesets_items_rules_items.rb', line 82

def severity
  @severity
end

#short_description ⇒ Object

A brief summary of what the rule detects, suitable for display in listings.



85
86
87
 
# File 'lib/datadog_api_client/v2/models/get_multiple_rulesets_response_data_attributes_rulesets_items_rules_items.rb', line 85

def short_description
  @short_description
end

#should_use_ai_fix ⇒ Object

Indicates whether an AI-generated fix suggestion should be offered for findings from this rule.



88
89
90
 
# File 'lib/datadog_api_client/v2/models/get_multiple_rulesets_response_data_attributes_rulesets_items_rules_items.rb', line 88

def should_use_ai_fix
  @should_use_ai_fix
end

#tests ⇒ Object

The list of test cases used to validate the rule's behavior.



91
92
93
 
# File 'lib/datadog_api_client/v2/models/get_multiple_rulesets_response_data_attributes_rulesets_items_rules_items.rb', line 91

def tests
  @tests
end

#tree_sitter_query ⇒ Object

The Tree-sitter query expression used by the rule to match code patterns in the AST.



94
95
96
 
# File 'lib/datadog_api_client/v2/models/get_multiple_rulesets_response_data_attributes_rulesets_items_rules_items.rb', line 94

def tree_sitter_query
  @tree_sitter_query
end

#type ⇒ Object

The rule type indicating the detection mechanism used (e.g., tree_sitter, regex).



97
98
99
 
# File 'lib/datadog_api_client/v2/models/get_multiple_rulesets_response_data_attributes_rulesets_items_rules_items.rb', line 97

def type
  @type
end