datadog_api_client 1.8.0 → 1.9.0

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

@@ -23,18 +23,18 @@ module DatadogAPIClient::V1
       @api_client = api_client
     end
 
-    # Create a pipeline
-    # Create a pipeline in your organization.
-    # @param body [LogsPipeline] Definition of the new pipeline.
-    # @param opts [Hash] the optional parameters
-    # @return [LogsPipeline]
+    # Create a pipeline.
+    #
+    # @see #create_logs_pipeline_with_http_info
     def create_logs_pipeline(body, opts = {})
       data, _status_code, _headers = create_logs_pipeline_with_http_info(body, opts)
       data
     end
 
-    # Create a pipeline
+    # Create a pipeline.
+    #
     # Create a pipeline in your organization.
+    #
     # @param body [LogsPipeline] Definition of the new pipeline.
     # @param opts [Hash] the optional parameters
     # @return [Array<(LogsPipeline, Integer, Hash)>] LogsPipeline data, response status code and response headers
@@ -91,27 +91,26 @@ 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: LogsPipelinesAPI#create_logs_pipeline\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # Delete a pipeline
-    # Delete a given pipeline from your organization.
-    # This endpoint takes no JSON arguments.
-    # @param pipeline_id [String] ID of the pipeline to delete.
-    # @param opts [Hash] the optional parameters
-    # @return [nil]
+    # Delete a pipeline.
+    #
+    # @see #delete_logs_pipeline_with_http_info
     def delete_logs_pipeline(pipeline_id, opts = {})
       delete_logs_pipeline_with_http_info(pipeline_id, opts)
       nil
     end
 
-    # Delete a pipeline
+    # Delete a pipeline.
+    #
     # Delete a given pipeline from your organization.
     # This endpoint takes no JSON arguments.
+    #
     # @param pipeline_id [String] ID of the pipeline to delete.
     # @param opts [Hash] the optional parameters
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
@@ -166,27 +165,26 @@ module DatadogAPIClient::V1
         :return_type => return_type
       )
 
-      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+      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: LogsPipelinesAPI#delete_logs_pipeline\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # Get a pipeline
-    # Get a specific pipeline from your organization.
-    # This endpoint takes no JSON arguments.
-    # @param pipeline_id [String] ID of the pipeline to get.
-    # @param opts [Hash] the optional parameters
-    # @return [LogsPipeline]
+    # Get a pipeline.
+    #
+    # @see #get_logs_pipeline_with_http_info
     def get_logs_pipeline(pipeline_id, opts = {})
       data, _status_code, _headers = get_logs_pipeline_with_http_info(pipeline_id, opts)
       data
     end
 
-    # Get a pipeline
+    # Get a pipeline.
+    #
     # Get a specific pipeline from your organization.
     # This endpoint takes no JSON arguments.
+    #
     # @param pipeline_id [String] ID of the pipeline to get.
     # @param opts [Hash] the optional parameters
     # @return [Array<(LogsPipeline, Integer, Hash)>] LogsPipeline data, response status code and response headers
@@ -241,26 +239,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: LogsPipelinesAPI#get_logs_pipeline\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # Get pipeline order
-    # Get the current order of your pipelines.
-    # This endpoint takes no JSON arguments.
-    # @param opts [Hash] the optional parameters
-    # @return [LogsPipelinesOrder]
+    # Get pipeline order.
+    #
+    # @see #get_logs_pipeline_order_with_http_info
     def get_logs_pipeline_order(opts = {})
       data, _status_code, _headers = get_logs_pipeline_order_with_http_info(opts)
       data
     end
 
-    # Get pipeline order
+    # Get pipeline order.
+    #
     # Get the current order of your pipelines.
     # This endpoint takes no JSON arguments.
+    #
     # @param opts [Hash] the optional parameters
     # @return [Array<(LogsPipelinesOrder, Integer, Hash)>] LogsPipelinesOrder data, response status code and response headers
     def get_logs_pipeline_order_with_http_info(opts = {})
@@ -310,26 +308,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: LogsPipelinesAPI#get_logs_pipeline_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # Get all pipelines
-    # Get all pipelines from your organization.
-    # This endpoint takes no JSON arguments.
-    # @param opts [Hash] the optional parameters
-    # @return [Array<LogsPipeline>]
+    # Get all pipelines.
+    #
+    # @see #list_logs_pipelines_with_http_info
     def list_logs_pipelines(opts = {})
       data, _status_code, _headers = list_logs_pipelines_with_http_info(opts)
       data
     end
 
-    # Get all pipelines
+    # Get all pipelines.
+    #
     # Get all pipelines from your organization.
     # This endpoint takes no JSON arguments.
+    #
     # @param opts [Hash] the optional parameters
     # @return [Array<(Array<LogsPipeline>, Integer, Hash)>] Array<LogsPipeline> data, response status code and response headers
     def list_logs_pipelines_with_http_info(opts = {})
@@ -379,32 +377,28 @@ 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: LogsPipelinesAPI#list_logs_pipelines\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # Update a pipeline
-    # Update a given pipeline configuration to change it’s processors or their order.
+    # Update a pipeline.
     #
-    # **Note**: Using this method updates your pipeline configuration by **replacing**
-    # your current configuration with the new one sent to your Datadog organization.
-    # @param pipeline_id [String] ID of the pipeline to delete.
-    # @param body [LogsPipeline] New definition of the pipeline.
-    # @param opts [Hash] the optional parameters
-    # @return [LogsPipeline]
+    # @see #update_logs_pipeline_with_http_info
     def update_logs_pipeline(pipeline_id, body, opts = {})
       data, _status_code, _headers = update_logs_pipeline_with_http_info(pipeline_id, body, opts)
       data
     end
 
-    # Update a pipeline
+    # Update a pipeline.
+    #
     # Update a given pipeline configuration to change it’s processors or their order.
     #
     # **Note**: Using this method updates your pipeline configuration by **replacing**
     # your current configuration with the new one sent to your Datadog organization.
+    #
     # @param pipeline_id [String] ID of the pipeline to delete.
     # @param body [LogsPipeline] New definition of the pipeline.
     # @param opts [Hash] the optional parameters
@@ -466,33 +460,29 @@ 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: LogsPipelinesAPI#update_logs_pipeline\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # Update pipeline order
-    # Update the order of your pipelines. Since logs are processed sequentially, reordering a pipeline may change
-    # the structure and content of the data processed by other pipelines and their processors.
+    # Update pipeline order.
     #
-    # **Note**: Using the `PUT` method updates your pipeline order by replacing your current order
-    # with the new one sent to your Datadog organization.
-    # @param body [LogsPipelinesOrder] Object containing the new ordered list of pipeline IDs.
-    # @param opts [Hash] the optional parameters
-    # @return [LogsPipelinesOrder]
+    # @see #update_logs_pipeline_order_with_http_info
     def update_logs_pipeline_order(body, opts = {})
       data, _status_code, _headers = update_logs_pipeline_order_with_http_info(body, opts)
       data
     end
 
-    # Update pipeline order
+    # Update pipeline order.
+    #
     # Update the order of your pipelines. Since logs are processed sequentially, reordering a pipeline may change
     # the structure and content of the data processed by other pipelines and their processors.
     #
     # **Note**: Using the `PUT` method updates your pipeline order by replacing your current order
     # with the new one sent to your Datadog organization.
+    #
     # @param body [LogsPipelinesOrder] Object containing the new ordered list of pipeline IDs.
     # @param opts [Hash] the optional parameters
     # @return [Array<(LogsPipelinesOrder, Integer, Hash)>] LogsPipelinesOrder data, response status code and response headers
@@ -549,7 +539,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: LogsPipelinesAPI#update_logs_pipeline_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end

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,35 +327,23 @@ 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).
-    #
-    # If you’re submitting metrics directly to the Datadog API without using DogStatsD, expect:
+    # Submit metrics.
     #
-    # - 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] 
-    # @param opts [Hash] the optional parameters
-    # @option opts [MetricContentEncoding] :content_encoding HTTP header used to compress the media-type.
-    # @return [IntakePayloadAccepted]
+    # @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).
     #
@@ -367,10 +351,11 @@ module DatadogAPIClient::V1
     #
     # - 64 bits for the timestamp
     # - 32 bits for the value
-    # - 20 bytes for the metric names
+    # - 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 +418,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 +498,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