datadog_api_client 2.55.0 → 2.56.0

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

@@ -0,0 +1,448 @@
+=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
+  # The attributes of a governance insight.
+  class GovernanceInsightAttributes
+    include BaseGenericModel
+
+    # An audit log query used to compute an insight value.
+    attr_reader :audit_query
+
+    # The best practice associated with an insight. Populated with the first active best practice
+    # matched to the insight; `null` when no best practice is attached.
+    attr_reader :best_practice
+
+    # A relative link to the product surface where the insight can be acted upon.
+    attr_reader :deep_link
+
+    # A human-readable description of what the insight measures.
+    attr_reader :description
+
+    # Human-readable name of the insight.
+    attr_reader :display_name
+
+    # An event query used to compute an insight value.
+    attr_reader :event_query
+
+    # A metric query used to compute an insight value.
+    attr_reader :metric_query
+
+    # The value of the insight over the previous comparison window. `null` when values were
+    # not requested or could not be computed.
+    attr_accessor :old_value
+
+    # A percentage query that computes an insight value as a ratio of two metric queries.
+    attr_reader :percentage_query
+
+    # The product the insight belongs to.
+    attr_reader :product
+
+    # Query execution context that allows the frontend to execute insight queries directly.
+    attr_accessor :query_config
+
+    # The relative order in which the insight should be displayed.
+    attr_accessor :sort_order
+
+    # The state of the insight. A `critical` insight receives extra UI treatment to draw
+    # attention to it.
+    attr_reader :state
+
+    # The sub-product the insight belongs to, if any.
+    attr_reader :sub_product
+
+    # The time range the insight value is computed over, if applicable.
+    attr_reader :time_range
+
+    # The unit that the insight's value is measured in.
+    attr_reader :unit_name
+
+    # A usage query used to compute an insight value.
+    attr_reader :usage_query
+
+    # The current value of the insight. `null` when values were not requested or could not be computed.
+    attr_accessor :value
+
+    attr_accessor :additional_properties
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'audit_query' => :'audit_query',
+        :'best_practice' => :'best_practice',
+        :'deep_link' => :'deep_link',
+        :'description' => :'description',
+        :'display_name' => :'display_name',
+        :'event_query' => :'event_query',
+        :'metric_query' => :'metric_query',
+        :'old_value' => :'old_value',
+        :'percentage_query' => :'percentage_query',
+        :'product' => :'product',
+        :'query_config' => :'query_config',
+        :'sort_order' => :'sort_order',
+        :'state' => :'state',
+        :'sub_product' => :'sub_product',
+        :'time_range' => :'time_range',
+        :'unit_name' => :'unit_name',
+        :'usage_query' => :'usage_query',
+        :'value' => :'value'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'audit_query' => :'GovernanceInsightAuditQuery',
+        :'best_practice' => :'GovernanceBestPracticeDefinition',
+        :'deep_link' => :'String',
+        :'description' => :'String',
+        :'display_name' => :'String',
+        :'event_query' => :'GovernanceInsightEventQuery',
+        :'metric_query' => :'GovernanceInsightMetricQuery',
+        :'old_value' => :'Float',
+        :'percentage_query' => :'GovernanceInsightPercentageQuery',
+        :'product' => :'String',
+        :'query_config' => :'GovernanceInsightQueryConfig',
+        :'sort_order' => :'Integer',
+        :'state' => :'String',
+        :'sub_product' => :'String',
+        :'time_range' => :'String',
+        :'unit_name' => :'String',
+        :'usage_query' => :'GovernanceInsightUsageQuery',
+        :'value' => :'Float'
+      }
+    end
+
+    # List of attributes with nullable: true
+    # @!visibility private
+    def self.openapi_nullable
+      Set.new([
+        :'old_value',
+        :'value',
+      ])
+    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::GovernanceInsightAttributes` 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?(:'audit_query')
+        self.audit_query = attributes[:'audit_query']
+      end
+
+      if attributes.key?(:'best_practice')
+        self.best_practice = attributes[:'best_practice']
+      end
+
+      if attributes.key?(:'deep_link')
+        self.deep_link = attributes[:'deep_link']
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'display_name')
+        self.display_name = attributes[:'display_name']
+      end
+
+      if attributes.key?(:'event_query')
+        self.event_query = attributes[:'event_query']
+      end
+
+      if attributes.key?(:'metric_query')
+        self.metric_query = attributes[:'metric_query']
+      end
+
+      if attributes.key?(:'old_value')
+        self.old_value = attributes[:'old_value']
+      end
+
+      if attributes.key?(:'percentage_query')
+        self.percentage_query = attributes[:'percentage_query']
+      end
+
+      if attributes.key?(:'product')
+        self.product = attributes[:'product']
+      end
+
+      if attributes.key?(:'query_config')
+        self.query_config = attributes[:'query_config']
+      end
+
+      if attributes.key?(:'sort_order')
+        self.sort_order = attributes[:'sort_order']
+      end
+
+      if attributes.key?(:'state')
+        self.state = attributes[:'state']
+      end
+
+      if attributes.key?(:'sub_product')
+        self.sub_product = attributes[:'sub_product']
+      end
+
+      if attributes.key?(:'time_range')
+        self.time_range = attributes[:'time_range']
+      end
+
+      if attributes.key?(:'unit_name')
+        self.unit_name = attributes[:'unit_name']
+      end
+
+      if attributes.key?(:'usage_query')
+        self.usage_query = attributes[:'usage_query']
+      end
+
+      if attributes.key?(:'value')
+        self.value = attributes[:'value']
+      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 @audit_query.nil?
+      return false if @best_practice.nil?
+      return false if @deep_link.nil?
+      return false if @description.nil?
+      return false if @display_name.nil?
+      return false if @event_query.nil?
+      return false if @metric_query.nil?
+      return false if @percentage_query.nil?
+      return false if @product.nil?
+      return false if @state.nil?
+      return false if @sub_product.nil?
+      return false if @time_range.nil?
+      return false if @unit_name.nil?
+      return false if @usage_query.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param audit_query [Object] Object to be assigned
+    # @!visibility private
+    def audit_query=(audit_query)
+      if audit_query.nil?
+        fail ArgumentError, 'invalid value for "audit_query", audit_query cannot be nil.'
+      end
+      @audit_query = audit_query
+    end
+
+    # Custom attribute writer method with validation
+    # @param best_practice [Object] Object to be assigned
+    # @!visibility private
+    def best_practice=(best_practice)
+      if best_practice.nil?
+        fail ArgumentError, 'invalid value for "best_practice", best_practice cannot be nil.'
+      end
+      @best_practice = best_practice
+    end
+
+    # Custom attribute writer method with validation
+    # @param deep_link [Object] Object to be assigned
+    # @!visibility private
+    def deep_link=(deep_link)
+      if deep_link.nil?
+        fail ArgumentError, 'invalid value for "deep_link", deep_link cannot be nil.'
+      end
+      @deep_link = deep_link
+    end
+
+    # Custom attribute writer method with validation
+    # @param description [Object] Object to be assigned
+    # @!visibility private
+    def description=(description)
+      if description.nil?
+        fail ArgumentError, 'invalid value for "description", description cannot be nil.'
+      end
+      @description = description
+    end
+
+    # Custom attribute writer method with validation
+    # @param display_name [Object] Object to be assigned
+    # @!visibility private
+    def display_name=(display_name)
+      if display_name.nil?
+        fail ArgumentError, 'invalid value for "display_name", display_name cannot be nil.'
+      end
+      @display_name = display_name
+    end
+
+    # Custom attribute writer method with validation
+    # @param event_query [Object] Object to be assigned
+    # @!visibility private
+    def event_query=(event_query)
+      if event_query.nil?
+        fail ArgumentError, 'invalid value for "event_query", event_query cannot be nil.'
+      end
+      @event_query = event_query
+    end
+
+    # Custom attribute writer method with validation
+    # @param metric_query [Object] Object to be assigned
+    # @!visibility private
+    def metric_query=(metric_query)
+      if metric_query.nil?
+        fail ArgumentError, 'invalid value for "metric_query", metric_query cannot be nil.'
+      end
+      @metric_query = metric_query
+    end
+
+    # Custom attribute writer method with validation
+    # @param percentage_query [Object] Object to be assigned
+    # @!visibility private
+    def percentage_query=(percentage_query)
+      if percentage_query.nil?
+        fail ArgumentError, 'invalid value for "percentage_query", percentage_query cannot be nil.'
+      end
+      @percentage_query = percentage_query
+    end
+
+    # Custom attribute writer method with validation
+    # @param product [Object] Object to be assigned
+    # @!visibility private
+    def product=(product)
+      if product.nil?
+        fail ArgumentError, 'invalid value for "product", product cannot be nil.'
+      end
+      @product = product
+    end
+
+    # Custom attribute writer method with validation
+    # @param state [Object] Object to be assigned
+    # @!visibility private
+    def state=(state)
+      if state.nil?
+        fail ArgumentError, 'invalid value for "state", state cannot be nil.'
+      end
+      @state = state
+    end
+
+    # Custom attribute writer method with validation
+    # @param sub_product [Object] Object to be assigned
+    # @!visibility private
+    def sub_product=(sub_product)
+      if sub_product.nil?
+        fail ArgumentError, 'invalid value for "sub_product", sub_product cannot be nil.'
+      end
+      @sub_product = sub_product
+    end
+
+    # Custom attribute writer method with validation
+    # @param time_range [Object] Object to be assigned
+    # @!visibility private
+    def time_range=(time_range)
+      if time_range.nil?
+        fail ArgumentError, 'invalid value for "time_range", time_range cannot be nil.'
+      end
+      @time_range = time_range
+    end
+
+    # Custom attribute writer method with validation
+    # @param unit_name [Object] Object to be assigned
+    # @!visibility private
+    def unit_name=(unit_name)
+      if unit_name.nil?
+        fail ArgumentError, 'invalid value for "unit_name", unit_name cannot be nil.'
+      end
+      @unit_name = unit_name
+    end
+
+    # Custom attribute writer method with validation
+    # @param usage_query [Object] Object to be assigned
+    # @!visibility private
+    def usage_query=(usage_query)
+      if usage_query.nil?
+        fail ArgumentError, 'invalid value for "usage_query", usage_query cannot be nil.'
+      end
+      @usage_query = usage_query
+    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 &&
+          audit_query == o.audit_query &&
+          best_practice == o.best_practice &&
+          deep_link == o.deep_link &&
+          description == o.description &&
+          display_name == o.display_name &&
+          event_query == o.event_query &&
+          metric_query == o.metric_query &&
+          old_value == o.old_value &&
+          percentage_query == o.percentage_query &&
+          product == o.product &&
+          query_config == o.query_config &&
+          sort_order == o.sort_order &&
+          state == o.state &&
+          sub_product == o.sub_product &&
+          time_range == o.time_range &&
+          unit_name == o.unit_name &&
+          usage_query == o.usage_query &&
+          value == o.value &&
+          additional_properties == o.additional_properties
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [audit_query, best_practice, deep_link, description, display_name, event_query, metric_query, old_value, percentage_query, product, query_config, sort_order, state, sub_product, time_range, unit_name, usage_query, value, additional_properties].hash
+    end
+  end
+end

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

@@ -0,0 +1,175 @@
+=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
+  # The aggregation applied to an audit log query.
+  class GovernanceInsightAuditCompute
+    include BaseGenericModel
+
+    # The aggregation function to apply.
+    attr_reader :aggregation
+
+    # The aggregation time window, in milliseconds.
+    attr_reader :interval
+
+    # The metric or attribute to aggregate.
+    attr_reader :metric
+
+    # An optional secondary aggregation applied to the audit query result.
+    attr_accessor :rollup
+
+    attr_accessor :additional_properties
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'aggregation' => :'aggregation',
+        :'interval' => :'interval',
+        :'metric' => :'metric',
+        :'rollup' => :'rollup'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'aggregation' => :'String',
+        :'interval' => :'Integer',
+        :'metric' => :'String',
+        :'rollup' => :'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::V2::GovernanceInsightAuditCompute` 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?(:'aggregation')
+        self.aggregation = attributes[:'aggregation']
+      end
+
+      if attributes.key?(:'interval')
+        self.interval = attributes[:'interval']
+      end
+
+      if attributes.key?(:'metric')
+        self.metric = attributes[:'metric']
+      end
+
+      if attributes.key?(:'rollup')
+        self.rollup = attributes[:'rollup']
+      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 @aggregation.nil?
+      return false if @interval.nil?
+      return false if @metric.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param aggregation [Object] Object to be assigned
+    # @!visibility private
+    def aggregation=(aggregation)
+      if aggregation.nil?
+        fail ArgumentError, 'invalid value for "aggregation", aggregation cannot be nil.'
+      end
+      @aggregation = aggregation
+    end
+
+    # Custom attribute writer method with validation
+    # @param interval [Object] Object to be assigned
+    # @!visibility private
+    def interval=(interval)
+      if interval.nil?
+        fail ArgumentError, 'invalid value for "interval", interval cannot be nil.'
+      end
+      @interval = interval
+    end
+
+    # Custom attribute writer method with validation
+    # @param metric [Object] Object to be assigned
+    # @!visibility private
+    def metric=(metric)
+      if metric.nil?
+        fail ArgumentError, 'invalid value for "metric", metric cannot be nil.'
+      end
+      @metric = metric
+    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 &&
+          aggregation == o.aggregation &&
+          interval == o.interval &&
+          metric == o.metric &&
+          rollup == o.rollup &&
+          additional_properties == o.additional_properties
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [aggregation, interval, metric, rollup, additional_properties].hash
+    end
+  end
+end