datadog_api_client 1.8.0 → 1.11.0

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

@@ -23,25 +23,16 @@ module DatadogAPIClient::V1
       @api_client = api_client
     end
 
-    # Search logs
-    # List endpoint returns logs that match a log search query.
-    # [Results are paginated][1].
+    # Search logs.
     #
-    # **If you are considering archiving logs for your organization,
-    # consider use of the Datadog archive capabilities instead of the log list API.
-    # See [Datadog Logs Archive documentation][2].**
-    #
-    # [1]: /logs/guide/collect-multiple-logs-with-pagination
-    # [2]: https://docs.datadoghq.com/logs/archives
-    # @param body [LogsListRequest] Logs filter
-    # @param opts [Hash] the optional parameters
-    # @return [LogsListResponse]
+    # @see #list_logs_with_http_info
     def list_logs(body, opts = {})
       data, _status_code, _headers = list_logs_with_http_info(body, opts)
       data
     end
 
-    # Search logs
+    # Search logs.
+    #
     # List endpoint returns logs that match a log search query.
     # [Results are paginated][1].
     #
@@ -51,6 +42,7 @@ module DatadogAPIClient::V1
     #
     # [1]: /logs/guide/collect-multiple-logs-with-pagination
     # [2]: https://docs.datadoghq.com/logs/archives
+    #
     # @param body [LogsListRequest] Logs filter
     # @param opts [Hash] the optional parameters
     # @return [Array<(LogsListResponse, Integer, Hash)>] LogsListResponse data, response status code and response headers
@@ -107,44 +99,23 @@ 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: LogsAPI#list_logs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # Send logs
-    # Send your logs to your Datadog platform over HTTP. Limits per HTTP request are:
-    #
-    # - Maximum content size per payload (uncompressed): 5MB
-    # - Maximum size for a single log: 1MB
-    # - Maximum array size if sending multiple logs in an array: 1000 entries
-    #
-    # Any log exceeding 1MB is accepted and truncated by Datadog:
-    # - For a single log request, the API truncates the log at 1MB and returns a 2xx.
-    # - For a multi-logs request, the API processes all logs, truncates only logs larger than 1MB, and returns a 2xx.
+    # Send logs.
     #
-    # Datadog recommends sending your logs compressed.
-    # Add the `Content-Encoding: gzip` header to the request when sending compressed logs.
-    #
-    # The status codes answered by the HTTP API are:
-    # - 200: OK
-    # - 400: Bad request (likely an issue in the payload formatting)
-    # - 403: Permission issue (likely using an invalid API Key)
-    # - 413: Payload too large (batch is above 5MB uncompressed)
-    # - 5xx: Internal error, request should be retried after some time
-    # @param body [Array<HTTPLogItem>] Log to send (JSON format).
-    # @param opts [Hash] the optional parameters
-    # @option opts [ContentEncoding] :content_encoding HTTP header used to compress the media-type.
-    # @option opts [String] :ddtags Log tags can be passed as query parameters with `text/plain` content type.
-    # @return [Object]
+    # @see #submit_log_with_http_info
     def submit_log(body, opts = {})
       data, _status_code, _headers = submit_log_with_http_info(body, opts)
       data
     end
 
-    # Send logs
+    # Send logs.
+    #
     # Send your logs to your Datadog platform over HTTP. Limits per HTTP request are:
     #
     # - Maximum content size per payload (uncompressed): 5MB
@@ -164,6 +135,7 @@ module DatadogAPIClient::V1
     # - 403: Permission issue (likely using an invalid API Key)
     # - 413: Payload too large (batch is above 5MB uncompressed)
     # - 5xx: Internal error, request should be retried after some time
+    #
     # @param body [Array<HTTPLogItem>] Log to send (JSON format).
     # @param opts [Hash] the optional parameters
     # @option opts [ContentEncoding] :content_encoding HTTP header used to compress the media-type.
@@ -228,7 +200,7 @@ 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: LogsAPI#submit_log\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end

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

@@ -23,18 +23,18 @@ module DatadogAPIClient::V1
       @api_client = api_client
     end
 
-    # Create an index
-    # Creates a new index. Returns the Index object passed in the request body when the request is successful.
-    # @param body [LogsIndex] Object containing the new index.
-    # @param opts [Hash] the optional parameters
-    # @return [LogsIndex]
+    # Create an index.
+    #
+    # @see #create_logs_index_with_http_info
     def create_logs_index(body, opts = {})
       data, _status_code, _headers = create_logs_index_with_http_info(body, opts)
       data
     end
 
-    # Create an index
+    # Create an index.
+    #
     # Creates a new index. Returns the Index object passed in the request body when the request is successful.
+    #
     # @param body [LogsIndex] Object containing the new index.
     # @param opts [Hash] the optional parameters
     # @return [Array<(LogsIndex, Integer, Hash)>] LogsIndex data, response status code and response headers
@@ -91,25 +91,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: LogsIndexesAPI#create_logs_index\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # Get an index
-    # Get one log index from your organization. This endpoint takes no JSON arguments.
-    # @param name [String] Name of the log index.
-    # @param opts [Hash] the optional parameters
-    # @return [LogsIndex]
+    # Get an index.
+    #
+    # @see #get_logs_index_with_http_info
     def get_logs_index(name, opts = {})
       data, _status_code, _headers = get_logs_index_with_http_info(name, opts)
       data
     end
 
-    # Get an index
+    # Get an index.
+    #
     # Get one log index from your organization. This endpoint takes no JSON arguments.
+    #
     # @param name [String] Name of the log index.
     # @param opts [Hash] the optional parameters
     # @return [Array<(LogsIndex, Integer, Hash)>] LogsIndex data, response status code and response headers
@@ -164,24 +164,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: LogsIndexesAPI#get_logs_index\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # Get indexes order
-    # Get the current order of your log indexes. This endpoint takes no JSON arguments.
-    # @param opts [Hash] the optional parameters
-    # @return [LogsIndexesOrder]
+    # Get indexes order.
+    #
+    # @see #get_logs_index_order_with_http_info
     def get_logs_index_order(opts = {})
       data, _status_code, _headers = get_logs_index_order_with_http_info(opts)
       data
     end
 
-    # Get indexes order
+    # Get indexes order.
+    #
     # Get the current order of your log indexes. This endpoint takes no JSON arguments.
+    #
     # @param opts [Hash] the optional parameters
     # @return [Array<(LogsIndexesOrder, Integer, Hash)>] LogsIndexesOrder data, response status code and response headers
     def get_logs_index_order_with_http_info(opts = {})
@@ -231,26 +232,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: LogsIndexesAPI#get_logs_index_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # Get all indexes
-    # The Index object describes the configuration of a log index.
-    # This endpoint returns an array of the `LogIndex` objects of your organization.
-    # @param opts [Hash] the optional parameters
-    # @return [LogsIndexListResponse]
+    # Get all indexes.
+    #
+    # @see #list_log_indexes_with_http_info
     def list_log_indexes(opts = {})
       data, _status_code, _headers = list_log_indexes_with_http_info(opts)
       data
     end
 
-    # Get all indexes
+    # Get all indexes.
+    #
     # The Index object describes the configuration of a log index.
     # This endpoint returns an array of the `LogIndex` objects of your organization.
+    #
     # @param opts [Hash] the optional parameters
     # @return [Array<(LogsIndexListResponse, Integer, Hash)>] LogsIndexListResponse data, response status code and response headers
     def list_log_indexes_with_http_info(opts = {})
@@ -300,34 +301,29 @@ 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: LogsIndexesAPI#list_log_indexes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # Update an index
-    # Update an index as identified by its name.
-    # Returns the Index object passed in the request body when the request is successful.
+    # Update an index.
     #
-    # Using the `PUT` method updates your index’s configuration by **replacing**
-    # your current configuration with the new one sent to your Datadog organization.
-    # @param name [String] Name of the log index.
-    # @param body [LogsIndexUpdateRequest] Object containing the new `LogsIndexUpdateRequest`.
-    # @param opts [Hash] the optional parameters
-    # @return [LogsIndex]
+    # @see #update_logs_index_with_http_info
     def update_logs_index(name, body, opts = {})
       data, _status_code, _headers = update_logs_index_with_http_info(name, body, opts)
       data
     end
 
-    # Update an index
+    # Update an index.
+    #
     # Update an index as identified by its name.
     # Returns the Index object passed in the request body when the request is successful.
     #
     # Using the `PUT` method updates your index’s configuration by **replacing**
     # your current configuration with the new one sent to your Datadog organization.
+    #
     # @param name [String] Name of the log index.
     # @param body [LogsIndexUpdateRequest] Object containing the new `LogsIndexUpdateRequest`.
     # @param opts [Hash] the optional parameters
@@ -389,27 +385,26 @@ 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: LogsIndexesAPI#update_logs_index\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # Update indexes order
-    # This endpoint updates the index order of your organization.
-    # It returns the index order object passed in the request body when the request is successful.
-    # @param body [LogsIndexesOrder] Object containing the new ordered list of index names
-    # @param opts [Hash] the optional parameters
-    # @return [LogsIndexesOrder]
+    # Update indexes order.
+    #
+    # @see #update_logs_index_order_with_http_info
     def update_logs_index_order(body, opts = {})
       data, _status_code, _headers = update_logs_index_order_with_http_info(body, opts)
       data
     end
 
-    # Update indexes order
+    # Update indexes order.
+    #
     # This endpoint updates the index order of your organization.
     # It returns the index order object passed in the request body when the request is successful.
+    #
     # @param body [LogsIndexesOrder] Object containing the new ordered list of index names
     # @param opts [Hash] the optional parameters
     # @return [Array<(LogsIndexesOrder, Integer, Hash)>] LogsIndexesOrder data, response status code and response headers
@@ -466,7 +461,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: LogsIndexesAPI#update_logs_index_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end

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