Class: DatadogAPIClient::V2::AnalysisRequestRule

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

Overview

A static analysis rule to apply during code analysis. Clients forward complete rule objects returned by the rulesets endpoints, so every member of that resource is declared here; only id, category, checksum, language, severity, tree_sitter_query, entity_checked, regex, type and code are read by this operation and the rest are ignored. The schema stays open so that any member beyond the forwarded rule resource is reported as a promotion candidate rather than rejected; it can be closed once that telemetry confirms none remain.

Instance Attribute Summary collapse

Method Summary

Methods included from BaseGenericModel

included

Instance Attribute Details

#additional_properties ⇒ Object

Returns the value of attribute additional_properties.



114
115
116
 
# File 'lib/datadog_api_client/v2/models/analysis_request_rule.rb', line 114

def additional_properties
  @additional_properties
end

#arguments ⇒ Object

The configurable arguments accepted by the rule. Forwarded from the rulesets endpoints; ignored by this operation.



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

def arguments
  @arguments
end

#category ⇒ Object

The category of the rule (for example, BEST_PRACTICES, SECURITY).



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

def category
  @category
end

#checksum ⇒ Object

A checksum of the rule definition.



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

def checksum
  @checksum
end

#code ⇒ Object

The base64-encoded rule implementation code.



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

def code
  @code
end

#created_at ⇒ Object

The date and time when the rule was created. Server-assigned by the rulesets endpoints; ignored by this operation.



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

def created_at
  @created_at
end

#created_by ⇒ Object

The identifier of the user or system that created the rule. Server-assigned by the rulesets endpoints; ignored by this operation.



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

def created_by
  @created_by
end

#creation_message ⇒ Object

The message associated with the custom rule revision. Forwarded from the custom rulesets endpoints; ignored by this operation.



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

def creation_message
  @creation_message
end

#cve ⇒ Object

The CVE identifier associated with the rule. Forwarded from the rulesets endpoints; ignored by this operation.



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

def cve
  @cve
end

#cwe ⇒ Object

The CWE identifier associated with the rule. Forwarded from the rulesets endpoints; ignored by this operation.



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

def cwe
  @cwe
end

#description ⇒ Object

A detailed explanation of what the rule detects. Forwarded from the rulesets endpoints; ignored by this operation.



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

def description
  @description
end

#documentation_url ⇒ Object

A URL pointing to the rule documentation. Forwarded from the rulesets endpoints; ignored by this operation.



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

def documentation_url
  @documentation_url
end

#entity_checked ⇒ Object

The code entity type checked by the rule, applicable when rule type is AST_CHECK.



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

def entity_checked
  @entity_checked
end

#id ⇒ Object

The unique identifier of the rule.



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

def id
  @id
end

#is_published ⇒ Object

Whether the rule is published. Forwarded from the rulesets endpoints; ignored by this operation.



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

def is_published
  @is_published
end

#is_testing ⇒ Object

Whether the rule is in testing mode. Forwarded from the rulesets endpoints; ignored by this operation.



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

def is_testing
  @is_testing
end

#language ⇒ Object

The programming language this rule targets.



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

def language
  @language
end

#last_updated_at ⇒ Object

The date and time when the rule was last modified. Server-assigned by the rulesets endpoints; ignored by this operation.



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

def last_updated_at
  @last_updated_at
end

#last_updated_by ⇒ Object

The identifier of the user or system that last updated the rule. Server-assigned by the rulesets endpoints; ignored by this operation.



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

def last_updated_by
  @last_updated_by
end

#name ⇒ Object

The name of the rule. Forwarded from the rulesets endpoints; ignored by this operation.



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

def name
  @name
end

#regex ⇒ Object

A base64-encoded regex pattern used by the rule, applicable when rule type is REGEX.



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

def regex
  @regex
end

#severity ⇒ Object

The severity of findings from this rule (for example, ERROR, WARNING).



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

def severity
  @severity
end

#short_description ⇒ Object

A brief summary of what the rule detects. Forwarded from the rulesets endpoints; ignored by this operation.



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

def short_description
  @short_description
end

#should_use_ai_fix ⇒ Object

Whether an AI-generated fix should be offered. Forwarded from the rulesets endpoints; ignored by this operation.



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

def should_use_ai_fix
  @should_use_ai_fix
end

#tags ⇒ Object

Tags associated with the custom rule revision. Forwarded from the custom rulesets endpoints; ignored by this operation.



100
101
102
 
# File 'lib/datadog_api_client/v2/models/analysis_request_rule.rb', line 100

def tags
  @tags
end

#tests ⇒ Object

The test cases associated with the rule. Forwarded from the rulesets endpoints; ignored by this operation.



103
104
105
 
# File 'lib/datadog_api_client/v2/models/analysis_request_rule.rb', line 103

def tests
  @tests
end

#tree_sitter_query ⇒ Object

The base64-encoded tree-sitter query used by the rule.



106
107
108
 
# File 'lib/datadog_api_client/v2/models/analysis_request_rule.rb', line 106

def tree_sitter_query
  @tree_sitter_query
end

#type ⇒ Object

The rule type indicating the detection mechanism (for example, TREE_SITTER_QUERY).



109
110
111
 
# File 'lib/datadog_api_client/v2/models/analysis_request_rule.rb', line 109

def type
  @type
end

#version_id ⇒ Object

The custom rule revision version. Forwarded from the custom rulesets endpoints; ignored by this operation.



112
113
114
 
# File 'lib/datadog_api_client/v2/models/analysis_request_rule.rb', line 112

def version_id
  @version_id
end