datadog_api_client 2.33.0 → 2.35.0

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

@@ -44,12 +44,6 @@ module DatadogAPIClient::V2
     # @param opts [Hash] the optional parameters
     # @return [Array<(DORADeploymentResponse, Integer, Hash)>] DORADeploymentResponse data, response status code and response headers
     def create_dora_deployment_with_http_info(body, opts = {})
-      unstable_enabled = @api_client.config.unstable_operations["v2.create_dora_deployment".to_sym]
-      if unstable_enabled
-        @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.create_dora_deployment")
-      else
-        raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.create_dora_deployment"))
-      end
 
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: DORAMetricsAPI.create_dora_deployment ...'
@@ -101,6 +95,77 @@ module DatadogAPIClient::V2
       return data, status_code, headers
     end
 
+    # Send a failure event for DORA Metrics.
+    #
+    # @see #create_dora_failure_with_http_info
+    def create_dora_failure(body, opts = {})
+      data, _status_code, _headers = create_dora_failure_with_http_info(body, opts)
+      data
+    end
+
+    # Send a failure event for DORA Metrics.
+    #
+    # Use this API endpoint to provide failure data for DORA metrics.
+    #
+    # This is necessary for:
+    # - Change Failure Rate
+    # - Time to Restore
+    #
+    # @param body [DORAFailureRequest] 
+    # @param opts [Hash] the optional parameters
+    # @return [Array<(DORAFailureResponse, Integer, Hash)>] DORAFailureResponse data, response status code and response headers
+    def create_dora_failure_with_http_info(body, opts = {})
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DORAMetricsAPI.create_dora_failure ...'
+      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 DORAMetricsAPI.create_dora_failure"
+      end
+      # resource path
+      local_var_path = '/api/v2/dora/failure'
+
+      # 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] || 'DORAFailureResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || [:apiKeyAuth]
+
+      new_options = opts.merge(
+        :operation => :create_dora_failure,
+        :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::Post, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DORAMetricsAPI#create_dora_failure\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Send an incident event for DORA Metrics.
     #
     # @see #create_dora_incident_with_http_info
@@ -111,22 +176,21 @@ module DatadogAPIClient::V2
 
     # Send an incident event for DORA Metrics.
     #
-    # Use this API endpoint to provide data about incidents for DORA metrics.
+    # **Note**: This endpoint is deprecated. Please use `/api/v2/dora/failure` instead.
+    #
+    # Use this API endpoint to provide failure data for DORA metrics.
     #
     # This is necessary for:
     # - Change Failure Rate
     # - Time to Restore
     #
-    # @param body [DORAIncidentRequest] 
+    # @deprecated This API is deprecated.
+    #
+    # @param body [DORAFailureRequest] 
     # @param opts [Hash] the optional parameters
-    # @return [Array<(DORAIncidentResponse, Integer, Hash)>] DORAIncidentResponse data, response status code and response headers
+    # @return [Array<(DORAFailureResponse, Integer, Hash)>] DORAFailureResponse data, response status code and response headers
     def create_dora_incident_with_http_info(body, opts = {})
-      unstable_enabled = @api_client.config.unstable_operations["v2.create_dora_incident".to_sym]
-      if unstable_enabled
-        @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.create_dora_incident")
-      else
-        raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.create_dora_incident"))
-      end
+      warn "[DEPRECATION] `CreateDORAIncident` is deprecated."
 
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: DORAMetricsAPI.create_dora_incident ...'
@@ -155,7 +219,7 @@ module DatadogAPIClient::V2
       post_body = opts[:debug_body] || @api_client.object_to_http_body(body)
 
       # return_type
-      return_type = opts[:debug_return_type] || 'DORAIncidentResponse'
+      return_type = opts[:debug_return_type] || 'DORAFailureResponse'
 
       # auth_names
       auth_names = opts[:debug_auth_names] || [:apiKeyAuth]
@@ -177,5 +241,269 @@ module DatadogAPIClient::V2
       end
       return data, status_code, headers
     end
+
+    # Get a deployment event.
+    #
+    # @see #get_dora_deployment_with_http_info
+    def get_dora_deployment(deployment_id, opts = {})
+      data, _status_code, _headers = get_dora_deployment_with_http_info(deployment_id, opts)
+      data
+    end
+
+    # Get a deployment event.
+    #
+    # Use this API endpoint to get a deployment event.
+    #
+    # @param deployment_id [String] The ID of the deployment event.
+    # @param opts [Hash] the optional parameters
+    # @return [Array<(DORAFetchResponse, Integer, Hash)>] DORAFetchResponse data, response status code and response headers
+    def get_dora_deployment_with_http_info(deployment_id, opts = {})
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DORAMetricsAPI.get_dora_deployment ...'
+      end
+      # verify the required parameter 'deployment_id' is set
+      if @api_client.config.client_side_validation && deployment_id.nil?
+        fail ArgumentError, "Missing the required parameter 'deployment_id' when calling DORAMetricsAPI.get_dora_deployment"
+      end
+      # resource path
+      local_var_path = '/api/v2/dora/deployments/{deployment_id}'.sub('{deployment_id}', CGI.escape(deployment_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(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'DORAFetchResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]
+
+      new_options = opts.merge(
+        :operation => :get_dora_deployment,
+        :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::Get, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DORAMetricsAPI#get_dora_deployment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get a failure event.
+    #
+    # @see #get_dora_failure_with_http_info
+    def get_dora_failure(failure_id, opts = {})
+      data, _status_code, _headers = get_dora_failure_with_http_info(failure_id, opts)
+      data
+    end
+
+    # Get a failure event.
+    #
+    # Use this API endpoint to get a failure event.
+    #
+    # @param failure_id [String] The ID of the failure event.
+    # @param opts [Hash] the optional parameters
+    # @return [Array<(DORAFetchResponse, Integer, Hash)>] DORAFetchResponse data, response status code and response headers
+    def get_dora_failure_with_http_info(failure_id, opts = {})
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DORAMetricsAPI.get_dora_failure ...'
+      end
+      # verify the required parameter 'failure_id' is set
+      if @api_client.config.client_side_validation && failure_id.nil?
+        fail ArgumentError, "Missing the required parameter 'failure_id' when calling DORAMetricsAPI.get_dora_failure"
+      end
+      # resource path
+      local_var_path = '/api/v2/dora/failures/{failure_id}'.sub('{failure_id}', CGI.escape(failure_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(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'DORAFetchResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]
+
+      new_options = opts.merge(
+        :operation => :get_dora_failure,
+        :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::Get, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DORAMetricsAPI#get_dora_failure\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get a list of deployment events.
+    #
+    # @see #list_dora_deployments_with_http_info
+    def list_dora_deployments(body, opts = {})
+      data, _status_code, _headers = list_dora_deployments_with_http_info(body, opts)
+      data
+    end
+
+    # Get a list of deployment events.
+    #
+    # Use this API endpoint to get a list of deployment events.
+    #
+    # @param body [DORAListDeploymentsRequest] 
+    # @param opts [Hash] the optional parameters
+    # @return [Array<(DORAListResponse, Integer, Hash)>] DORAListResponse data, response status code and response headers
+    def list_dora_deployments_with_http_info(body, opts = {})
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DORAMetricsAPI.list_dora_deployments ...'
+      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 DORAMetricsAPI.list_dora_deployments"
+      end
+      # resource path
+      local_var_path = '/api/v2/dora/deployments'
+
+      # 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] || 'DORAListResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]
+
+      new_options = opts.merge(
+        :operation => :list_dora_deployments,
+        :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::Post, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DORAMetricsAPI#list_dora_deployments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get a list of failure events.
+    #
+    # @see #list_dora_failures_with_http_info
+    def list_dora_failures(body, opts = {})
+      data, _status_code, _headers = list_dora_failures_with_http_info(body, opts)
+      data
+    end
+
+    # Get a list of failure events.
+    #
+    # Use this API endpoint to get a list of failure events.
+    #
+    # @param body [DORAListFailuresRequest] 
+    # @param opts [Hash] the optional parameters
+    # @return [Array<(DORAListResponse, Integer, Hash)>] DORAListResponse data, response status code and response headers
+    def list_dora_failures_with_http_info(body, opts = {})
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DORAMetricsAPI.list_dora_failures ...'
+      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 DORAMetricsAPI.list_dora_failures"
+      end
+      # resource path
+      local_var_path = '/api/v2/dora/failures'
+
+      # 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] || 'DORAListResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]
+
+      new_options = opts.merge(
+        :operation => :list_dora_failures,
+        :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::Post, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DORAMetricsAPI#list_dora_failures\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
   end
 end

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

@@ -107,10 +107,10 @@ module DatadogAPIClient::V2
     # Create a tag configuration.
     #
     # Create and define a list of queryable tag keys for an existing count/gauge/rate/distribution metric.
-    # Optionally, include percentile aggregations on any distribution metric or configure custom aggregations
-    # on any count, rate, or gauge metric. By setting `exclude_tags_mode` to true the behavior is changed
-    # from an allow-list to a deny-list, and tags in the defined list will not be queryable.
-    # Can only be used with application keys of users with the `Manage Tags for Metrics` permission.
+    # Optionally, include percentile aggregations on any distribution metric. By setting `exclude_tags_mode`
+    # to true, the behavior is changed from an allow-list to a deny-list, and tags in the defined list are
+    # not queryable. Can only be used with application keys of users with the `Manage Tags for Metrics`
+    # permission.
     #
     # @param metric_name [String] The name of the metric.
     # @param body [MetricTagConfigurationCreateRequest] 
@@ -324,7 +324,7 @@ module DatadogAPIClient::V2
     # @param opts [Hash] the optional parameters
     # @option opts [String] :filter_groups Filtered tag keys that the metric is configured to query with.
     # @option opts [Integer] :filter_hours_ago The number of hours of look back (from now) to estimate cardinality with. If unspecified, it defaults to 0 hours.
-    # @option opts [Integer] :filter_num_aggregations The number of aggregations that a `count`, `rate`, or `gauge` metric is configured to use. Max number of aggregation combos is 9.
+    # @option opts [Integer] :filter_num_aggregations Deprecated. Number of aggregations has no impact on volume.
     # @option opts [Boolean] :filter_pct A boolean, for distribution metrics only, to estimate cardinality if the metric includes additional percentile aggregators.
     # @option opts [Integer] :filter_timespan_h A window, in hours, from the look back to estimate cardinality with. The minimum and default is 1 hour.
     # @return [Array<(MetricEstimateResponse, Integer, Hash)>] MetricEstimateResponse data, response status code and response headers

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

@@ -169,8 +169,8 @@ module DatadogAPIClient::V2
     # Get the list of devices.
     #
     # @param opts [Hash] the optional parameters
-    # @option opts [Integer] :page_number The page number to fetch.
-    # @option opts [Integer] :page_size The number of devices to return per page.
+    # @option opts [Integer] :page_size Size for a given page. The maximum allowed value is 100.
+    # @option opts [Integer] :page_number Specific page number to return.
     # @option opts [String] :sort The field to sort the devices by.
     # @option opts [String] :filter_tag Filter devices by tag.
     # @return [Array<(ListDevicesResponse, Integer, Hash)>] ListDevicesResponse data, response status code and response headers
@@ -184,8 +184,8 @@ module DatadogAPIClient::V2
 
       # query parameters
       query_params = opts[:query_params] || {}
-      query_params[:'page[number]'] = opts[:'page_number'] if !opts[:'page_number'].nil?
       query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
+      query_params[:'page[number]'] = opts[:'page_number'] if !opts[:'page_number'].nil?
       query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
       query_params[:'filter[tag]'] = opts[:'filter_tag'] if !opts[:'filter_tag'].nil?
 
@@ -224,6 +224,28 @@ module DatadogAPIClient::V2
       return data, status_code, headers
     end
 
+    # Get the list of devices.
+    #
+    # Provide a paginated version of {#list_devices}, returning all items.
+    #
+    # To use it you need to use a block: list_devices_with_pagination { |item| p item }
+    #
+    # @yield [DevicesListData] Paginated items
+    def list_devices_with_pagination(opts = {})
+        api_version = "V2"
+        page_size = @api_client.get_attribute_from_path(opts, "page_size", 10)
+        @api_client.set_attribute_from_path(api_version, opts, "page_size", Integer, page_size)
+        @api_client.set_attribute_from_path(api_version, opts, "page_number", Integer, 0)
+        while true do
+            response = list_devices(opts)
+            @api_client.get_attribute_from_path(response, "data").each { |item| yield(item) }
+            if @api_client.get_attribute_from_path(response, "data").length < page_size
+              break
+            end
+            @api_client.set_attribute_from_path(api_version, opts, "page_number", Integer, @api_client.get_attribute_from_path(opts, "page_number", 0) + 1)
+        end
+    end
+
     # Get the list of tags for a device.
     #
     # @see #list_device_user_tags_with_http_info