datadog_api_client 2.39.0 → 2.41.0

data/lib/datadog_api_client/v2/models/security_monitoring_standard_rule_create_payload.rb

@@ -21,6 +21,9 @@ module DatadogAPIClient::V2
   class SecurityMonitoringStandardRuleCreatePayload
     include BaseGenericModel
 
+    # Calculated fields. Only allowed for scheduled rules - in other words, when schedulingOptions is also defined.
+    attr_accessor :calculated_fields
+
     # Cases for generating signals.
     attr_reader :cases
 
@@ -51,6 +54,9 @@ module DatadogAPIClient::V2
     # Reference tables for the rule.
     attr_accessor :reference_tables
 
+    # Options for scheduled rules. When this field is present, the rule runs based on the schedule. When absent, it runs real-time on ingested logs.
+    attr_accessor :scheduling_options
+
     # Tags for generated signals.
     attr_accessor :tags
 
@@ -66,6 +72,7 @@ module DatadogAPIClient::V2
     # @!visibility private
     def self.attribute_map
       {
+        :'calculated_fields' => :'calculatedFields',
         :'cases' => :'cases',
         :'filters' => :'filters',
         :'group_signals_by' => :'groupSignalsBy',
@@ -76,6 +83,7 @@ module DatadogAPIClient::V2
         :'options' => :'options',
         :'queries' => :'queries',
         :'reference_tables' => :'referenceTables',
+        :'scheduling_options' => :'schedulingOptions',
         :'tags' => :'tags',
         :'third_party_cases' => :'thirdPartyCases',
         :'type' => :'type'
@@ -86,6 +94,7 @@ module DatadogAPIClient::V2
     # @!visibility private
     def self.openapi_types
       {
+        :'calculated_fields' => :'Array<CalculatedField>',
         :'cases' => :'Array<SecurityMonitoringRuleCaseCreate>',
         :'filters' => :'Array<SecurityMonitoringFilter>',
         :'group_signals_by' => :'Array<String>',
@@ -96,12 +105,21 @@ module DatadogAPIClient::V2
         :'options' => :'SecurityMonitoringRuleOptions',
         :'queries' => :'Array<SecurityMonitoringStandardRuleQuery>',
         :'reference_tables' => :'Array<SecurityMonitoringReferenceTable>',
+        :'scheduling_options' => :'SecurityMonitoringSchedulingOptions',
         :'tags' => :'Array<String>',
         :'third_party_cases' => :'Array<SecurityMonitoringThirdPartyRuleCaseCreate>',
         :'type' => :'SecurityMonitoringRuleTypeCreate'
       }
     end
 
+    # List of attributes with nullable: true
+    # @!visibility private
+    def self.openapi_nullable
+      Set.new([
+        :'scheduling_options',
+      ])
+    end
+
     # Initializes the object
     # @param attributes [Hash] Model attributes in the form of hash
     # @!visibility private
@@ -120,6 +138,12 @@ module DatadogAPIClient::V2
         end
       }
 
+      if attributes.key?(:'calculated_fields')
+        if (value = attributes[:'calculated_fields']).is_a?(Array)
+          self.calculated_fields = value
+        end
+      end
+
       if attributes.key?(:'cases')
         if (value = attributes[:'cases']).is_a?(Array)
           self.cases = value
@@ -170,6 +194,10 @@ module DatadogAPIClient::V2
         end
       end
 
+      if attributes.key?(:'scheduling_options')
+        self.scheduling_options = attributes[:'scheduling_options']
+      end
+
       if attributes.key?(:'tags')
         if (value = attributes[:'tags']).is_a?(Array)
           self.tags = value
@@ -286,6 +314,7 @@ module DatadogAPIClient::V2
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          calculated_fields == o.calculated_fields &&
           cases == o.cases &&
           filters == o.filters &&
           group_signals_by == o.group_signals_by &&
@@ -296,6 +325,7 @@ module DatadogAPIClient::V2
           options == o.options &&
           queries == o.queries &&
           reference_tables == o.reference_tables &&
+          scheduling_options == o.scheduling_options &&
           tags == o.tags &&
           third_party_cases == o.third_party_cases &&
           type == o.type &&
@@ -306,7 +336,7 @@ module DatadogAPIClient::V2
     # @return [Integer] Hash code
     # @!visibility private
     def hash
-      [cases, filters, group_signals_by, has_extended_title, is_enabled, message, name, options, queries, reference_tables, tags, third_party_cases, type, additional_properties].hash
+      [calculated_fields, cases, filters, group_signals_by, has_extended_title, is_enabled, message, name, options, queries, reference_tables, scheduling_options, tags, third_party_cases, type, additional_properties].hash
     end
   end
 end

data/lib/datadog_api_client/v2/models/security_monitoring_standard_rule_payload.rb

@@ -21,6 +21,9 @@ module DatadogAPIClient::V2
   class SecurityMonitoringStandardRulePayload
     include BaseGenericModel
 
+    # Calculated fields. Only allowed for scheduled rules - in other words, when schedulingOptions is also defined.
+    attr_accessor :calculated_fields
+
     # Cases for generating signals.
     attr_reader :cases
 
@@ -57,6 +60,9 @@ module DatadogAPIClient::V2
     # Reference tables for the rule.
     attr_accessor :reference_tables
 
+    # Options for scheduled rules. When this field is present, the rule runs based on the schedule. When absent, it runs real-time on ingested logs.
+    attr_accessor :scheduling_options
+
     # Tags for generated signals.
     attr_accessor :tags
 
@@ -72,6 +78,7 @@ module DatadogAPIClient::V2
     # @!visibility private
     def self.attribute_map
       {
+        :'calculated_fields' => :'calculatedFields',
         :'cases' => :'cases',
         :'custom_message' => :'customMessage',
         :'custom_name' => :'customName',
@@ -84,6 +91,7 @@ module DatadogAPIClient::V2
         :'options' => :'options',
         :'queries' => :'queries',
         :'reference_tables' => :'referenceTables',
+        :'scheduling_options' => :'schedulingOptions',
         :'tags' => :'tags',
         :'third_party_cases' => :'thirdPartyCases',
         :'type' => :'type'
@@ -94,6 +102,7 @@ module DatadogAPIClient::V2
     # @!visibility private
     def self.openapi_types
       {
+        :'calculated_fields' => :'Array<CalculatedField>',
         :'cases' => :'Array<SecurityMonitoringRuleCaseCreate>',
         :'custom_message' => :'String',
         :'custom_name' => :'String',
@@ -106,12 +115,21 @@ module DatadogAPIClient::V2
         :'options' => :'SecurityMonitoringRuleOptions',
         :'queries' => :'Array<SecurityMonitoringStandardRuleQuery>',
         :'reference_tables' => :'Array<SecurityMonitoringReferenceTable>',
+        :'scheduling_options' => :'SecurityMonitoringSchedulingOptions',
         :'tags' => :'Array<String>',
         :'third_party_cases' => :'Array<SecurityMonitoringThirdPartyRuleCaseCreate>',
         :'type' => :'SecurityMonitoringRuleTypeCreate'
       }
     end
 
+    # List of attributes with nullable: true
+    # @!visibility private
+    def self.openapi_nullable
+      Set.new([
+        :'scheduling_options',
+      ])
+    end
+
     # Initializes the object
     # @param attributes [Hash] Model attributes in the form of hash
     # @!visibility private
@@ -130,6 +148,12 @@ module DatadogAPIClient::V2
         end
       }
 
+      if attributes.key?(:'calculated_fields')
+        if (value = attributes[:'calculated_fields']).is_a?(Array)
+          self.calculated_fields = value
+        end
+      end
+
       if attributes.key?(:'cases')
         if (value = attributes[:'cases']).is_a?(Array)
           self.cases = value
@@ -188,6 +212,10 @@ module DatadogAPIClient::V2
         end
       end
 
+      if attributes.key?(:'scheduling_options')
+        self.scheduling_options = attributes[:'scheduling_options']
+      end
+
       if attributes.key?(:'tags')
         if (value = attributes[:'tags']).is_a?(Array)
           self.tags = value
@@ -304,6 +332,7 @@ module DatadogAPIClient::V2
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          calculated_fields == o.calculated_fields &&
           cases == o.cases &&
           custom_message == o.custom_message &&
           custom_name == o.custom_name &&
@@ -316,6 +345,7 @@ module DatadogAPIClient::V2
           options == o.options &&
           queries == o.queries &&
           reference_tables == o.reference_tables &&
+          scheduling_options == o.scheduling_options &&
           tags == o.tags &&
           third_party_cases == o.third_party_cases &&
           type == o.type &&
@@ -326,7 +356,7 @@ module DatadogAPIClient::V2
     # @return [Integer] Hash code
     # @!visibility private
     def hash
-      [cases, custom_message, custom_name, filters, group_signals_by, has_extended_title, is_enabled, message, name, options, queries, reference_tables, tags, third_party_cases, type, additional_properties].hash
+      [calculated_fields, cases, custom_message, custom_name, filters, group_signals_by, has_extended_title, is_enabled, message, name, options, queries, reference_tables, scheduling_options, tags, third_party_cases, type, additional_properties].hash
     end
   end
 end

data/lib/datadog_api_client/v2/models/security_monitoring_standard_rule_query.rb

@@ -39,6 +39,10 @@ module DatadogAPIClient::V2
     # When false, events without a group-by value are ignored by the rule. When true, events with missing group-by fields are processed with `N/A`, replacing the missing values.
     attr_accessor :has_optional_group_by_fields
 
+    # **This field is currently unstable and might be removed in a minor version upgrade.**
+    # The index to run the query on, if the `dataSource` is `logs`. Only used for scheduled rules - in other words, when the `schedulingOptions` field is present in the rule payload.
+    attr_accessor :index
+
     # (Deprecated) The target field to aggregate over when using the sum or max
     # aggregations. `metrics` field should be used instead.
     attr_accessor :metric
@@ -64,6 +68,7 @@ module DatadogAPIClient::V2
         :'distinct_fields' => :'distinctFields',
         :'group_by_fields' => :'groupByFields',
         :'has_optional_group_by_fields' => :'hasOptionalGroupByFields',
+        :'index' => :'index',
         :'metric' => :'metric',
         :'metrics' => :'metrics',
         :'name' => :'name',
@@ -81,6 +86,7 @@ module DatadogAPIClient::V2
         :'distinct_fields' => :'Array<String>',
         :'group_by_fields' => :'Array<String>',
         :'has_optional_group_by_fields' => :'Boolean',
+        :'index' => :'String',
         :'metric' => :'String',
         :'metrics' => :'Array<String>',
         :'name' => :'String',
@@ -134,6 +140,10 @@ module DatadogAPIClient::V2
         self.has_optional_group_by_fields = attributes[:'has_optional_group_by_fields']
       end
 
+      if attributes.key?(:'index')
+        self.index = attributes[:'index']
+      end
+
       if attributes.key?(:'metric')
         self.metric = attributes[:'metric']
       end
@@ -185,6 +195,7 @@ module DatadogAPIClient::V2
           distinct_fields == o.distinct_fields &&
           group_by_fields == o.group_by_fields &&
           has_optional_group_by_fields == o.has_optional_group_by_fields &&
+          index == o.index &&
           metric == o.metric &&
           metrics == o.metrics &&
           name == o.name &&
@@ -196,7 +207,7 @@ module DatadogAPIClient::V2
     # @return [Integer] Hash code
     # @!visibility private
     def hash
-      [aggregation, custom_query_extension, data_source, distinct_fields, group_by_fields, has_optional_group_by_fields, metric, metrics, name, query, additional_properties].hash
+      [aggregation, custom_query_extension, data_source, distinct_fields, group_by_fields, has_optional_group_by_fields, index, metric, metrics, name, query, additional_properties].hash
     end
   end
 end

data/lib/datadog_api_client/v2/models/security_monitoring_standard_rule_response.rb

@@ -21,6 +21,9 @@ module DatadogAPIClient::V2
   class SecurityMonitoringStandardRuleResponse
     include BaseGenericModel
 
+    # Calculated fields. Only allowed for scheduled rules - in other words, when schedulingOptions is also defined.
+    attr_accessor :calculated_fields
+
     # Cases for generating signals.
     attr_accessor :cases
 
@@ -81,6 +84,9 @@ module DatadogAPIClient::V2
     # Reference tables for the rule.
     attr_accessor :reference_tables
 
+    # Options for scheduled rules. When this field is present, the rule runs based on the schedule. When absent, it runs real-time on ingested logs.
+    attr_accessor :scheduling_options
+
     # Tags for generated signals.
     attr_accessor :tags
 
@@ -105,6 +111,7 @@ module DatadogAPIClient::V2
     # @!visibility private
     def self.attribute_map
       {
+        :'calculated_fields' => :'calculatedFields',
         :'cases' => :'cases',
         :'compliance_signal_options' => :'complianceSignalOptions',
         :'created_at' => :'createdAt',
@@ -125,6 +132,7 @@ module DatadogAPIClient::V2
         :'options' => :'options',
         :'queries' => :'queries',
         :'reference_tables' => :'referenceTables',
+        :'scheduling_options' => :'schedulingOptions',
         :'tags' => :'tags',
         :'third_party_cases' => :'thirdPartyCases',
         :'type' => :'type',
@@ -138,6 +146,7 @@ module DatadogAPIClient::V2
     # @!visibility private
     def self.openapi_types
       {
+        :'calculated_fields' => :'Array<CalculatedField>',
         :'cases' => :'Array<SecurityMonitoringRuleCase>',
         :'compliance_signal_options' => :'CloudConfigurationRuleComplianceSignalOptions',
         :'created_at' => :'Integer',
@@ -158,6 +167,7 @@ module DatadogAPIClient::V2
         :'options' => :'SecurityMonitoringRuleOptions',
         :'queries' => :'Array<SecurityMonitoringStandardRuleQuery>',
         :'reference_tables' => :'Array<SecurityMonitoringReferenceTable>',
+        :'scheduling_options' => :'SecurityMonitoringSchedulingOptions',
         :'tags' => :'Array<String>',
         :'third_party_cases' => :'Array<SecurityMonitoringThirdPartyRuleCase>',
         :'type' => :'SecurityMonitoringRuleTypeRead',
@@ -167,6 +177,14 @@ module DatadogAPIClient::V2
       }
     end
 
+    # List of attributes with nullable: true
+    # @!visibility private
+    def self.openapi_nullable
+      Set.new([
+        :'scheduling_options',
+      ])
+    end
+
     # Initializes the object
     # @param attributes [Hash] Model attributes in the form of hash
     # @!visibility private
@@ -185,6 +203,12 @@ module DatadogAPIClient::V2
         end
       }
 
+      if attributes.key?(:'calculated_fields')
+        if (value = attributes[:'calculated_fields']).is_a?(Array)
+          self.calculated_fields = value
+        end
+      end
+
       if attributes.key?(:'cases')
         if (value = attributes[:'cases']).is_a?(Array)
           self.cases = value
@@ -277,6 +301,10 @@ module DatadogAPIClient::V2
         end
       end
 
+      if attributes.key?(:'scheduling_options')
+        self.scheduling_options = attributes[:'scheduling_options']
+      end
+
       if attributes.key?(:'tags')
         if (value = attributes[:'tags']).is_a?(Array)
           self.tags = value
@@ -332,6 +360,7 @@ module DatadogAPIClient::V2
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          calculated_fields == o.calculated_fields &&
           cases == o.cases &&
           compliance_signal_options == o.compliance_signal_options &&
           created_at == o.created_at &&
@@ -352,6 +381,7 @@ module DatadogAPIClient::V2
           options == o.options &&
           queries == o.queries &&
           reference_tables == o.reference_tables &&
+          scheduling_options == o.scheduling_options &&
           tags == o.tags &&
           third_party_cases == o.third_party_cases &&
           type == o.type &&
@@ -365,7 +395,7 @@ module DatadogAPIClient::V2
     # @return [Integer] Hash code
     # @!visibility private
     def hash
-      [cases, compliance_signal_options, created_at, creation_author_id, custom_message, custom_name, default_tags, deprecation_date, filters, group_signals_by, has_extended_title, id, is_default, is_deleted, is_enabled, message, name, options, queries, reference_tables, tags, third_party_cases, type, update_author_id, updated_at, version, additional_properties].hash
+      [calculated_fields, cases, compliance_signal_options, created_at, creation_author_id, custom_message, custom_name, default_tags, deprecation_date, filters, group_signals_by, has_extended_title, id, is_default, is_deleted, is_enabled, message, name, options, queries, reference_tables, scheduling_options, tags, third_party_cases, type, update_author_id, updated_at, version, additional_properties].hash
     end
   end
 end

data/lib/datadog_api_client/v2/models/security_monitoring_standard_rule_test_payload.rb

@@ -21,6 +21,9 @@ module DatadogAPIClient::V2
   class SecurityMonitoringStandardRuleTestPayload
     include BaseGenericModel
 
+    # Calculated fields. Only allowed for scheduled rules - in other words, when schedulingOptions is also defined.
+    attr_accessor :calculated_fields
+
     # Cases for generating signals.
     attr_reader :cases
 
@@ -51,6 +54,9 @@ module DatadogAPIClient::V2
     # Reference tables for the rule.
     attr_accessor :reference_tables
 
+    # Options for scheduled rules. When this field is present, the rule runs based on the schedule. When absent, it runs real-time on ingested logs.
+    attr_accessor :scheduling_options
+
     # Tags for generated signals.
     attr_accessor :tags
 
@@ -66,6 +72,7 @@ module DatadogAPIClient::V2
     # @!visibility private
     def self.attribute_map
       {
+        :'calculated_fields' => :'calculatedFields',
         :'cases' => :'cases',
         :'filters' => :'filters',
         :'group_signals_by' => :'groupSignalsBy',
@@ -76,6 +83,7 @@ module DatadogAPIClient::V2
         :'options' => :'options',
         :'queries' => :'queries',
         :'reference_tables' => :'referenceTables',
+        :'scheduling_options' => :'schedulingOptions',
         :'tags' => :'tags',
         :'third_party_cases' => :'thirdPartyCases',
         :'type' => :'type'
@@ -86,6 +94,7 @@ module DatadogAPIClient::V2
     # @!visibility private
     def self.openapi_types
       {
+        :'calculated_fields' => :'Array<CalculatedField>',
         :'cases' => :'Array<SecurityMonitoringRuleCaseCreate>',
         :'filters' => :'Array<SecurityMonitoringFilter>',
         :'group_signals_by' => :'Array<String>',
@@ -96,12 +105,21 @@ module DatadogAPIClient::V2
         :'options' => :'SecurityMonitoringRuleOptions',
         :'queries' => :'Array<SecurityMonitoringStandardRuleQuery>',
         :'reference_tables' => :'Array<SecurityMonitoringReferenceTable>',
+        :'scheduling_options' => :'SecurityMonitoringSchedulingOptions',
         :'tags' => :'Array<String>',
         :'third_party_cases' => :'Array<SecurityMonitoringThirdPartyRuleCaseCreate>',
         :'type' => :'SecurityMonitoringRuleTypeTest'
       }
     end
 
+    # List of attributes with nullable: true
+    # @!visibility private
+    def self.openapi_nullable
+      Set.new([
+        :'scheduling_options',
+      ])
+    end
+
     # Initializes the object
     # @param attributes [Hash] Model attributes in the form of hash
     # @!visibility private
@@ -120,6 +138,12 @@ module DatadogAPIClient::V2
         end
       }
 
+      if attributes.key?(:'calculated_fields')
+        if (value = attributes[:'calculated_fields']).is_a?(Array)
+          self.calculated_fields = value
+        end
+      end
+
       if attributes.key?(:'cases')
         if (value = attributes[:'cases']).is_a?(Array)
           self.cases = value
@@ -170,6 +194,10 @@ module DatadogAPIClient::V2
         end
       end
 
+      if attributes.key?(:'scheduling_options')
+        self.scheduling_options = attributes[:'scheduling_options']
+      end
+
       if attributes.key?(:'tags')
         if (value = attributes[:'tags']).is_a?(Array)
           self.tags = value
@@ -286,6 +314,7 @@ module DatadogAPIClient::V2
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          calculated_fields == o.calculated_fields &&
           cases == o.cases &&
           filters == o.filters &&
           group_signals_by == o.group_signals_by &&
@@ -296,6 +325,7 @@ module DatadogAPIClient::V2
           options == o.options &&
           queries == o.queries &&
           reference_tables == o.reference_tables &&
+          scheduling_options == o.scheduling_options &&
           tags == o.tags &&
           third_party_cases == o.third_party_cases &&
           type == o.type &&
@@ -306,7 +336,7 @@ module DatadogAPIClient::V2
     # @return [Integer] Hash code
     # @!visibility private
     def hash
-      [cases, filters, group_signals_by, has_extended_title, is_enabled, message, name, options, queries, reference_tables, tags, third_party_cases, type, additional_properties].hash
+      [calculated_fields, cases, filters, group_signals_by, has_extended_title, is_enabled, message, name, options, queries, reference_tables, scheduling_options, tags, third_party_cases, type, additional_properties].hash
     end
   end
 end

data/lib/datadog_api_client/v2/models/sensitive_data_scanner_text_replacement.rb

@@ -28,6 +28,9 @@ module DatadogAPIClient::V2
     # Required if type == 'replacement_string'.
     attr_accessor :replacement_string
 
+    # Only valid when type == `replacement_string`. When enabled, matches can be unmasked in logs by users with ‘Data Scanner Unmask’ permission. As a security best practice, avoid masking for highly-sensitive, long-lived data.
+    attr_accessor :should_save_match
+
     # Type of the replacement text. None means no replacement.
     # hash means the data will be stubbed. replacement_string means that
     # one can chose a text to replace the data. partial_replacement_from_beginning
@@ -44,6 +47,7 @@ module DatadogAPIClient::V2
       {
         :'number_of_chars' => :'number_of_chars',
         :'replacement_string' => :'replacement_string',
+        :'should_save_match' => :'should_save_match',
         :'type' => :'type'
       }
     end
@@ -54,6 +58,7 @@ module DatadogAPIClient::V2
       {
         :'number_of_chars' => :'Integer',
         :'replacement_string' => :'String',
+        :'should_save_match' => :'Boolean',
         :'type' => :'SensitiveDataScannerTextReplacementType'
       }
     end
@@ -84,6 +89,10 @@ module DatadogAPIClient::V2
         self.replacement_string = attributes[:'replacement_string']
       end
 
+      if attributes.key?(:'should_save_match')
+        self.should_save_match = attributes[:'should_save_match']
+      end
+
       if attributes.key?(:'type')
         self.type = attributes[:'type']
       end
@@ -135,6 +144,7 @@ module DatadogAPIClient::V2
       self.class == o.class &&
           number_of_chars == o.number_of_chars &&
           replacement_string == o.replacement_string &&
+          should_save_match == o.should_save_match &&
           type == o.type &&
           additional_properties == o.additional_properties
     end
@@ -143,7 +153,7 @@ module DatadogAPIClient::V2
     # @return [Integer] Hash code
     # @!visibility private
     def hash
-      [number_of_chars, replacement_string, type, additional_properties].hash
+      [number_of_chars, replacement_string, should_save_match, type, additional_properties].hash
     end
   end
 end