datadog_api_client 2.18.0 → 2.20.0

data/lib/datadog_api_client/v1/models/slo_formula.rb

@@ -0,0 +1,98 @@
+=begin
+#Datadog API V1 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::V1
+  # A formula that specifies how to combine the results of multiple queries.
+  class SLOFormula
+    include BaseGenericModel
+
+    # The formula string, which is an expression involving named queries.
+    attr_reader :formula
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'formula' => :'formula'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'formula' => :'String'
+      }
+    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::V1::SLOFormula` initialize method"
+      end
+
+      # 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))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `DatadogAPIClient::V1::SLOFormula`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'formula')
+        self.formula = attributes[:'formula']
+      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 @formula.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param formula [Object] Object to be assigned
+    # @!visibility private
+    def formula=(formula)
+      if formula.nil?
+        fail ArgumentError, 'invalid value for "formula", formula cannot be nil.'
+      end
+      @formula = formula
+    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 &&
+          formula == o.formula
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [formula].hash
+    end
+  end
+end

data/lib/datadog_api_client/v1/models/slo_history_metrics.rb

@@ -23,7 +23,7 @@ module DatadogAPIClient::V1
   class SLOHistoryMetrics
     include BaseGenericModel
 
-    # A representation of `metric` based SLO time series for the provided queries.
+    # A representation of `metric` based SLO timeseries for the provided queries.
     # This is the same response type from `batch_query` endpoint.
     attr_reader :denominator
 
@@ -33,7 +33,7 @@ module DatadogAPIClient::V1
     # Optional message if there are specific query issues/warnings.
     attr_accessor :message
 
-    # A representation of `metric` based SLO time series for the provided queries.
+    # A representation of `metric` based SLO timeseries for the provided queries.
     # This is the same response type from `batch_query` endpoint.
     attr_reader :numerator
 

data/lib/datadog_api_client/v1/models/slo_history_metrics_series.rb

@@ -17,7 +17,7 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V1
-  # A representation of `metric` based SLO time series for the provided queries.
+  # A representation of `metric` based SLO timeseries for the provided queries.
   # This is the same response type from `batch_query` endpoint.
   class SLOHistoryMetricsSeries
     include BaseGenericModel

data/lib/datadog_api_client/v1/models/slo_history_monitor.rb

@@ -31,7 +31,7 @@ module DatadogAPIClient::V1
     # For groups in a grouped SLO, this is the group name.
     attr_accessor :group
 
-    # For `monitor` based SLOs, this includes the aggregated history as arrays that include time series and uptime data where `0=monitor` is in `OK` state and `1=monitor` is in `alert` state.
+    # For `monitor` based SLOs, this includes the aggregated history as arrays that include timeseries and uptime data where `0=monitor` is in `OK` state and `1=monitor` is in `alert` state.
     attr_accessor :history
 
     # For `monitor` based SLOs, this is the last modified timestamp in epoch seconds of the monitor.

data/lib/datadog_api_client/v1/models/slo_history_sli_data.rb

@@ -31,7 +31,7 @@ module DatadogAPIClient::V1
     # For groups in a grouped SLO, this is the group name.
     attr_accessor :group
 
-    # For `monitor` based SLOs, this includes the aggregated history as arrays that include time series and uptime data where `0=monitor` is in `OK` state and `1=monitor` is in `alert` state.
+    # For `monitor` based SLOs, this includes the aggregated history as arrays that include timeseries and uptime data where `0=monitor` is in `OK` state and `1=monitor` is in `alert` state.
     attr_accessor :history
 
     # For `monitor` based SLOs, this is the last modified timestamp in epoch seconds of the monitor.

data/lib/datadog_api_client/v1/models/slo_response_data.rb

@@ -76,6 +76,9 @@ module DatadogAPIClient::V1
     # min of all of those requests.
     attr_accessor :query
 
+    # A generic SLI specification. This is currently used for time-slice SLOs only.
+    attr_accessor :sli_specification
+
     # A list of tags associated with this service level objective.
     # Always included in service level objective responses (but may be empty).
     # Optional in create/update requests.
@@ -116,6 +119,7 @@ module DatadogAPIClient::V1
         :'monitor_tags' => :'monitor_tags',
         :'name' => :'name',
         :'query' => :'query',
+        :'sli_specification' => :'sli_specification',
         :'tags' => :'tags',
         :'target_threshold' => :'target_threshold',
         :'thresholds' => :'thresholds',
@@ -140,6 +144,7 @@ module DatadogAPIClient::V1
         :'monitor_tags' => :'Array<String>',
         :'name' => :'String',
         :'query' => :'ServiceLevelObjectiveQuery',
+        :'sli_specification' => :'SLOSliSpec',
         :'tags' => :'Array<String>',
         :'target_threshold' => :'Float',
         :'thresholds' => :'Array<SLOThreshold>',
@@ -225,6 +230,10 @@ module DatadogAPIClient::V1
         self.query = attributes[:'query']
       end
 
+      if attributes.key?(:'sli_specification')
+        self.sli_specification = attributes[:'sli_specification']
+      end
+
       if attributes.key?(:'tags')
         if (value = attributes[:'tags']).is_a?(Array)
           self.tags = value
@@ -271,6 +280,7 @@ module DatadogAPIClient::V1
           monitor_tags == o.monitor_tags &&
           name == o.name &&
           query == o.query &&
+          sli_specification == o.sli_specification &&
           tags == o.tags &&
           target_threshold == o.target_threshold &&
           thresholds == o.thresholds &&
@@ -283,7 +293,7 @@ module DatadogAPIClient::V1
     # @return [Integer] Hash code
     # @!visibility private
     def hash
-      [configured_alert_ids, created_at, creator, description, groups, id, modified_at, monitor_ids, monitor_tags, name, query, tags, target_threshold, thresholds, timeframe, type, warning_threshold].hash
+      [configured_alert_ids, created_at, creator, description, groups, id, modified_at, monitor_ids, monitor_tags, name, query, sli_specification, tags, target_threshold, thresholds, timeframe, type, warning_threshold].hash
     end
   end
 end

data/lib/datadog_api_client/v1/models/slo_sli_spec.rb

@@ -0,0 +1,62 @@
+=begin
+#Datadog API V1 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::V1
+  # A generic SLI specification. This is currently used for time-slice SLOs only.
+  module SLOSliSpec
+    class << self
+      include BaseOneOfModel
+      include BaseOneOfModelNoDiscriminator
+
+      # List of class defined in oneOf (OpenAPI v3)
+      def openapi_one_of
+        [
+          :'SLOTimeSliceSpec'
+        ]
+      end
+      # Builds the object
+      # @param data [Mixed] Data to be matched against the list of oneOf items
+      # @return [Object] Returns the model or the data itself
+      def build(data)
+        # Go through the list of oneOf items and attempt to identify the appropriate one.
+        # Note:
+        # - We do not attempt to check whether exactly one item matches.
+        # - No advanced validation of types in some cases (e.g. "x: { type: string }" will happily match { x: 123 })
+        #   due to the way the deserialization is made in the base_object template (it just casts without verifying).
+        # - TODO: scalar values are de facto behaving as if they were nullable.
+        # - TODO: logging when debugging is set.
+        openapi_one_of.each do |klass|
+          begin
+            next if klass == :AnyType # "nullable: true"
+            typed_data = find_and_cast_into_type(klass, data)
+            next if typed_data.respond_to?(:_unparsed) && typed_data._unparsed
+            return typed_data if typed_data
+          rescue # rescue all errors so we keep iterating even if the current item lookup raises
+          end
+        end
+
+        if openapi_one_of.include?(:AnyType)
+          data
+        else
+          self._unparsed = true
+          DatadogAPIClient::UnparsedObject.new(data)
+        end
+      end
+    end
+  end
+end

data/lib/datadog_api_client/v1/models/slo_time_slice_comparator.rb

@@ -0,0 +1,29 @@
+=begin
+#Datadog API V1 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::V1
+  # The comparator used to compare the SLI value to the threshold.
+  class SLOTimeSliceComparator
+    include BaseEnumModel
+
+    GREATER = ">".freeze
+    GREATER_EQUAL = ">=".freeze
+    LESS = "<".freeze
+    LESS_EQUAL = "<=".freeze
+  end
+end

data/lib/datadog_api_client/v1/models/slo_time_slice_condition.rb

@@ -0,0 +1,141 @@
+=begin
+#Datadog API V1 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::V1
+  # The time-slice condition, composed of 3 parts: 1. the metric timeseries query, 2. the comparator,
+  # and 3. the threshold.
+  class SLOTimeSliceCondition
+    include BaseGenericModel
+
+    # The comparator used to compare the SLI value to the threshold.
+    attr_reader :comparator
+
+    # The queries and formula used to calculate the SLI value.
+    attr_reader :query
+
+    # The threshold value to which each SLI value will be compared.
+    attr_reader :threshold
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'comparator' => :'comparator',
+        :'query' => :'query',
+        :'threshold' => :'threshold'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'comparator' => :'SLOTimeSliceComparator',
+        :'query' => :'SLOTimeSliceQuery',
+        :'threshold' => :'Float'
+      }
+    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::V1::SLOTimeSliceCondition` initialize method"
+      end
+
+      # 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))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `DatadogAPIClient::V1::SLOTimeSliceCondition`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'comparator')
+        self.comparator = attributes[:'comparator']
+      end
+
+      if attributes.key?(:'query')
+        self.query = attributes[:'query']
+      end
+
+      if attributes.key?(:'threshold')
+        self.threshold = attributes[:'threshold']
+      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 @comparator.nil?
+      return false if @query.nil?
+      return false if @threshold.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param comparator [Object] Object to be assigned
+    # @!visibility private
+    def comparator=(comparator)
+      if comparator.nil?
+        fail ArgumentError, 'invalid value for "comparator", comparator cannot be nil.'
+      end
+      @comparator = comparator
+    end
+
+    # Custom attribute writer method with validation
+    # @param query [Object] Object to be assigned
+    # @!visibility private
+    def query=(query)
+      if query.nil?
+        fail ArgumentError, 'invalid value for "query", query cannot be nil.'
+      end
+      @query = query
+    end
+
+    # Custom attribute writer method with validation
+    # @param threshold [Object] Object to be assigned
+    # @!visibility private
+    def threshold=(threshold)
+      if threshold.nil?
+        fail ArgumentError, 'invalid value for "threshold", threshold cannot be nil.'
+      end
+      @threshold = threshold
+    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 &&
+          comparator == o.comparator &&
+          query == o.query &&
+          threshold == o.threshold
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [comparator, query, threshold].hash
+    end
+  end
+end

data/lib/datadog_api_client/v1/models/slo_time_slice_query.rb

@@ -0,0 +1,131 @@
+=begin
+#Datadog API V1 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::V1
+  # The queries and formula used to calculate the SLI value.
+  class SLOTimeSliceQuery
+    include BaseGenericModel
+
+    # A list that contains exactly one formula, as only a single formula may be used in a time-slice SLO.
+    attr_reader :formulas
+
+    # A list of queries that are used to calculate the SLI value.
+    attr_reader :queries
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'formulas' => :'formulas',
+        :'queries' => :'queries'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'formulas' => :'Array<SLOFormula>',
+        :'queries' => :'Array<SLODataSourceQueryDefinition>'
+      }
+    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::V1::SLOTimeSliceQuery` initialize method"
+      end
+
+      # 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))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `DatadogAPIClient::V1::SLOTimeSliceQuery`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'formulas')
+        if (value = attributes[:'formulas']).is_a?(Array)
+          self.formulas = value
+        end
+      end
+
+      if attributes.key?(:'queries')
+        if (value = attributes[:'queries']).is_a?(Array)
+          self.queries = value
+        end
+      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 @formulas.nil?
+      return false if @formulas.length > 1
+      return false if @formulas.length < 1
+      return false if @queries.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param formulas [Object] Object to be assigned
+    # @!visibility private
+    def formulas=(formulas)
+      if formulas.nil?
+        fail ArgumentError, 'invalid value for "formulas", formulas cannot be nil.'
+      end
+      if formulas.length > 1
+        fail ArgumentError, 'invalid value for "formulas", number of items must be less than or equal to 1.'
+      end
+      if formulas.length < 1
+        fail ArgumentError, 'invalid value for "formulas", number of items must be greater than or equal to 1.'
+      end
+      @formulas = formulas
+    end
+
+    # Custom attribute writer method with validation
+    # @param queries [Object] Object to be assigned
+    # @!visibility private
+    def queries=(queries)
+      if queries.nil?
+        fail ArgumentError, 'invalid value for "queries", queries cannot be nil.'
+      end
+      @queries = queries
+    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 &&
+          formulas == o.formulas &&
+          queries == o.queries
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [formulas, queries].hash
+    end
+  end
+end

data/lib/datadog_api_client/v1/models/slo_time_slice_spec.rb

@@ -0,0 +1,99 @@
+=begin
+#Datadog API V1 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::V1
+  # A time-slice SLI specification.
+  class SLOTimeSliceSpec
+    include BaseGenericModel
+
+    # The time-slice condition, composed of 3 parts: 1. the metric timeseries query, 2. the comparator,
+    # and 3. the threshold.
+    attr_reader :time_slice
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'time_slice' => :'time_slice'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'time_slice' => :'SLOTimeSliceCondition'
+      }
+    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::V1::SLOTimeSliceSpec` initialize method"
+      end
+
+      # 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))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `DatadogAPIClient::V1::SLOTimeSliceSpec`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'time_slice')
+        self.time_slice = attributes[:'time_slice']
+      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 @time_slice.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param time_slice [Object] Object to be assigned
+    # @!visibility private
+    def time_slice=(time_slice)
+      if time_slice.nil?
+        fail ArgumentError, 'invalid value for "time_slice", time_slice cannot be nil.'
+      end
+      @time_slice = time_slice
+    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 &&
+          time_slice == o.time_slice
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [time_slice].hash
+    end
+  end
+end

data/lib/datadog_api_client/v1/models/slo_type.rb

@@ -23,5 +23,6 @@ module DatadogAPIClient::V1
 
     METRIC = "metric".freeze
     MONITOR = "monitor".freeze
+    TIME_SLICE = "time_slice".freeze
   end
 end

data/lib/datadog_api_client/v1/models/slo_type_numeric.rb

@@ -25,5 +25,6 @@ module DatadogAPIClient::V1
 
     MONITOR = 0.freeze
     METRIC = 1.freeze
+    TIME_SLICE = 2.freeze
   end
 end