datadog_api_client 2.51.0 → 2.52.0

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

@@ -26,6 +26,9 @@ module DatadogAPIClient::V1
     # A list of custom links.
     attr_accessor :custom_links
 
+    # The description of the widget.
+    attr_accessor :description
+
     # (Deprecated) The widget legend was replaced by a tooltip and sidebar.
     attr_accessor :legend_size
 
@@ -69,6 +72,7 @@ module DatadogAPIClient::V1
     def self.attribute_map
       {
         :'custom_links' => :'custom_links',
+        :'description' => :'description',
         :'legend_size' => :'legend_size',
         :'markers' => :'markers',
         :'requests' => :'requests',
@@ -88,6 +92,7 @@ module DatadogAPIClient::V1
     def self.openapi_types
       {
         :'custom_links' => :'Array<WidgetCustomLink>',
+        :'description' => :'String',
         :'legend_size' => :'String',
         :'markers' => :'Array<WidgetMarker>',
         :'requests' => :'Array<DistributionWidgetRequest>',
@@ -126,6 +131,10 @@ module DatadogAPIClient::V1
         end
       end
 
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
       if attributes.key?(:'legend_size')
         self.legend_size = attributes[:'legend_size']
       end
@@ -239,6 +248,7 @@ module DatadogAPIClient::V1
       return true if self.equal?(o)
       self.class == o.class &&
           custom_links == o.custom_links &&
+          description == o.description &&
           legend_size == o.legend_size &&
           markers == o.markers &&
           requests == o.requests &&
@@ -257,7 +267,7 @@ module DatadogAPIClient::V1
     # @return [Integer] Hash code
     # @!visibility private
     def hash
-      [custom_links, legend_size, markers, requests, show_legend, time, title, title_align, title_size, type, xaxis, yaxis, additional_properties].hash
+      [custom_links, description, legend_size, markers, requests, show_legend, time, title, title_align, title_size, type, xaxis, yaxis, additional_properties].hash
     end
   end
 end

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

@@ -22,6 +22,9 @@ module DatadogAPIClient::V1
   class EventStreamWidgetDefinition
     include BaseGenericModel
 
+    # The description of the widget.
+    attr_accessor :description
+
     # Size to use to display an event.
     attr_accessor :event_size
 
@@ -52,6 +55,7 @@ module DatadogAPIClient::V1
     # @!visibility private
     def self.attribute_map
       {
+        :'description' => :'description',
         :'event_size' => :'event_size',
         :'query' => :'query',
         :'tags_execution' => :'tags_execution',
@@ -67,6 +71,7 @@ module DatadogAPIClient::V1
     # @!visibility private
     def self.openapi_types
       {
+        :'description' => :'String',
         :'event_size' => :'WidgetEventSize',
         :'query' => :'String',
         :'tags_execution' => :'String',
@@ -96,6 +101,10 @@ module DatadogAPIClient::V1
         end
       }
 
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
       if attributes.key?(:'event_size')
         self.event_size = attributes[:'event_size']
       end
@@ -184,6 +193,7 @@ module DatadogAPIClient::V1
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          description == o.description &&
           event_size == o.event_size &&
           query == o.query &&
           tags_execution == o.tags_execution &&
@@ -199,7 +209,7 @@ module DatadogAPIClient::V1
     # @return [Integer] Hash code
     # @!visibility private
     def hash
-      [event_size, query, tags_execution, time, title, title_align, title_size, type, additional_properties].hash
+      [description, event_size, query, tags_execution, time, title, title_align, title_size, type, additional_properties].hash
     end
   end
 end

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

@@ -21,6 +21,9 @@ module DatadogAPIClient::V1
   class EventTimelineWidgetDefinition
     include BaseGenericModel
 
+    # The description of the widget.
+    attr_accessor :description
+
     # Query to filter the event timeline with.
     attr_reader :query
 
@@ -48,6 +51,7 @@ module DatadogAPIClient::V1
     # @!visibility private
     def self.attribute_map
       {
+        :'description' => :'description',
         :'query' => :'query',
         :'tags_execution' => :'tags_execution',
         :'time' => :'time',
@@ -62,6 +66,7 @@ module DatadogAPIClient::V1
     # @!visibility private
     def self.openapi_types
       {
+        :'description' => :'String',
         :'query' => :'String',
         :'tags_execution' => :'String',
         :'time' => :'WidgetTime',
@@ -90,6 +95,10 @@ module DatadogAPIClient::V1
         end
       }
 
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
       if attributes.key?(:'query')
         self.query = attributes[:'query']
       end
@@ -174,6 +183,7 @@ module DatadogAPIClient::V1
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          description == o.description &&
           query == o.query &&
           tags_execution == o.tags_execution &&
           time == o.time &&
@@ -188,7 +198,7 @@ module DatadogAPIClient::V1
     # @return [Integer] Hash code
     # @!visibility private
     def hash
-      [query, tags_execution, time, title, title_align, title_size, type, additional_properties].hash
+      [description, query, tags_execution, time, title, title_align, title_size, type, additional_properties].hash
     end
   end
 end

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

@@ -0,0 +1,63 @@
+=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 type of aggregation that can be performed on events-based queries.
+  module EventsAggregation
+    class << self
+      include BaseOneOfModel
+      include BaseOneOfModelNoDiscriminator
+
+      # List of class defined in oneOf (OpenAPI v3)
+      def openapi_one_of
+        [
+          :'EventsAggregationValue',
+          :'String'
+        ]
+      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/events_aggregation_value.rb

@@ -0,0 +1,36 @@
+=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
+  # Standard aggregation types for events-based queries.
+  class EventsAggregationValue
+    include BaseEnumModel
+
+    AVG = "avg".freeze
+    CARDINALITY = "cardinality".freeze
+    COUNT = "count".freeze
+    DELTA = "delta".freeze
+    EARLIEST = "earliest".freeze
+    LATEST = "latest".freeze
+    MAX = "max".freeze
+    MEDIAN = "median".freeze
+    MIN = "min".freeze
+    MOST_FREQUENT = "most_frequent".freeze
+    SUM = "sum".freeze
+  end
+end

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

@@ -0,0 +1,41 @@
+=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
+  # APM metric stat name.
+  class FormulaAndFunctionApmMetricStatName
+    include BaseEnumModel
+
+    ERRORS = "errors".freeze
+    ERROR_RATE = "error_rate".freeze
+    ERRORS_PER_SECOND = "errors_per_second".freeze
+    LATENCY_AVG = "latency_avg".freeze
+    LATENCY_MAX = "latency_max".freeze
+    LATENCY_P50 = "latency_p50".freeze
+    LATENCY_P75 = "latency_p75".freeze
+    LATENCY_P90 = "latency_p90".freeze
+    LATENCY_P95 = "latency_p95".freeze
+    LATENCY_P99 = "latency_p99".freeze
+    LATENCY_P999 = "latency_p999".freeze
+    LATENCY_DISTRIBUTION = "latency_distribution".freeze
+    HITS = "hits".freeze
+    HITS_PER_SECOND = "hits_per_second".freeze
+    TOTAL_TIME = "total_time".freeze
+    APDEX = "apdex".freeze
+  end
+end

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

@@ -0,0 +1,26 @@
+=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
+  # Data source for APM metrics queries.
+  class FormulaAndFunctionApmMetricsDataSource
+    include BaseEnumModel
+
+    APM_METRICS = "apm_metrics".freeze
+  end
+end

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

@@ -0,0 +1,259 @@
+=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 and functions APM metrics query.
+  class FormulaAndFunctionApmMetricsQueryDefinition
+    include BaseGenericModel
+
+    # Data source for APM metrics queries.
+    attr_reader :data_source
+
+    # Optional fields to group the query results by.
+    attr_accessor :group_by
+
+    # Name of this query to use in formulas.
+    attr_reader :name
+
+    # Optional operation mode to aggregate across operation names.
+    attr_accessor :operation_mode
+
+    # Name of operation on service. If not provided, the primary operation name is used.
+    attr_accessor :operation_name
+
+    # Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.).
+    attr_accessor :peer_tags
+
+    # Additional filters for the query using metrics query syntax (e.g., env, primary_tag).
+    attr_accessor :query_filter
+
+    # The hash of a specific resource to filter by.
+    attr_accessor :resource_hash
+
+    # The full name of a specific resource to filter by.
+    attr_accessor :resource_name
+
+    # APM service name.
+    attr_accessor :service
+
+    # Describes the relationship between the span, its parents, and its children in a trace.
+    attr_accessor :span_kind
+
+    # APM metric stat name.
+    attr_reader :stat
+
+    attr_accessor :additional_properties
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'data_source' => :'data_source',
+        :'group_by' => :'group_by',
+        :'name' => :'name',
+        :'operation_mode' => :'operation_mode',
+        :'operation_name' => :'operation_name',
+        :'peer_tags' => :'peer_tags',
+        :'query_filter' => :'query_filter',
+        :'resource_hash' => :'resource_hash',
+        :'resource_name' => :'resource_name',
+        :'service' => :'service',
+        :'span_kind' => :'span_kind',
+        :'stat' => :'stat'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'data_source' => :'FormulaAndFunctionApmMetricsDataSource',
+        :'group_by' => :'Array<String>',
+        :'name' => :'String',
+        :'operation_mode' => :'String',
+        :'operation_name' => :'String',
+        :'peer_tags' => :'Array<String>',
+        :'query_filter' => :'String',
+        :'resource_hash' => :'String',
+        :'resource_name' => :'String',
+        :'service' => :'String',
+        :'span_kind' => :'FormulaAndFunctionApmMetricsSpanKind',
+        :'stat' => :'FormulaAndFunctionApmMetricStatName'
+      }
+    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::FormulaAndFunctionApmMetricsQueryDefinition` 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?(:'data_source')
+        self.data_source = attributes[:'data_source']
+      end
+
+      if attributes.key?(:'group_by')
+        if (value = attributes[:'group_by']).is_a?(Array)
+          self.group_by = value
+        end
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'operation_mode')
+        self.operation_mode = attributes[:'operation_mode']
+      end
+
+      if attributes.key?(:'operation_name')
+        self.operation_name = attributes[:'operation_name']
+      end
+
+      if attributes.key?(:'peer_tags')
+        if (value = attributes[:'peer_tags']).is_a?(Array)
+          self.peer_tags = value
+        end
+      end
+
+      if attributes.key?(:'query_filter')
+        self.query_filter = attributes[:'query_filter']
+      end
+
+      if attributes.key?(:'resource_hash')
+        self.resource_hash = attributes[:'resource_hash']
+      end
+
+      if attributes.key?(:'resource_name')
+        self.resource_name = attributes[:'resource_name']
+      end
+
+      if attributes.key?(:'service')
+        self.service = attributes[:'service']
+      end
+
+      if attributes.key?(:'span_kind')
+        self.span_kind = attributes[:'span_kind']
+      end
+
+      if attributes.key?(:'stat')
+        self.stat = attributes[:'stat']
+      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 @data_source.nil?
+      return false if @name.nil?
+      return false if @stat.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param data_source [Object] Object to be assigned
+    # @!visibility private
+    def data_source=(data_source)
+      if data_source.nil?
+        fail ArgumentError, 'invalid value for "data_source", data_source cannot be nil.'
+      end
+      @data_source = data_source
+    end
+
+    # Custom attribute writer method with validation
+    # @param name [Object] Object to be assigned
+    # @!visibility private
+    def name=(name)
+      if name.nil?
+        fail ArgumentError, 'invalid value for "name", name cannot be nil.'
+      end
+      @name = name
+    end
+
+    # Custom attribute writer method with validation
+    # @param stat [Object] Object to be assigned
+    # @!visibility private
+    def stat=(stat)
+      if stat.nil?
+        fail ArgumentError, 'invalid value for "stat", stat cannot be nil.'
+      end
+      @stat = stat
+    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 &&
+          data_source == o.data_source &&
+          group_by == o.group_by &&
+          name == o.name &&
+          operation_mode == o.operation_mode &&
+          operation_name == o.operation_name &&
+          peer_tags == o.peer_tags &&
+          query_filter == o.query_filter &&
+          resource_hash == o.resource_hash &&
+          resource_name == o.resource_name &&
+          service == o.service &&
+          span_kind == o.span_kind &&
+          stat == o.stat &&
+          additional_properties == o.additional_properties
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [data_source, group_by, name, operation_mode, operation_name, peer_tags, query_filter, resource_hash, resource_name, service, span_kind, stat, additional_properties].hash
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+=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
+  # Describes the relationship between the span, its parents, and its children in a trace.
+  class FormulaAndFunctionApmMetricsSpanKind
+    include BaseEnumModel
+
+    CONSUMER = "consumer".freeze
+    SERVER = "server".freeze
+    CLIENT = "client".freeze
+    PRODUCER = "producer".freeze
+    INTERNAL = "internal".freeze
+  end
+end

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

@@ -31,6 +31,7 @@ module DatadogAPIClient::V1
           :'FormulaAndFunctionProcessQueryDefinition',
           :'FormulaAndFunctionApmDependencyStatsQueryDefinition',
           :'FormulaAndFunctionApmResourceStatsQueryDefinition',
+          :'FormulaAndFunctionApmMetricsQueryDefinition',
           :'FormulaAndFunctionSLOQueryDefinition',
           :'FormulaAndFunctionCloudCostQueryDefinition'
         ]

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

@@ -17,10 +17,13 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V1
-  # Free text is a widget that allows you to add headings to your screenboard. Commonly used to state the overall purpose of the dashboard. Only available on FREE layout dashboards.
+  # Free text is a widget that allows you to add headings to your dashboard. Commonly used to state the overall purpose of the dashboard.
   class FreeTextWidgetDefinition
     include BaseGenericModel
 
+    # Background color of the widget. Supported values are `white`, `blue`, `purple`, `pink`, `orange`, `yellow`, `green`, `gray`, `vivid_blue`, `vivid_purple`, `vivid_pink`, `vivid_orange`, `vivid_yellow`, `vivid_green`, and `transparent`.
+    attr_accessor :background_color
+
     # Color of the text.
     attr_accessor :color
 
@@ -42,6 +45,7 @@ module DatadogAPIClient::V1
     # @!visibility private
     def self.attribute_map
       {
+        :'background_color' => :'background_color',
         :'color' => :'color',
         :'font_size' => :'font_size',
         :'text' => :'text',
@@ -54,6 +58,7 @@ module DatadogAPIClient::V1
     # @!visibility private
     def self.openapi_types
       {
+        :'background_color' => :'String',
         :'color' => :'String',
         :'font_size' => :'String',
         :'text' => :'String',
@@ -80,6 +85,10 @@ module DatadogAPIClient::V1
         end
       }
 
+      if attributes.key?(:'background_color')
+        self.background_color = attributes[:'background_color']
+      end
+
       if attributes.key?(:'color')
         self.color = attributes[:'color']
       end
@@ -156,6 +165,7 @@ module DatadogAPIClient::V1
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          background_color == o.background_color &&
           color == o.color &&
           font_size == o.font_size &&
           text == o.text &&
@@ -168,7 +178,7 @@ module DatadogAPIClient::V1
     # @return [Integer] Hash code
     # @!visibility private
     def hash
-      [color, font_size, text, text_align, type, additional_properties].hash
+      [background_color, color, font_size, text, text_align, type, additional_properties].hash
     end
   end
 end