Class: DatadogAPIClient::V2::TagRuleCreateAttributes
- Inherits:
-
Object
- Object
- DatadogAPIClient::V2::TagRuleCreateAttributes
- Includes:
- BaseGenericModel
- Defined in:
- lib/datadog_api_client/v2/models/tag_rule_create_attributes.rb
Overview
Attributes that can be supplied when creating a tag rule. If tag_value_patterns
contains *, set required and negated to different values. If both are false,
the rule has no effect. If both are true, no value can satisfy the rule.
Instance Attribute Summary collapse
-
#additional_properties ⇒ Object
Returns the value of attribute additional_properties.
-
#enabled ⇒ Object
The API ignores this value on creation and always enables new rules.
-
#name ⇒ Object
readonly
Human-readable name for the tag rule.
-
#negated ⇒ Object
When
true, the rule matches tag values that do NOT match any of the supplied patterns. -
#required ⇒ Object
When
true, telemetry without this tag is treated as a violation. -
#rule_type ⇒ Object
readonly
The rule type allowed when creating a tag rule.
-
#scope ⇒ Object
readonly
The scope the rule applies within.
-
#source ⇒ Object
readonly
The telemetry source that a tag rule applies to.
-
#tag_key ⇒ Object
readonly
The tag key that the rule governs (for example,
service). -
#tag_value_patterns ⇒ Object
readonly
Between 1 and 30 non-empty patterns that valid values for the tag key must match.
Method Summary
Methods included from BaseGenericModel
Instance Attribute Details
#additional_properties ⇒ Object
Returns the value of attribute additional_properties.
61 62 63 |
# File 'lib/datadog_api_client/v2/models/tag_rule_create_attributes.rb', line 61 def additional_properties @additional_properties end |
#enabled ⇒ Object
The API ignores this value on creation and always enables new rules. To disable a rule, use the "Update a tag rule" endpoint.
27 28 29 |
# File 'lib/datadog_api_client/v2/models/tag_rule_create_attributes.rb', line 27 def enabled @enabled end |
#name ⇒ Object
Human-readable name for the tag rule.
30 31 32 |
# File 'lib/datadog_api_client/v2/models/tag_rule_create_attributes.rb', line 30 def name @name end |
#negated ⇒ Object
When true, the rule matches tag values that do NOT match any of the supplied patterns. Defaults to false.
33 34 35 |
# File 'lib/datadog_api_client/v2/models/tag_rule_create_attributes.rb', line 33 def negated @negated end |
#required ⇒ Object
When true, telemetry without this tag is treated as a violation. Defaults to false.
36 37 38 |
# File 'lib/datadog_api_client/v2/models/tag_rule_create_attributes.rb', line 36 def required @required end |
#rule_type ⇒ Object
The rule type allowed when creating a tag rule. Only surfacing is accepted at
creation time.
40 41 42 |
# File 'lib/datadog_api_client/v2/models/tag_rule_create_attributes.rb', line 40 def rule_type @rule_type end |
#scope ⇒ Object
The scope the rule applies within. For logs and spans, use a search query, such
as env:prod, or * to match all telemetry. For metrics, use a metric selector
with an optional tag filter, such as system.cpu.*{env:prod}. A metric wildcard
is allowed only once, at the end of the metric selector.
46 47 48 |
# File 'lib/datadog_api_client/v2/models/tag_rule_create_attributes.rb', line 46 def scope @scope end |
#source ⇒ Object
The telemetry source that a tag rule applies to.
49 50 51 |
# File 'lib/datadog_api_client/v2/models/tag_rule_create_attributes.rb', line 49 def source @source end |
#tag_key ⇒ Object
The tag key that the rule governs (for example, service). Allowed characters
are ASCII letters, digits, underscores, hyphens, periods, and slashes. The keys
host and device are not supported in any letter case.
54 55 56 |
# File 'lib/datadog_api_client/v2/models/tag_rule_create_attributes.rb', line 54 def tag_key @tag_key end |
#tag_value_patterns ⇒ Object
Between 1 and 30 non-empty patterns that valid values for the tag key must match. Allowed characters are ASCII letters, digits, underscores, colons, hyphens, periods, commas, slashes, and asterisks.
59 60 61 |
# File 'lib/datadog_api_client/v2/models/tag_rule_create_attributes.rb', line 59 def tag_value_patterns @tag_value_patterns end |