datadog_api_client 2.52.0 → 2.53.0

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

@@ -0,0 +1,198 @@
+=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 Retention query for defining timeseries and scalar visualizations.
+  class FormulaAndFunctionRetentionQueryDefinition
+    include BaseGenericModel
+
+    # Compute configuration for retention queries.
+    attr_reader :compute
+
+    # Data source for retention queries.
+    attr_reader :data_source
+
+    # Group by configuration.
+    attr_accessor :group_by
+
+    # Name of the query for use in formulas.
+    attr_reader :name
+
+    # Search configuration for retention queries.
+    attr_reader :search
+
+    attr_accessor :additional_properties
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'compute' => :'compute',
+        :'data_source' => :'data_source',
+        :'group_by' => :'group_by',
+        :'name' => :'name',
+        :'search' => :'search'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'compute' => :'RetentionCompute',
+        :'data_source' => :'RetentionDataSource',
+        :'group_by' => :'Array<RetentionGroupBy>',
+        :'name' => :'String',
+        :'search' => :'RetentionSearch'
+      }
+    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::FormulaAndFunctionRetentionQueryDefinition` 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?(:'compute')
+        self.compute = attributes[:'compute']
+      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?(:'search')
+        self.search = attributes[:'search']
+      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 @compute.nil?
+      return false if @data_source.nil?
+      return false if @name.nil?
+      return false if @search.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param compute [Object] Object to be assigned
+    # @!visibility private
+    def compute=(compute)
+      if compute.nil?
+        fail ArgumentError, 'invalid value for "compute", compute cannot be nil.'
+      end
+      @compute = compute
+    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 search [Object] Object to be assigned
+    # @!visibility private
+    def search=(search)
+      if search.nil?
+        fail ArgumentError, 'invalid value for "search", search cannot be nil.'
+      end
+      @search = search
+    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 &&
+          compute == o.compute &&
+          data_source == o.data_source &&
+          group_by == o.group_by &&
+          name == o.name &&
+          search == o.search &&
+          additional_properties == o.additional_properties
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [compute, data_source, group_by, name, search, additional_properties].hash
+    end
+  end
+end

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

@@ -0,0 +1,198 @@
+=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 User Journey query for defining funnel, timeseries, and scalar visualizations over journey data.
+  class FormulaAndFunctionUserJourneyQueryDefinition
+    include BaseGenericModel
+
+    # Compute configuration for User Journey formula queries.
+    attr_reader :compute
+
+    # Data source for user journey funnel queries.
+    attr_reader :data_source
+
+    # Group by configuration.
+    attr_accessor :group_by
+
+    # Name of the query for use in formulas.
+    attr_reader :name
+
+    # User journey search configuration.
+    attr_reader :search
+
+    attr_accessor :additional_properties
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'compute' => :'compute',
+        :'data_source' => :'data_source',
+        :'group_by' => :'group_by',
+        :'name' => :'name',
+        :'search' => :'search'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'compute' => :'UserJourneyFormulaCompute',
+        :'data_source' => :'ProductAnalyticsFunnelDataSource',
+        :'group_by' => :'Array<UserJourneyFormulaGroupBy>',
+        :'name' => :'String',
+        :'search' => :'UserJourneySearch'
+      }
+    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::FormulaAndFunctionUserJourneyQueryDefinition` 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?(:'compute')
+        self.compute = attributes[:'compute']
+      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?(:'search')
+        self.search = attributes[:'search']
+      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 @compute.nil?
+      return false if @data_source.nil?
+      return false if @name.nil?
+      return false if @search.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param compute [Object] Object to be assigned
+    # @!visibility private
+    def compute=(compute)
+      if compute.nil?
+        fail ArgumentError, 'invalid value for "compute", compute cannot be nil.'
+      end
+      @compute = compute
+    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 search [Object] Object to be assigned
+    # @!visibility private
+    def search=(search)
+      if search.nil?
+        fail ArgumentError, 'invalid value for "search", search cannot be nil.'
+      end
+      @search = search
+    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 &&
+          compute == o.compute &&
+          data_source == o.data_source &&
+          group_by == o.group_by &&
+          name == o.name &&
+          search == o.search &&
+          additional_properties == o.additional_properties
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [compute, data_source, group_by, name, search, additional_properties].hash
+    end
+  end
+end

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

@@ -0,0 +1,119 @@
+=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
+  # Custom timeframe for funnel comparison.
+  class FunnelComparisonCustomTimeframe
+    include BaseGenericModel
+
+    # Start of the custom timeframe.
+    attr_reader :from
+
+    # End of the custom timeframe.
+    attr_reader :to
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'from' => :'from',
+        :'to' => :'to'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'from' => :'Float',
+        :'to' => :'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::FunnelComparisonCustomTimeframe` 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::FunnelComparisonCustomTimeframe`. 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?(:'from')
+        self.from = attributes[:'from']
+      end
+
+      if attributes.key?(:'to')
+        self.to = attributes[:'to']
+      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 @from.nil?
+      return false if @to.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param from [Object] Object to be assigned
+    # @!visibility private
+    def from=(from)
+      if from.nil?
+        fail ArgumentError, 'invalid value for "from", from cannot be nil.'
+      end
+      @from = from
+    end
+
+    # Custom attribute writer method with validation
+    # @param to [Object] Object to be assigned
+    # @!visibility private
+    def to=(to)
+      if to.nil?
+        fail ArgumentError, 'invalid value for "to", to cannot be nil.'
+      end
+      @to = to
+    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 &&
+          from == o.from &&
+          to == o.to
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [from, to].hash
+    end
+  end
+end

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

@@ -0,0 +1,108 @@
+=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
+  # Comparison time configuration for funnel widgets.
+  class FunnelComparisonDuration
+    include BaseGenericModel
+
+    # Custom timeframe for funnel comparison.
+    attr_accessor :custom_timeframe
+
+    # Type of comparison duration.
+    attr_reader :type
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'custom_timeframe' => :'custom_timeframe',
+        :'type' => :'type'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'custom_timeframe' => :'FunnelComparisonCustomTimeframe',
+        :'type' => :'FunnelComparisonDurationType'
+      }
+    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::FunnelComparisonDuration` 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::FunnelComparisonDuration`. 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?(:'custom_timeframe')
+        self.custom_timeframe = attributes[:'custom_timeframe']
+      end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      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 @type.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param type [Object] Object to be assigned
+    # @!visibility private
+    def type=(type)
+      if type.nil?
+        fail ArgumentError, 'invalid value for "type", type cannot be nil.'
+      end
+      @type = type
+    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 &&
+          custom_timeframe == o.custom_timeframe &&
+          type == o.type
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [custom_timeframe, type].hash
+    end
+  end
+end

data/lib/datadog_api_client/v1/models/funnel_comparison_duration_type.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
+  # Type of comparison duration.
+  class FunnelComparisonDurationType
+    include BaseEnumModel
+
+    PREVIOUS_TIMEFRAME = "previous_timeframe".freeze
+    CUSTOM_TIMEFRAME = "custom_timeframe".freeze
+    PREVIOUS_DAY = "previous_day".freeze
+    PREVIOUS_WEEK = "previous_week".freeze
+    PREVIOUS_MONTH = "previous_month".freeze
+  end
+end

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

@@ -0,0 +1,27 @@
+=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
+  # Display mode for grouped funnel results.
+  class FunnelGroupedDisplay
+    include BaseEnumModel
+
+    STACKED = "stacked".freeze
+    SIDE_BY_SIDE = "side_by_side".freeze
+  end
+end