datadog_api_client 2.9.0 → 2.10.0

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

@@ -0,0 +1,357 @@
+=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 'cgi'
+
+module DatadogAPIClient::V2
+  class SpansMetricsAPI
+    attr_accessor :api_client
+
+    def initialize(api_client = DatadogAPIClient::APIClient.default)
+      @api_client = api_client
+    end
+
+    # Create a span-based metric.
+    #
+    # @see #create_spans_metric_with_http_info
+    def create_spans_metric(body, opts = {})
+      data, _status_code, _headers = create_spans_metric_with_http_info(body, opts)
+      data
+    end
+
+    # Create a span-based metric.
+    #
+    # Create a metric based on your ingested spans in your organization.
+    # Returns the span-based metric object from the request body when the request is successful.
+    #
+    # @param body [SpansMetricCreateRequest] The definition of the new span-based metric.
+    # @param opts [Hash] the optional parameters
+    # @return [Array<(SpansMetricResponse, Integer, Hash)>] SpansMetricResponse data, response status code and response headers
+    def create_spans_metric_with_http_info(body, opts = {})
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SpansMetricsAPI.create_spans_metric ...'
+      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 SpansMetricsAPI.create_spans_metric"
+      end
+      # resource path
+      local_var_path = '/api/v2/apm/config/metrics'
+
+      # 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] || 'SpansMetricResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]
+
+      new_options = opts.merge(
+        :operation => :create_spans_metric,
+        :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: SpansMetricsAPI#create_spans_metric\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Delete a span-based metric.
+    #
+    # @see #delete_spans_metric_with_http_info
+    def delete_spans_metric(metric_id, opts = {})
+      delete_spans_metric_with_http_info(metric_id, opts)
+      nil
+    end
+
+    # Delete a span-based metric.
+    #
+    # Delete a specific span-based metric from your organization.
+    #
+    # @param metric_id [String] The name of the span-based metric.
+    # @param opts [Hash] the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def delete_spans_metric_with_http_info(metric_id, opts = {})
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SpansMetricsAPI.delete_spans_metric ...'
+      end
+      # verify the required parameter 'metric_id' is set
+      if @api_client.config.client_side_validation && metric_id.nil?
+        fail ArgumentError, "Missing the required parameter 'metric_id' when calling SpansMetricsAPI.delete_spans_metric"
+      end
+      # resource path
+      local_var_path = '/api/v2/apm/config/metrics/{metric_id}'.sub('{metric_id}', CGI.escape(metric_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_spans_metric,
+        :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: SpansMetricsAPI#delete_spans_metric\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get a span-based metric.
+    #
+    # @see #get_spans_metric_with_http_info
+    def get_spans_metric(metric_id, opts = {})
+      data, _status_code, _headers = get_spans_metric_with_http_info(metric_id, opts)
+      data
+    end
+
+    # Get a span-based metric.
+    #
+    # Get a specific span-based metric from your organization.
+    #
+    # @param metric_id [String] The name of the span-based metric.
+    # @param opts [Hash] the optional parameters
+    # @return [Array<(SpansMetricResponse, Integer, Hash)>] SpansMetricResponse data, response status code and response headers
+    def get_spans_metric_with_http_info(metric_id, opts = {})
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SpansMetricsAPI.get_spans_metric ...'
+      end
+      # verify the required parameter 'metric_id' is set
+      if @api_client.config.client_side_validation && metric_id.nil?
+        fail ArgumentError, "Missing the required parameter 'metric_id' when calling SpansMetricsAPI.get_spans_metric"
+      end
+      # resource path
+      local_var_path = '/api/v2/apm/config/metrics/{metric_id}'.sub('{metric_id}', CGI.escape(metric_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] || 'SpansMetricResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]
+
+      new_options = opts.merge(
+        :operation => :get_spans_metric,
+        :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: SpansMetricsAPI#get_spans_metric\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get all span-based metrics.
+    #
+    # @see #list_spans_metrics_with_http_info
+    def list_spans_metrics(opts = {})
+      data, _status_code, _headers = list_spans_metrics_with_http_info(opts)
+      data
+    end
+
+    # Get all span-based metrics.
+    #
+    # Get the list of configured span-based metrics with their definitions.
+    #
+    # @param opts [Hash] the optional parameters
+    # @return [Array<(SpansMetricsResponse, Integer, Hash)>] SpansMetricsResponse data, response status code and response headers
+    def list_spans_metrics_with_http_info(opts = {})
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SpansMetricsAPI.list_spans_metrics ...'
+      end
+      # resource path
+      local_var_path = '/api/v2/apm/config/metrics'
+
+      # 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] || 'SpansMetricsResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]
+
+      new_options = opts.merge(
+        :operation => :list_spans_metrics,
+        :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: SpansMetricsAPI#list_spans_metrics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update a span-based metric.
+    #
+    # @see #update_spans_metric_with_http_info
+    def update_spans_metric(metric_id, body, opts = {})
+      data, _status_code, _headers = update_spans_metric_with_http_info(metric_id, body, opts)
+      data
+    end
+
+    # Update a span-based metric.
+    #
+    # Update a specific span-based metric from your organization.
+    # Returns the span-based metric object from the request body when the request is successful.
+    #
+    # @param metric_id [String] The name of the span-based metric.
+    # @param body [SpansMetricUpdateRequest] New definition of the span-based metric.
+    # @param opts [Hash] the optional parameters
+    # @return [Array<(SpansMetricResponse, Integer, Hash)>] SpansMetricResponse data, response status code and response headers
+    def update_spans_metric_with_http_info(metric_id, body, opts = {})
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SpansMetricsAPI.update_spans_metric ...'
+      end
+      # verify the required parameter 'metric_id' is set
+      if @api_client.config.client_side_validation && metric_id.nil?
+        fail ArgumentError, "Missing the required parameter 'metric_id' when calling SpansMetricsAPI.update_spans_metric"
+      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 SpansMetricsAPI.update_spans_metric"
+      end
+      # resource path
+      local_var_path = '/api/v2/apm/config/metrics/{metric_id}'.sub('{metric_id}', CGI.escape(metric_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'])
+      # 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] || 'SpansMetricResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]
+
+      new_options = opts.merge(
+        :operation => :update_spans_metric,
+        :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::Patch, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SpansMetricsAPI#update_spans_metric\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end