datadog_api_client 1.8.0 → 1.11.0

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

@@ -23,18 +23,18 @@ module DatadogAPIClient::V1
       @api_client = api_client
     end
 
-    # Get metric metadata
-    # Get metadata about a specific metric.
-    # @param metric_name [String] Name of the metric for which to get metadata.
-    # @param opts [Hash] the optional parameters
-    # @return [MetricMetadata]
+    # Get metric metadata.
+    #
+    # @see #get_metric_metadata_with_http_info
     def get_metric_metadata(metric_name, opts = {})
       data, _status_code, _headers = get_metric_metadata_with_http_info(metric_name, opts)
       data
     end
 
-    # Get metric metadata
+    # Get metric metadata.
+    #
     # Get metadata about a specific metric.
+    #
     # @param metric_name [String] Name of the metric for which to get metadata.
     # @param opts [Hash] the optional parameters
     # @return [Array<(MetricMetadata, Integer, Hash)>] MetricMetadata data, response status code and response headers
@@ -89,27 +89,25 @@ module DatadogAPIClient::V1
         :return_type => return_type
       )
 
-      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      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: MetricsAPI#get_metric_metadata\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # Get active metrics list
-    # Get the list of actively reporting metrics from a given time until now.
-    # @param from [Integer] Seconds since the Unix epoch.
-    # @param opts [Hash] the optional parameters
-    # @option opts [String] :host Hostname for filtering the list of metrics returned. If set, metrics retrieved are those with the corresponding hostname tag.
-    # @option opts [String] :tag_filter Filter metrics that have been submitted with the given tags. Supports boolean and wildcard expressions. Cannot be combined with other filters.
-    # @return [MetricsListResponse]
+    # Get active metrics list.
+    #
+    # @see #list_active_metrics_with_http_info
     def list_active_metrics(from, opts = {})
       data, _status_code, _headers = list_active_metrics_with_http_info(from, opts)
       data
     end
 
-    # Get active metrics list
+    # Get active metrics list.
+    #
     # Get the list of actively reporting metrics from a given time until now.
+    #
     # @param from [Integer] Seconds since the Unix epoch.
     # @param opts [Hash] the optional parameters
     # @option opts [String] :host Hostname for filtering the list of metrics returned. If set, metrics retrieved are those with the corresponding hostname tag.
@@ -169,26 +167,26 @@ module DatadogAPIClient::V1
         :return_type => return_type
       )
 
-      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      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: MetricsAPI#list_active_metrics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # Search metrics
-    # Search for metrics from the last 24 hours in Datadog.
-    # @param q [String] Query string to search metrics upon. Must be prefixed with `metrics:`.
-    # @param opts [Hash] the optional parameters
-    # @return [MetricSearchResponse]
+    # Search metrics.
+    #
+    # @see #list_metrics_with_http_info
     def list_metrics(q, opts = {})
       data, _status_code, _headers = list_metrics_with_http_info(q, opts)
       data
     end
 
-    # Search metrics
+    # Search metrics.
+    #
     # Search for metrics from the last 24 hours in Datadog.
-    # @param q [String] Query string to search metrics upon. Must be prefixed with `metrics:`.
+    #
+    # @param q [String] Query string to search metrics upon. Can optionally be prefixed with `metrics:`.
     # @param opts [Hash] the optional parameters
     # @return [Array<(MetricSearchResponse, Integer, Hash)>] MetricSearchResponse data, response status code and response headers
     def list_metrics_with_http_info(q, opts = {})
@@ -243,27 +241,25 @@ module DatadogAPIClient::V1
         :return_type => return_type
       )
 
-      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      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: MetricsAPI#list_metrics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # Query timeseries points
     # Query timeseries points.
-    # @param from [Integer] Start of the queried time period, seconds since the Unix epoch.
-    # @param to [Integer] End of the queried time period, seconds since the Unix epoch.
-    # @param query [String] Query string.
-    # @param opts [Hash] the optional parameters
-    # @return [MetricsQueryResponse]
+    #
+    # @see #query_metrics_with_http_info
     def query_metrics(from, to, query, opts = {})
       data, _status_code, _headers = query_metrics_with_http_info(from, to, query, opts)
       data
     end
 
-    # Query timeseries points
     # Query timeseries points.
+    #
+    # Query timeseries points.
+    #
     # @param from [Integer] Start of the queried time period, seconds since the Unix epoch.
     # @param to [Integer] End of the queried time period, seconds since the Unix epoch.
     # @param query [String] Query string.
@@ -331,46 +327,116 @@ module DatadogAPIClient::V1
         :return_type => return_type
       )
 
-      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      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: MetricsAPI#query_metrics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # Submit metrics
-    # The metrics end-point allows you to post time-series data that can be graphed on Datadog’s dashboards.
-    # The maximum payload size is 3.2 megabytes (3200000 bytes). Compressed payloads must have a decompressed size of less than 62 megabytes (62914560 bytes).
+    # Submit distribution points.
     #
-    # If you’re submitting metrics directly to the Datadog API without using DogStatsD, expect:
+    # @see #submit_distribution_points_with_http_info
+    def submit_distribution_points(body, opts = {})
+      data, _status_code, _headers = submit_distribution_points_with_http_info(body, opts)
+      data
+    end
+
+    # Submit distribution points.
     #
-    # - 64 bits for the timestamp
-    # - 32 bits for the value
-    # - 20 bytes for the metric names
-    # - 50 bytes for the timeseries
-    # - The full payload is approximately 100 bytes. However, with the DogStatsD API,
-    # compression is applied, which reduces the payload size.
-    # @param body [MetricsPayload] 
+    # The distribution points end-point allows you to post distribution data that can be graphed on Datadog’s dashboards.
+    #
+    # @param body [DistributionPointsPayload] 
     # @param opts [Hash] the optional parameters
-    # @option opts [MetricContentEncoding] :content_encoding HTTP header used to compress the media-type.
-    # @return [IntakePayloadAccepted]
+    # @option opts [DistributionPointsContentEncoding] :content_encoding HTTP header used to compress the media-type.
+    # @return [Array<(IntakePayloadAccepted, Integer, Hash)>] IntakePayloadAccepted data, response status code and response headers
+    def submit_distribution_points_with_http_info(body, opts = {})
+
+      if @api_client.config.unstable_operations.has_key?(:submit_distribution_points)
+        unstable_enabled = @api_client.config.unstable_operations[:submit_distribution_points]
+        if unstable_enabled
+          @api_client.config.logger.warn format("Using unstable operation '%s'", "submit_distribution_points")
+        else
+          raise APIError.new(message: format("Unstable operation '%s' is disabled", "submit_distribution_points"))
+        end
+      end
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MetricsAPI.submit_distribution_points ...'
+      end
+      allowable_values = ['deflate']
+      if @api_client.config.client_side_validation && opts[:'content_encoding'] && !allowable_values.include?(opts[:'content_encoding'])
+        fail ArgumentError, "invalid value for \"content_encoding\", must be one of #{allowable_values}"
+      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 MetricsAPI.submit_distribution_points"
+      end
+      # resource path
+      local_var_path = '/api/v1/distribution_points'
+
+      # 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(['text/json', 'application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['text/json'])
+      header_params['Content-Encoding'] = opts[:'content_encoding'] if !opts[:'content_encoding'].nil?
+
+      # 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] || 'IntakePayloadAccepted'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || [:apiKeyAuth]
+
+      new_options = opts.merge(
+        :operation => :submit_distribution_points,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      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: MetricsAPI#submit_distribution_points\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Submit metrics.
+    #
+    # @see #submit_metrics_with_http_info
     def submit_metrics(body, opts = {})
       data, _status_code, _headers = submit_metrics_with_http_info(body, opts)
       data
     end
 
-    # Submit metrics
+    # Submit metrics.
+    #
     # The metrics end-point allows you to post time-series data that can be graphed on Datadog’s dashboards.
     # The maximum payload size is 3.2 megabytes (3200000 bytes). Compressed payloads must have a decompressed size of less than 62 megabytes (62914560 bytes).
     #
     # If you’re submitting metrics directly to the Datadog API without using DogStatsD, expect:
     #
     # - 64 bits for the timestamp
-    # - 32 bits for the value
-    # - 20 bytes for the metric names
+    # - 64 bits for the value
+    # - 40 bytes for the metric names
     # - 50 bytes for the timeseries
     # - The full payload is approximately 100 bytes. However, with the DogStatsD API,
     # compression is applied, which reduces the payload size.
+    #
     # @param body [MetricsPayload] 
     # @param opts [Hash] the optional parameters
     # @option opts [MetricContentEncoding] :content_encoding HTTP header used to compress the media-type.
@@ -433,26 +499,25 @@ module DatadogAPIClient::V1
         :return_type => return_type
       )
 
-      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      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: MetricsAPI#submit_metrics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # Edit metric metadata
-    # Edit metadata of a specific metric. Find out more about [supported types](https://docs.datadoghq.com/developers/metrics).
-    # @param metric_name [String] Name of the metric for which to edit metadata.
-    # @param body [MetricMetadata] New metadata.
-    # @param opts [Hash] the optional parameters
-    # @return [MetricMetadata]
+    # Edit metric metadata.
+    #
+    # @see #update_metric_metadata_with_http_info
     def update_metric_metadata(metric_name, body, opts = {})
       data, _status_code, _headers = update_metric_metadata_with_http_info(metric_name, body, opts)
       data
     end
 
-    # Edit metric metadata
+    # Edit metric metadata.
+    #
     # Edit metadata of a specific metric. Find out more about [supported types](https://docs.datadoghq.com/developers/metrics).
+    #
     # @param metric_name [String] Name of the metric for which to edit metadata.
     # @param body [MetricMetadata] New metadata.
     # @param opts [Hash] the optional parameters
@@ -514,7 +579,7 @@ module DatadogAPIClient::V1
         :return_type => return_type
       )
 
-      data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
+      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: MetricsAPI#update_metric_metadata\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end