datadog_api_client 2.52.0 → 2.53.0

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

@@ -0,0 +1,144 @@
+=begin
+#Datadog API V2 Collection
+
+#Collection of all Datadog Public endpoints.
+
+The version of the OpenAPI document: 1.0
+Contact: support@datadoghq.com
+Generated by: https://github.com/DataDog/datadog-api-client-ruby/tree/master/.generator
+
+ Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
+ This product includes software developed at Datadog (https://www.datadoghq.com/).
+ Copyright 2020-Present Datadog, Inc.
+
+=end
+
+require 'date'
+require 'time'
+
+module DatadogAPIClient::V2
+  # A unique identifier for an organization including its site.
+  class GlobalOrgIdentifier
+    include BaseGenericModel
+
+    # The site of the organization.
+    attr_reader :org_site
+
+    # The UUID of the organization.
+    attr_reader :org_uuid
+
+    attr_accessor :additional_properties
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'org_site' => :'org_site',
+        :'org_uuid' => :'org_uuid'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'org_site' => :'String',
+        :'org_uuid' => :'UUID'
+      }
+    end
+
+    # Initializes the object
+    # @param attributes [Hash] Model attributes in the form of hash
+    # @!visibility private
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `DatadogAPIClient::V2::GlobalOrgIdentifier` initialize method"
+      end
+
+      self.additional_properties = {}
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          self.additional_properties[k.to_sym] = v
+        else
+          h[k.to_sym] = v
+        end
+      }
+
+      if attributes.key?(:'org_site')
+        self.org_site = attributes[:'org_site']
+      end
+
+      if attributes.key?(:'org_uuid')
+        self.org_uuid = attributes[:'org_uuid']
+      end
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    # @!visibility private
+    def valid?
+      return false if @org_site.nil?
+      return false if @org_uuid.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param org_site [Object] Object to be assigned
+    # @!visibility private
+    def org_site=(org_site)
+      if org_site.nil?
+        fail ArgumentError, 'invalid value for "org_site", org_site cannot be nil.'
+      end
+      @org_site = org_site
+    end
+
+    # Custom attribute writer method with validation
+    # @param org_uuid [Object] Object to be assigned
+    # @!visibility private
+    def org_uuid=(org_uuid)
+      if org_uuid.nil?
+        fail ArgumentError, 'invalid value for "org_uuid", org_uuid cannot be nil.'
+      end
+      @org_uuid = org_uuid
+    end
+
+    # Returns the object in the form of hash, with additionalProperties support.
+    # @return [Hash] Returns the object in the form of hash
+    # @!visibility private
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      self.additional_properties.each_pair do |attr, value|
+        hash[attr] = value
+      end
+      hash
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param o [Object] Object to be compared
+    # @!visibility private
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          org_site == o.org_site &&
+          org_uuid == o.org_uuid &&
+          additional_properties == o.additional_properties
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [org_site, org_uuid, additional_properties].hash
+    end
+  end
+end

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

@@ -0,0 +1,162 @@
+=begin
+#Datadog API V2 Collection
+
+#Collection of all Datadog Public endpoints.
+
+The version of the OpenAPI document: 1.0
+Contact: support@datadoghq.com
+Generated by: https://github.com/DataDog/datadog-api-client-ruby/tree/master/.generator
+
+ Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
+ This product includes software developed at Datadog (https://www.datadoghq.com/).
+ Copyright 2020-Present Datadog, Inc.
+
+=end
+
+require 'date'
+require 'time'
+
+module DatadogAPIClient::V2
+  # Guardrail metric details.
+  class GuardrailMetric
+    include BaseGenericModel
+
+    # The metric ID to monitor.
+    attr_reader :metric_id
+
+    # Action to perform when a guardrail threshold is triggered.
+    attr_reader :trigger_action
+
+    # The signal or system that triggered the action.
+    attr_accessor :triggered_by
+
+    attr_accessor :additional_properties
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'metric_id' => :'metric_id',
+        :'trigger_action' => :'trigger_action',
+        :'triggered_by' => :'triggered_by'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'metric_id' => :'String',
+        :'trigger_action' => :'GuardrailTriggerAction',
+        :'triggered_by' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    # @!visibility private
+    def self.openapi_nullable
+      Set.new([
+        :'triggered_by',
+      ])
+    end
+
+    # Initializes the object
+    # @param attributes [Hash] Model attributes in the form of hash
+    # @!visibility private
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `DatadogAPIClient::V2::GuardrailMetric` initialize method"
+      end
+
+      self.additional_properties = {}
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          self.additional_properties[k.to_sym] = v
+        else
+          h[k.to_sym] = v
+        end
+      }
+
+      if attributes.key?(:'metric_id')
+        self.metric_id = attributes[:'metric_id']
+      end
+
+      if attributes.key?(:'trigger_action')
+        self.trigger_action = attributes[:'trigger_action']
+      end
+
+      if attributes.key?(:'triggered_by')
+        self.triggered_by = attributes[:'triggered_by']
+      end
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    # @!visibility private
+    def valid?
+      return false if @metric_id.nil?
+      return false if @trigger_action.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param metric_id [Object] Object to be assigned
+    # @!visibility private
+    def metric_id=(metric_id)
+      if metric_id.nil?
+        fail ArgumentError, 'invalid value for "metric_id", metric_id cannot be nil.'
+      end
+      @metric_id = metric_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param trigger_action [Object] Object to be assigned
+    # @!visibility private
+    def trigger_action=(trigger_action)
+      if trigger_action.nil?
+        fail ArgumentError, 'invalid value for "trigger_action", trigger_action cannot be nil.'
+      end
+      @trigger_action = trigger_action
+    end
+
+    # Returns the object in the form of hash, with additionalProperties support.
+    # @return [Hash] Returns the object in the form of hash
+    # @!visibility private
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      self.additional_properties.each_pair do |attr, value|
+        hash[attr] = value
+      end
+      hash
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param o [Object] Object to be compared
+    # @!visibility private
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          metric_id == o.metric_id &&
+          trigger_action == o.trigger_action &&
+          triggered_by == o.triggered_by &&
+          additional_properties == o.additional_properties
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [metric_id, trigger_action, triggered_by, additional_properties].hash
+    end
+  end
+end

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

@@ -0,0 +1,144 @@
+=begin
+#Datadog API V2 Collection
+
+#Collection of all Datadog Public endpoints.
+
+The version of the OpenAPI document: 1.0
+Contact: support@datadoghq.com
+Generated by: https://github.com/DataDog/datadog-api-client-ruby/tree/master/.generator
+
+ Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
+ This product includes software developed at Datadog (https://www.datadoghq.com/).
+ Copyright 2020-Present Datadog, Inc.
+
+=end
+
+require 'date'
+require 'time'
+
+module DatadogAPIClient::V2
+  # Guardrail metric request payload.
+  class GuardrailMetricRequest
+    include BaseGenericModel
+
+    # The metric ID to monitor.
+    attr_reader :metric_id
+
+    # Action to perform when a guardrail threshold is triggered.
+    attr_reader :trigger_action
+
+    attr_accessor :additional_properties
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'metric_id' => :'metric_id',
+        :'trigger_action' => :'trigger_action'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'metric_id' => :'String',
+        :'trigger_action' => :'GuardrailTriggerAction'
+      }
+    end
+
+    # Initializes the object
+    # @param attributes [Hash] Model attributes in the form of hash
+    # @!visibility private
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `DatadogAPIClient::V2::GuardrailMetricRequest` initialize method"
+      end
+
+      self.additional_properties = {}
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          self.additional_properties[k.to_sym] = v
+        else
+          h[k.to_sym] = v
+        end
+      }
+
+      if attributes.key?(:'metric_id')
+        self.metric_id = attributes[:'metric_id']
+      end
+
+      if attributes.key?(:'trigger_action')
+        self.trigger_action = attributes[:'trigger_action']
+      end
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    # @!visibility private
+    def valid?
+      return false if @metric_id.nil?
+      return false if @trigger_action.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param metric_id [Object] Object to be assigned
+    # @!visibility private
+    def metric_id=(metric_id)
+      if metric_id.nil?
+        fail ArgumentError, 'invalid value for "metric_id", metric_id cannot be nil.'
+      end
+      @metric_id = metric_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param trigger_action [Object] Object to be assigned
+    # @!visibility private
+    def trigger_action=(trigger_action)
+      if trigger_action.nil?
+        fail ArgumentError, 'invalid value for "trigger_action", trigger_action cannot be nil.'
+      end
+      @trigger_action = trigger_action
+    end
+
+    # Returns the object in the form of hash, with additionalProperties support.
+    # @return [Hash] Returns the object in the form of hash
+    # @!visibility private
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      self.additional_properties.each_pair do |attr, value|
+        hash[attr] = value
+      end
+      hash
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param o [Object] Object to be compared
+    # @!visibility private
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          metric_id == o.metric_id &&
+          trigger_action == o.trigger_action &&
+          additional_properties == o.additional_properties
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [metric_id, trigger_action, additional_properties].hash
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+=begin
+#Datadog API V2 Collection
+
+#Collection of all Datadog Public endpoints.
+
+The version of the OpenAPI document: 1.0
+Contact: support@datadoghq.com
+Generated by: https://github.com/DataDog/datadog-api-client-ruby/tree/master/.generator
+
+ Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
+ This product includes software developed at Datadog (https://www.datadoghq.com/).
+ Copyright 2020-Present Datadog, Inc.
+
+=end
+
+require 'date'
+require 'time'
+
+module DatadogAPIClient::V2
+  # Action to perform when a guardrail threshold is triggered.
+  class GuardrailTriggerAction
+    include BaseEnumModel
+
+    PAUSE = "PAUSE".freeze
+    ABORT = "ABORT".freeze
+  end
+end

data/lib/datadog_api_client/v2/models/{threat_hunting_job_data_type.rb → historical_job_data_type.rb}

@@ -18,7 +18,7 @@ require 'time'
 
 module DatadogAPIClient::V2
   # Type of payload.
-  class ThreatHuntingJobDataType
+  class HistoricalJobDataType
     include BaseEnumModel
 
     HISTORICALDETECTIONSJOB = "historicalDetectionsJob".freeze

data/lib/datadog_api_client/v2/models/{threat_hunting_job_list_meta.rb → historical_job_list_meta.rb}

@@ -18,7 +18,7 @@ require 'time'
 
 module DatadogAPIClient::V2
   # Metadata about the list of jobs.
-  class ThreatHuntingJobListMeta
+  class HistoricalJobListMeta
     include BaseGenericModel
 
     # Number of jobs in the list.
@@ -47,7 +47,7 @@ module DatadogAPIClient::V2
     # @!visibility private
     def initialize(attributes = {})
       if (!attributes.is_a?(Hash))
-        fail ArgumentError, "The input argument (attributes) must be a hash in `DatadogAPIClient::V2::ThreatHuntingJobListMeta` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `DatadogAPIClient::V2::HistoricalJobListMeta` initialize method"
       end
 
       self.additional_properties = {}

data/lib/datadog_api_client/v2/models/{threat_hunting_job_options.rb → historical_job_options.rb}

@@ -18,7 +18,7 @@ require 'time'
 
 module DatadogAPIClient::V2
   # Job options.
-  class ThreatHuntingJobOptions
+  class HistoricalJobOptions
     include BaseGenericModel
 
     # Options on anomaly detection method.
@@ -90,7 +90,7 @@ module DatadogAPIClient::V2
     # @!visibility private
     def initialize(attributes = {})
       if (!attributes.is_a?(Hash))
-        fail ArgumentError, "The input argument (attributes) must be a hash in `DatadogAPIClient::V2::ThreatHuntingJobOptions` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `DatadogAPIClient::V2::HistoricalJobOptions` initialize method"
       end
 
       self.additional_properties = {}

data/lib/datadog_api_client/v2/models/{threat_hunting_job_query.rb → historical_job_query.rb}

@@ -17,14 +17,14 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V2
-  # Query for selecting logs analyzed by the threat hunting job.
-  class ThreatHuntingJobQuery
+  # Query for selecting logs analyzed by the historical job.
+  class HistoricalJobQuery
     include BaseGenericModel
 
     # The aggregation type.
     attr_accessor :aggregation
 
-    # Source of events, either logs, audit trail, or Datadog events. `app_sec_spans` is deprecated in favor of `spans`.
+    # Source of events, either logs, audit trail, security signals, or Datadog events. `app_sec_spans` is deprecated in favor of `spans`.
     attr_accessor :data_source
 
     # Field for which the cardinality is measured. Sent as an array.
@@ -82,7 +82,7 @@ module DatadogAPIClient::V2
     # @!visibility private
     def initialize(attributes = {})
       if (!attributes.is_a?(Hash))
-        fail ArgumentError, "The input argument (attributes) must be a hash in `DatadogAPIClient::V2::ThreatHuntingJobQuery` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `DatadogAPIClient::V2::HistoricalJobQuery` initialize method"
       end
 
       self.additional_properties = {}

data/lib/datadog_api_client/v2/models/{threat_hunting_job_response.rb → historical_job_response.rb}

@@ -17,11 +17,11 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V2
-  # Threat hunting job response.
-  class ThreatHuntingJobResponse
+  # Historical job response.
+  class HistoricalJobResponse
     include BaseGenericModel
 
-    # Threat hunting job response data.
+    # Historical job response data.
     attr_accessor :data
 
     attr_accessor :additional_properties
@@ -38,7 +38,7 @@ module DatadogAPIClient::V2
     # @!visibility private
     def self.openapi_types
       {
-        :'data' => :'ThreatHuntingJobResponseData'
+        :'data' => :'HistoricalJobResponseData'
       }
     end
 
@@ -47,7 +47,7 @@ module DatadogAPIClient::V2
     # @!visibility private
     def initialize(attributes = {})
       if (!attributes.is_a?(Hash))
-        fail ArgumentError, "The input argument (attributes) must be a hash in `DatadogAPIClient::V2::ThreatHuntingJobResponse` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `DatadogAPIClient::V2::HistoricalJobResponse` initialize method"
       end
 
       self.additional_properties = {}

data/lib/datadog_api_client/v2/models/{threat_hunting_job_response_attributes.rb → historical_job_response_attributes.rb}

@@ -17,8 +17,8 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V2
-  # Threat hunting job attributes.
-  class ThreatHuntingJobResponseAttributes
+  # Historical job attributes.
+  class HistoricalJobResponseAttributes
     include BaseGenericModel
 
     # Time when the job was created.
@@ -33,7 +33,7 @@ module DatadogAPIClient::V2
     # ID of the rule used to create the job (if it is created from a rule).
     attr_accessor :created_from_rule_id
 
-    # Definition of a threat hunting job.
+    # Definition of a historical job.
     attr_accessor :job_definition
 
     # Job name.
@@ -87,7 +87,7 @@ module DatadogAPIClient::V2
     # @!visibility private
     def initialize(attributes = {})
       if (!attributes.is_a?(Hash))
-        fail ArgumentError, "The input argument (attributes) must be a hash in `DatadogAPIClient::V2::ThreatHuntingJobResponseAttributes` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `DatadogAPIClient::V2::HistoricalJobResponseAttributes` initialize method"
       end
 
       self.additional_properties = {}

data/lib/datadog_api_client/v2/models/{threat_hunting_job_response_data.rb → historical_job_response_data.rb}

@@ -17,11 +17,11 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V2
-  # Threat hunting job response data.
-  class ThreatHuntingJobResponseData
+  # Historical job response data.
+  class HistoricalJobResponseData
     include BaseGenericModel
 
-    # Threat hunting job attributes.
+    # Historical job attributes.
     attr_accessor :attributes
 
     # ID of the job.
@@ -46,9 +46,9 @@ module DatadogAPIClient::V2
     # @!visibility private
     def self.openapi_types
       {
-        :'attributes' => :'ThreatHuntingJobResponseAttributes',
+        :'attributes' => :'HistoricalJobResponseAttributes',
         :'id' => :'String',
-        :'type' => :'ThreatHuntingJobDataType'
+        :'type' => :'HistoricalJobDataType'
       }
     end
 
@@ -57,7 +57,7 @@ module DatadogAPIClient::V2
     # @!visibility private
     def initialize(attributes = {})
       if (!attributes.is_a?(Hash))
-        fail ArgumentError, "The input argument (attributes) must be a hash in `DatadogAPIClient::V2::ThreatHuntingJobResponseData` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `DatadogAPIClient::V2::HistoricalJobResponseData` initialize method"
       end
 
       self.additional_properties = {}