datadog_api_client 2.55.0 → 2.56.0

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

@@ -0,0 +1,186 @@
+=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 string builder sub-processor for use inside an array-map processor.
+  # Unlike the top-level string builder processor, `is_enabled` is not supported.
+  class LogsArrayMapStringBuilderSubProcessor
+    include BaseGenericModel
+
+    # Replace missing attribute values with an empty string.
+    attr_accessor :is_replace_missing
+
+    # Name of the sub-processor.
+    attr_accessor :name
+
+    # Target attribute path for the result.
+    attr_reader :target
+
+    # Formula with one or more attributes and raw text.
+    attr_reader :template
+
+    # Type of logs string builder processor.
+    attr_reader :type
+
+    attr_accessor :additional_properties
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'is_replace_missing' => :'is_replace_missing',
+        :'name' => :'name',
+        :'target' => :'target',
+        :'template' => :'template',
+        :'type' => :'type'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'is_replace_missing' => :'Boolean',
+        :'name' => :'String',
+        :'target' => :'String',
+        :'template' => :'String',
+        :'type' => :'LogsStringBuilderProcessorType'
+      }
+    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::LogsArrayMapStringBuilderSubProcessor` 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?(:'is_replace_missing')
+        self.is_replace_missing = attributes[:'is_replace_missing']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'target')
+        self.target = attributes[:'target']
+      end
+
+      if attributes.key?(:'template')
+        self.template = attributes[:'template']
+      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 @target.nil?
+      return false if @template.nil?
+      return false if @type.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param target [Object] Object to be assigned
+    # @!visibility private
+    def target=(target)
+      if target.nil?
+        fail ArgumentError, 'invalid value for "target", target cannot be nil.'
+      end
+      @target = target
+    end
+
+    # Custom attribute writer method with validation
+    # @param template [Object] Object to be assigned
+    # @!visibility private
+    def template=(template)
+      if template.nil?
+        fail ArgumentError, 'invalid value for "template", template cannot be nil.'
+      end
+      @template = template
+    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
+
+    # 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 &&
+          is_replace_missing == o.is_replace_missing &&
+          name == o.name &&
+          target == o.target &&
+          template == o.template &&
+          type == o.type &&
+          additional_properties == o.additional_properties
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [is_replace_missing, name, target, template, type, additional_properties].hash
+    end
+  end
+end

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

@@ -0,0 +1,67 @@
+=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 sub-processor used inside an array-map processor.
+  # Allowed types: `attribute-remapper`, `string-builder-processor`,
+  # `arithmetic-processor`, `category-processor`.
+  module LogsArrayMapSubProcessor
+    class << self
+      include BaseOneOfModel
+      include BaseOneOfModelNoDiscriminator
+
+      # List of class defined in oneOf (OpenAPI v3)
+      def openapi_one_of
+        [
+          :'LogsArrayMapAttributeRemapper',
+          :'LogsArrayMapArithmeticSubProcessor',
+          :'LogsArrayMapStringBuilderSubProcessor',
+          :'LogsArrayMapCategorySubProcessor'
+        ]
+      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/logs_processor.rb

@@ -46,7 +46,8 @@ module DatadogAPIClient::V1
           :'LogsArrayProcessor',
           :'LogsDecoderProcessor',
           :'LogsSchemaProcessor',
-          :'LogsExcludeAttributeProcessor'
+          :'LogsExcludeAttributeProcessor',
+          :'LogsArrayMapProcessor'
         ]
       end
       # Builds the object

data/lib/datadog_api_client/v2/api/cloud_cost_management_api.rb

@@ -827,6 +827,77 @@ module DatadogAPIClient::V2
       return data, status_code, headers
     end
 
+    # Delete a budget's custom forecast.
+    #
+    # @see #delete_custom_forecast_with_http_info
+    def delete_custom_forecast(budget_id, opts = {})
+      delete_custom_forecast_with_http_info(budget_id, opts)
+      nil
+    end
+
+    # Delete a budget's custom forecast.
+    #
+    # Delete the custom forecast for a budget.
+    #
+    # @param budget_id [String] Budget id.
+    # @param opts [Hash] the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def delete_custom_forecast_with_http_info(budget_id, opts = {})
+      unstable_enabled = @api_client.config.unstable_operations["v2.delete_custom_forecast".to_sym]
+      if unstable_enabled
+        @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.delete_custom_forecast")
+      else
+        raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.delete_custom_forecast"))
+      end
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.delete_custom_forecast ...'
+      end
+      # verify the required parameter 'budget_id' is set
+      if @api_client.config.client_side_validation && budget_id.nil?
+        fail ArgumentError, "Missing the required parameter 'budget_id' when calling CloudCostManagementAPI.delete_custom_forecast"
+      end
+      # resource path
+      local_var_path = '/api/v2/cost/budget/{budget_id}/custom-forecast'.sub('{budget_id}', CGI.escape(budget_id.to_s).gsub('%2F', '/'))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['*/*'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]
+
+      new_options = opts.merge(
+        :operation => :delete_custom_forecast,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type,
+        :api_version => "V2"
+      )
+
+      data, status_code, headers = @api_client.call_api(Net::HTTP::Delete, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CloudCostManagementAPI#delete_custom_forecast\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Delete tag pipeline ruleset.
     #
     # @see #delete_tag_pipelines_ruleset_with_http_info
@@ -967,10 +1038,14 @@ module DatadogAPIClient::V2
 
     # Get budget.
     #
-    # Get a budget
+    # Get a budget by ID. Pass `actual=true` or `forecast=true` to include cost data in the response. Use `start` and `end` (millisecond epochs, both required) to set the cost window. When `forecast=true`, each entry also includes `ootb_forecast` (the ML forecast before overrides) and `custom_forecast` (`null` if no override is set, a number if one is).
     #
     # @param budget_id [String] Budget id.
     # @param opts [Hash] the optional parameters
+    # @option opts [Boolean] :actual When `true`, includes actual cost data in the response.
+    # @option opts [Boolean] :forecast When `true`, includes forecast cost data in the response, including `ootb_forecast` and `custom_forecast` per entry.
+    # @option opts [Integer] :start Start of the cost window in milliseconds since epoch. Must be used together with `end`.
+    # @option opts [Integer] :_end End of the cost window in milliseconds since epoch. Must be used together with `start`.
     # @return [Array<(BudgetWithEntries, Integer, Hash)>] BudgetWithEntries data, response status code and response headers
     def get_budget_with_http_info(budget_id, opts = {})
 
@@ -986,6 +1061,10 @@ module DatadogAPIClient::V2
 
       # query parameters
       query_params = opts[:query_params] || {}
+      query_params[:'actual'] = opts[:'actual'] if !opts[:'actual'].nil?
+      query_params[:'forecast'] = opts[:'forecast'] if !opts[:'forecast'].nil?
+      query_params[:'start'] = opts[:'start'] if !opts[:'start'].nil?
+      query_params[:'end'] = opts[:'_end'] if !opts[:'_end'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}
@@ -4570,6 +4649,80 @@ module DatadogAPIClient::V2
       return data, status_code, headers
     end
 
+    # Create or replace a budget's custom forecast.
+    #
+    # @see #upsert_custom_forecast_with_http_info
+    def upsert_custom_forecast(body, opts = {})
+      data, _status_code, _headers = upsert_custom_forecast_with_http_info(body, opts)
+      data
+    end
+
+    # Create or replace a budget's custom forecast.
+    #
+    # Create or replace the custom forecast for an existing budget.
+    # Pass an empty `entries` list to delete the custom forecast for the budget.
+    #
+    # @param body [CustomForecastUpsertRequest] 
+    # @param opts [Hash] the optional parameters
+    # @return [Array<(CustomForecastResponse, Integer, Hash)>] CustomForecastResponse data, response status code and response headers
+    def upsert_custom_forecast_with_http_info(body, opts = {})
+      unstable_enabled = @api_client.config.unstable_operations["v2.upsert_custom_forecast".to_sym]
+      if unstable_enabled
+        @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.upsert_custom_forecast")
+      else
+        raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.upsert_custom_forecast"))
+      end
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.upsert_custom_forecast ...'
+      end
+      # verify the required parameter 'body' is set
+      if @api_client.config.client_side_validation && body.nil?
+        fail ArgumentError, "Missing the required parameter 'body' when calling CloudCostManagementAPI.upsert_custom_forecast"
+      end
+      # resource path
+      local_var_path = '/api/v2/cost/budget/custom-forecast'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(body)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CustomForecastResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]
+
+      new_options = opts.merge(
+        :operation => :upsert_custom_forecast,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type,
+        :api_version => "V2"
+      )
+
+      data, status_code, headers = @api_client.call_api(Net::HTTP::Put, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CloudCostManagementAPI#upsert_custom_forecast\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Validate budget.
     #
     # @see #validate_budget_with_http_info

data/lib/datadog_api_client/v2/api/compliance_api.rb

@@ -33,9 +33,13 @@ module DatadogAPIClient::V2
 
     # Get the rule-based view of compliance findings.
     #
+    # **This endpoint is deprecated.** Use the [Security Monitoring - Search Security Findings](https://docs.datadoghq.com/api/latest/security-monitoring/search-security-findings/) endpoint instead.
+    #
     # Get an aggregated view of compliance rules with their pass, fail, and muted finding counts.
     # Supports filtering by compliance framework, framework version, and additional query filters.
     #
+    # @deprecated This API is deprecated.
+    #
     # @param to [Integer] Timestamp of the query end, in milliseconds since the Unix epoch.
     # @param opts [Hash] the optional parameters
     # @option opts [String] :framework Compliance framework handle to filter rules and findings by.
@@ -46,6 +50,7 @@ module DatadogAPIClient::V2
     # @option opts [String] :query Additional event-platform filters applied to the underlying findings query. For example, `scored:true project_id:datadog-prod-us5`.
     # @return [Array<(RuleBasedViewResponse, Integer, Hash)>] RuleBasedViewResponse data, response status code and response headers
     def get_rule_based_view_with_http_info(to, opts = {})
+      warn "[DEPRECATION] `GetRuleBasedView` is deprecated."
       unstable_enabled = @api_client.config.unstable_operations["v2.get_rule_based_view".to_sym]
       if unstable_enabled
         @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.get_rule_based_view")