datadog_api_client 2.51.0 → 2.52.0

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

@@ -17,156 +17,49 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V1
-  # A count-based (metric) SLI specification, composed of three parts: the good events formula, the total events formula,
-  # and the underlying queries.
-  class SLOCountDefinition
-    include BaseGenericModel
-
-    # A formula that specifies how to combine the results of multiple queries.
-    attr_reader :good_events_formula
-
-    #
-    attr_reader :queries
-
-    # A formula that specifies how to combine the results of multiple queries.
-    attr_reader :total_events_formula
-
-    attr_accessor :additional_properties
-
-    # Attribute mapping from ruby-style variable name to JSON key.
-    # @!visibility private
-    def self.attribute_map
-      {
-        :'good_events_formula' => :'good_events_formula',
-        :'queries' => :'queries',
-        :'total_events_formula' => :'total_events_formula'
-      }
-    end
-
-    # Attribute type mapping.
-    # @!visibility private
-    def self.openapi_types
-      {
-        :'good_events_formula' => :'SLOFormula',
-        :'queries' => :'Array<SLODataSourceQueryDefinition>',
-        :'total_events_formula' => :'SLOFormula'
-      }
-    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::SLOCountDefinition` initialize method"
+  # A count-based (metric) SLI specification, composed of three parts: the good events formula,
+  # the bad or total events formula, and the underlying queries.
+  # Exactly one of `total_events_formula` or `bad_events_formula` must be provided.
+  module SLOCountDefinition
+    class << self
+      include BaseOneOfModel
+      include BaseOneOfModelNoDiscriminator
+
+      # List of class defined in oneOf (OpenAPI v3)
+      def openapi_one_of
+        [
+          :'SLOCountDefinitionWithTotalEventsFormula',
+          :'SLOCountDefinitionWithBadEventsFormula'
+        ]
       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?(:'good_events_formula')
-        self.good_events_formula = attributes[:'good_events_formula']
-      end
-
-      if attributes.key?(:'queries')
-        if (value = attributes[:'queries']).is_a?(Array)
-          self.queries = value
+      # 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
-      end
-
-      if attributes.key?(:'total_events_formula')
-        self.total_events_formula = attributes[:'total_events_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 @good_events_formula.nil?
-      return false if @queries.nil?
-      return false if @queries.length < 1
-      return false if @total_events_formula.nil?
-      true
-    end
-
-    # Custom attribute writer method with validation
-    # @param good_events_formula [Object] Object to be assigned
-    # @!visibility private
-    def good_events_formula=(good_events_formula)
-      if good_events_formula.nil?
-        fail ArgumentError, 'invalid value for "good_events_formula", good_events_formula cannot be nil.'
-      end
-      @good_events_formula = good_events_formula
-    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
-      if queries.length < 1
-        fail ArgumentError, 'invalid value for "queries", number of items must be greater than or equal to 1.'
-      end
-      @queries = queries
-    end
-
-    # Custom attribute writer method with validation
-    # @param total_events_formula [Object] Object to be assigned
-    # @!visibility private
-    def total_events_formula=(total_events_formula)
-      if total_events_formula.nil?
-        fail ArgumentError, 'invalid value for "total_events_formula", total_events_formula cannot be nil.'
-      end
-      @total_events_formula = total_events_formula
-    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}"))
+        if openapi_one_of.include?(:AnyType)
+          data
+        else
+          self._unparsed = true
+          DatadogAPIClient::UnparsedObject.new(data)
         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 &&
-          good_events_formula == o.good_events_formula &&
-          queries == o.queries &&
-          total_events_formula == o.total_events_formula &&
-          additional_properties == o.additional_properties
-    end
-
-    # Calculates hash code according to all attributes.
-    # @return [Integer] Hash code
-    # @!visibility private
-    def hash
-      [good_events_formula, queries, total_events_formula, additional_properties].hash
     end
   end
 end

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

@@ -0,0 +1,146 @@
+=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
+  # 
+  class SLOCountDefinitionWithBadEventsFormula
+    include BaseGenericModel
+
+    # A formula that specifies how to combine the results of multiple queries.
+    attr_reader :bad_events_formula
+
+    # A formula that specifies how to combine the results of multiple queries.
+    attr_reader :good_events_formula
+
+    #
+    attr_reader :queries
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'bad_events_formula' => :'bad_events_formula',
+        :'good_events_formula' => :'good_events_formula',
+        :'queries' => :'queries'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'bad_events_formula' => :'SLOFormula',
+        :'good_events_formula' => :'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::SLOCountDefinitionWithBadEventsFormula` 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::SLOCountDefinitionWithBadEventsFormula`. 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?(:'bad_events_formula')
+        self.bad_events_formula = attributes[:'bad_events_formula']
+      end
+
+      if attributes.key?(:'good_events_formula')
+        self.good_events_formula = attributes[:'good_events_formula']
+      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 @bad_events_formula.nil?
+      return false if @good_events_formula.nil?
+      return false if @queries.nil?
+      return false if @queries.length < 1
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param bad_events_formula [Object] Object to be assigned
+    # @!visibility private
+    def bad_events_formula=(bad_events_formula)
+      if bad_events_formula.nil?
+        fail ArgumentError, 'invalid value for "bad_events_formula", bad_events_formula cannot be nil.'
+      end
+      @bad_events_formula = bad_events_formula
+    end
+
+    # Custom attribute writer method with validation
+    # @param good_events_formula [Object] Object to be assigned
+    # @!visibility private
+    def good_events_formula=(good_events_formula)
+      if good_events_formula.nil?
+        fail ArgumentError, 'invalid value for "good_events_formula", good_events_formula cannot be nil.'
+      end
+      @good_events_formula = good_events_formula
+    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
+      if queries.length < 1
+        fail ArgumentError, 'invalid value for "queries", number of items must be greater than or equal to 1.'
+      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 &&
+          bad_events_formula == o.bad_events_formula &&
+          good_events_formula == o.good_events_formula &&
+          queries == o.queries
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [bad_events_formula, good_events_formula, queries].hash
+    end
+  end
+end

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

@@ -0,0 +1,146 @@
+=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
+  # 
+  class SLOCountDefinitionWithTotalEventsFormula
+    include BaseGenericModel
+
+    # A formula that specifies how to combine the results of multiple queries.
+    attr_reader :good_events_formula
+
+    #
+    attr_reader :queries
+
+    # A formula that specifies how to combine the results of multiple queries.
+    attr_reader :total_events_formula
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'good_events_formula' => :'good_events_formula',
+        :'queries' => :'queries',
+        :'total_events_formula' => :'total_events_formula'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'good_events_formula' => :'SLOFormula',
+        :'queries' => :'Array<SLODataSourceQueryDefinition>',
+        :'total_events_formula' => :'SLOFormula'
+      }
+    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::SLOCountDefinitionWithTotalEventsFormula` 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::SLOCountDefinitionWithTotalEventsFormula`. 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?(:'good_events_formula')
+        self.good_events_formula = attributes[:'good_events_formula']
+      end
+
+      if attributes.key?(:'queries')
+        if (value = attributes[:'queries']).is_a?(Array)
+          self.queries = value
+        end
+      end
+
+      if attributes.key?(:'total_events_formula')
+        self.total_events_formula = attributes[:'total_events_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 @good_events_formula.nil?
+      return false if @queries.nil?
+      return false if @queries.length < 1
+      return false if @total_events_formula.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param good_events_formula [Object] Object to be assigned
+    # @!visibility private
+    def good_events_formula=(good_events_formula)
+      if good_events_formula.nil?
+        fail ArgumentError, 'invalid value for "good_events_formula", good_events_formula cannot be nil.'
+      end
+      @good_events_formula = good_events_formula
+    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
+      if queries.length < 1
+        fail ArgumentError, 'invalid value for "queries", number of items must be greater than or equal to 1.'
+      end
+      @queries = queries
+    end
+
+    # Custom attribute writer method with validation
+    # @param total_events_formula [Object] Object to be assigned
+    # @!visibility private
+    def total_events_formula=(total_events_formula)
+      if total_events_formula.nil?
+        fail ArgumentError, 'invalid value for "total_events_formula", total_events_formula cannot be nil.'
+      end
+      @total_events_formula = total_events_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 &&
+          good_events_formula == o.good_events_formula &&
+          queries == o.queries &&
+          total_events_formula == o.total_events_formula
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [good_events_formula, queries, total_events_formula].hash
+    end
+  end
+end

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

@@ -21,8 +21,9 @@ module DatadogAPIClient::V1
   class SLOCountSpec
     include BaseGenericModel
 
-    # A count-based (metric) SLI specification, composed of three parts: the good events formula, the total events formula,
-    # and the underlying queries.
+    # A count-based (metric) SLI specification, composed of three parts: the good events formula,
+    # the bad or total events formula, and the underlying queries.
+    # Exactly one of `total_events_formula` or `bad_events_formula` must be provided.
     attr_reader :count
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -21,6 +21,9 @@ module DatadogAPIClient::V1
   class SLOListWidgetDefinition
     include BaseGenericModel
 
+    # The description of the widget.
+    attr_accessor :description
+
     # Array of one request object to display in the widget.
     attr_reader :requests
 
@@ -42,6 +45,7 @@ module DatadogAPIClient::V1
     # @!visibility private
     def self.attribute_map
       {
+        :'description' => :'description',
         :'requests' => :'requests',
         :'title' => :'title',
         :'title_align' => :'title_align',
@@ -54,6 +58,7 @@ module DatadogAPIClient::V1
     # @!visibility private
     def self.openapi_types
       {
+        :'description' => :'String',
         :'requests' => :'Array<SLOListWidgetRequest>',
         :'title' => :'String',
         :'title_align' => :'WidgetTextAlign',
@@ -80,6 +85,10 @@ module DatadogAPIClient::V1
         end
       }
 
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
       if attributes.key?(:'requests')
         if (value = attributes[:'requests']).is_a?(Array)
           self.requests = value
@@ -166,6 +175,7 @@ module DatadogAPIClient::V1
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          description == o.description &&
           requests == o.requests &&
           title == o.title &&
           title_align == o.title_align &&
@@ -178,7 +188,7 @@ module DatadogAPIClient::V1
     # @return [Integer] Hash code
     # @!visibility private
     def hash
-      [requests, title, title_align, title_size, type, additional_properties].hash
+      [description, requests, title, title_align, title_size, type, additional_properties].hash
     end
   end
 end

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

@@ -17,13 +17,16 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V1
-  # Use the SLO and uptime widget to track your SLOs (Service Level Objectives) and uptime on screenboards and timeboards.
+  # Use the SLO and uptime widget to track your SLOs (Service Level Objectives) and uptime on dashboards.
   class SLOWidgetDefinition
     include BaseGenericModel
 
     # Additional filters applied to the SLO query.
     attr_accessor :additional_query_filters
 
+    # The description of the widget.
+    attr_accessor :description
+
     # Defined global time target.
     attr_accessor :global_time_target
 
@@ -61,6 +64,7 @@ module DatadogAPIClient::V1
     def self.attribute_map
       {
         :'additional_query_filters' => :'additional_query_filters',
+        :'description' => :'description',
         :'global_time_target' => :'global_time_target',
         :'show_error_budget' => :'show_error_budget',
         :'slo_id' => :'slo_id',
@@ -79,6 +83,7 @@ module DatadogAPIClient::V1
     def self.openapi_types
       {
         :'additional_query_filters' => :'String',
+        :'description' => :'String',
         :'global_time_target' => :'String',
         :'show_error_budget' => :'Boolean',
         :'slo_id' => :'String',
@@ -114,6 +119,10 @@ module DatadogAPIClient::V1
         self.additional_query_filters = attributes[:'additional_query_filters']
       end
 
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
       if attributes.key?(:'global_time_target')
         self.global_time_target = attributes[:'global_time_target']
       end
@@ -213,6 +222,7 @@ module DatadogAPIClient::V1
       return true if self.equal?(o)
       self.class == o.class &&
           additional_query_filters == o.additional_query_filters &&
+          description == o.description &&
           global_time_target == o.global_time_target &&
           show_error_budget == o.show_error_budget &&
           slo_id == o.slo_id &&
@@ -230,7 +240,7 @@ module DatadogAPIClient::V1
     # @return [Integer] Hash code
     # @!visibility private
     def hash
-      [additional_query_filters, global_time_target, show_error_budget, slo_id, time_windows, title, title_align, title_size, type, view_mode, view_type, additional_properties].hash
+      [additional_query_filters, description, global_time_target, show_error_budget, slo_id, time_windows, title, title_align, title_size, type, view_mode, view_type, additional_properties].hash
     end
   end
 end

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

@@ -24,6 +24,9 @@ module DatadogAPIClient::V1
     # List of custom links.
     attr_accessor :custom_links
 
+    # The description of the widget.
+    attr_accessor :description
+
     # Show the total value in this widget.
     attr_accessor :hide_total
 
@@ -55,6 +58,7 @@ module DatadogAPIClient::V1
     def self.attribute_map
       {
         :'custom_links' => :'custom_links',
+        :'description' => :'description',
         :'hide_total' => :'hide_total',
         :'legend' => :'legend',
         :'requests' => :'requests',
@@ -71,6 +75,7 @@ module DatadogAPIClient::V1
     def self.openapi_types
       {
         :'custom_links' => :'Array<WidgetCustomLink>',
+        :'description' => :'String',
         :'hide_total' => :'Boolean',
         :'legend' => :'SunburstWidgetLegend',
         :'requests' => :'Array<SunburstWidgetRequest>',
@@ -106,6 +111,10 @@ module DatadogAPIClient::V1
         end
       end
 
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
       if attributes.key?(:'hide_total')
         self.hide_total = attributes[:'hide_total']
       end
@@ -201,6 +210,7 @@ module DatadogAPIClient::V1
       return true if self.equal?(o)
       self.class == o.class &&
           custom_links == o.custom_links &&
+          description == o.description &&
           hide_total == o.hide_total &&
           legend == o.legend &&
           requests == o.requests &&
@@ -216,7 +226,7 @@ module DatadogAPIClient::V1
     # @return [Integer] Hash code
     # @!visibility private
     def hash
-      [custom_links, hide_total, legend, requests, time, title, title_align, title_size, type, additional_properties].hash
+      [custom_links, description, hide_total, legend, requests, time, title, title_align, title_size, type, additional_properties].hash
     end
   end
 end