datadog_api_client 1.7.0 → 1.10.0

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

@@ -5,7 +5,7 @@
 
 The version of the OpenAPI document: 1.0
 Contact: support@datadoghq.com
-Generated by: https://openapi-generator.tech
+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/).
@@ -22,22 +22,22 @@ module DatadogAPIClient::V2
     def initialize(api_client = APIClient.default)
       @api_client = api_client
     end
-    # Grant role to an archive
-    # Adds a read role to an archive. ([Roles API](https://docs.datadoghq.com/api/v2/roles/))
-    # @param archive_id [String] The ID of the archive.
-    # @param body [RelationshipToRole] 
-    # @param [Hash] opts the optional parameters
-    # @return [nil]
+
+    # Grant role to an archive.
+    #
+    # @see #add_read_role_to_archive_with_http_info
     def add_read_role_to_archive(archive_id, body, opts = {})
       add_read_role_to_archive_with_http_info(archive_id, body, opts)
       nil
     end
 
-    # Grant role to an archive
+    # Grant role to an archive.
+    #
     # Adds a read role to an archive. ([Roles API](https://docs.datadoghq.com/api/v2/roles/))
+    #
     # @param archive_id [String] The ID of the archive.
     # @param body [RelationshipToRole] 
-    # @param [Hash] opts the optional parameters
+    # @param opts [Hash] the optional parameters
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
     def add_read_role_to_archive_with_http_info(archive_id, body, opts = {})
 
@@ -62,7 +62,7 @@ module DatadogAPIClient::V2
         fail ArgumentError, "Missing the required parameter 'body' when calling LogsArchivesAPI.add_read_role_to_archive"
       end
       # resource path
-      local_var_path = '/api/v2/logs/config/archives/{archive_id}/readers'.sub('{' + 'archive_id' + '}', CGI.escape(archive_id.to_s))
+      local_var_path = '/api/v2/logs/config/archives/{archive_id}/readers'.sub('{archive_id}', CGI.escape(archive_id.to_s).gsub('%2F', '/'))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -70,7 +70,7 @@ module DatadogAPIClient::V2
       # header parameters
       header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params['Accept'] = @api_client.select_header_accept(['*/*'])
       # HTTP header 'Content-Type'
       header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
 
@@ -96,27 +96,27 @@ module DatadogAPIClient::V2
         :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: LogsArchivesAPI#add_read_role_to_archive\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # Create an archive
-    # Create an archive in your organization.
-    # @param body [LogsArchiveCreateRequest] The definition of the new archive.
-    # @param [Hash] opts the optional parameters
-    # @return [LogsArchive]
+    # Create an archive.
+    #
+    # @see #create_logs_archive_with_http_info
     def create_logs_archive(body, opts = {})
       data, _status_code, _headers = create_logs_archive_with_http_info(body, opts)
       data
     end
 
-    # Create an archive
+    # Create an archive.
+    #
     # Create an archive in your organization.
+    #
     # @param body [LogsArchiveCreateRequest] The definition of the new archive.
-    # @param [Hash] opts the optional parameters
+    # @param opts [Hash] the optional parameters
     # @return [Array<(LogsArchive, Integer, Hash)>] LogsArchive data, response status code and response headers
     def create_logs_archive_with_http_info(body, opts = {})
 
@@ -171,27 +171,27 @@ module DatadogAPIClient::V2
         :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: LogsArchivesAPI#create_logs_archive\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # Delete an archive
-    # Delete a given archive from your organization.
-    # @param archive_id [String] The ID of the archive.
-    # @param [Hash] opts the optional parameters
-    # @return [nil]
+    # Delete an archive.
+    #
+    # @see #delete_logs_archive_with_http_info
     def delete_logs_archive(archive_id, opts = {})
       delete_logs_archive_with_http_info(archive_id, opts)
       nil
     end
 
-    # Delete an archive
+    # Delete an archive.
+    #
     # Delete a given archive from your organization.
+    #
     # @param archive_id [String] The ID of the archive.
-    # @param [Hash] opts the optional parameters
+    # @param opts [Hash] the optional parameters
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
     def delete_logs_archive_with_http_info(archive_id, opts = {})
 
@@ -212,7 +212,7 @@ module DatadogAPIClient::V2
         fail ArgumentError, "Missing the required parameter 'archive_id' when calling LogsArchivesAPI.delete_logs_archive"
       end
       # resource path
-      local_var_path = '/api/v2/logs/config/archives/{archive_id}'.sub('{' + 'archive_id' + '}', CGI.escape(archive_id.to_s))
+      local_var_path = '/api/v2/logs/config/archives/{archive_id}'.sub('{archive_id}', CGI.escape(archive_id.to_s).gsub('%2F', '/'))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -220,7 +220,7 @@ module DatadogAPIClient::V2
       # header parameters
       header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params['Accept'] = @api_client.select_header_accept(['*/*'])
 
       # form parameters
       form_params = opts[:form_params] || {}
@@ -244,27 +244,27 @@ module DatadogAPIClient::V2
         :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: LogsArchivesAPI#delete_logs_archive\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # Get an archive
-    # Get a specific archive from your organization.
-    # @param archive_id [String] The ID of the archive.
-    # @param [Hash] opts the optional parameters
-    # @return [LogsArchive]
+    # Get an archive.
+    #
+    # @see #get_logs_archive_with_http_info
     def get_logs_archive(archive_id, opts = {})
       data, _status_code, _headers = get_logs_archive_with_http_info(archive_id, opts)
       data
     end
 
-    # Get an archive
+    # Get an archive.
+    #
     # Get a specific archive from your organization.
+    #
     # @param archive_id [String] The ID of the archive.
-    # @param [Hash] opts the optional parameters
+    # @param opts [Hash] the optional parameters
     # @return [Array<(LogsArchive, Integer, Hash)>] LogsArchive data, response status code and response headers
     def get_logs_archive_with_http_info(archive_id, opts = {})
 
@@ -285,7 +285,7 @@ module DatadogAPIClient::V2
         fail ArgumentError, "Missing the required parameter 'archive_id' when calling LogsArchivesAPI.get_logs_archive"
       end
       # resource path
-      local_var_path = '/api/v2/logs/config/archives/{archive_id}'.sub('{' + 'archive_id' + '}', CGI.escape(archive_id.to_s))
+      local_var_path = '/api/v2/logs/config/archives/{archive_id}'.sub('{archive_id}', CGI.escape(archive_id.to_s).gsub('%2F', '/'))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -305,7 +305,7 @@ module DatadogAPIClient::V2
       return_type = opts[:debug_return_type] || 'LogsArchive'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || [:AuthZ, :apiKeyAuth, :appKeyAuth]
+      auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]
 
       new_options = opts.merge(
         :operation => :get_logs_archive,
@@ -317,25 +317,27 @@ module DatadogAPIClient::V2
         :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: LogsArchivesAPI#get_logs_archive\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # Get archive order
-    # Get the current order of your archives. This endpoint takes no JSON arguments.
-    # @param [Hash] opts the optional parameters
-    # @return [LogsArchiveOrder]
+    # Get archive order.
+    #
+    # @see #get_logs_archive_order_with_http_info
     def get_logs_archive_order(opts = {})
       data, _status_code, _headers = get_logs_archive_order_with_http_info(opts)
       data
     end
 
-    # Get archive order
-    # Get the current order of your archives. This endpoint takes no JSON arguments.
-    # @param [Hash] opts the optional parameters
+    # Get archive order.
+    #
+    # Get the current order of your archives.
+    # This endpoint takes no JSON arguments.
+    #
+    # @param opts [Hash] the optional parameters
     # @return [Array<(LogsArchiveOrder, Integer, Hash)>] LogsArchiveOrder data, response status code and response headers
     def get_logs_archive_order_with_http_info(opts = {})
 
@@ -372,7 +374,7 @@ module DatadogAPIClient::V2
       return_type = opts[:debug_return_type] || 'LogsArchiveOrder'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || [:AuthZ, :apiKeyAuth, :appKeyAuth]
+      auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]
 
       new_options = opts.merge(
         :operation => :get_logs_archive_order,
@@ -384,27 +386,27 @@ module DatadogAPIClient::V2
         :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: LogsArchivesAPI#get_logs_archive_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # List read roles for an archive
-    # Returns all read roles a given archive is restricted to.
-    # @param archive_id [String] The ID of the archive.
-    # @param [Hash] opts the optional parameters
-    # @return [RolesResponse]
+    # List read roles for an archive.
+    #
+    # @see #list_archive_read_roles_with_http_info
     def list_archive_read_roles(archive_id, opts = {})
       data, _status_code, _headers = list_archive_read_roles_with_http_info(archive_id, opts)
       data
     end
 
-    # List read roles for an archive
+    # List read roles for an archive.
+    #
     # Returns all read roles a given archive is restricted to.
+    #
     # @param archive_id [String] The ID of the archive.
-    # @param [Hash] opts the optional parameters
+    # @param opts [Hash] the optional parameters
     # @return [Array<(RolesResponse, Integer, Hash)>] RolesResponse data, response status code and response headers
     def list_archive_read_roles_with_http_info(archive_id, opts = {})
 
@@ -425,7 +427,7 @@ module DatadogAPIClient::V2
         fail ArgumentError, "Missing the required parameter 'archive_id' when calling LogsArchivesAPI.list_archive_read_roles"
       end
       # resource path
-      local_var_path = '/api/v2/logs/config/archives/{archive_id}/readers'.sub('{' + 'archive_id' + '}', CGI.escape(archive_id.to_s))
+      local_var_path = '/api/v2/logs/config/archives/{archive_id}/readers'.sub('{archive_id}', CGI.escape(archive_id.to_s).gsub('%2F', '/'))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -445,7 +447,7 @@ module DatadogAPIClient::V2
       return_type = opts[:debug_return_type] || 'RolesResponse'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || [:AuthZ, :apiKeyAuth, :appKeyAuth]
+      auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]
 
       new_options = opts.merge(
         :operation => :list_archive_read_roles,
@@ -457,25 +459,26 @@ module DatadogAPIClient::V2
         :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: LogsArchivesAPI#list_archive_read_roles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # Get all archives
-    # Get the list of configured logs archives with their definitions.
-    # @param [Hash] opts the optional parameters
-    # @return [LogsArchives]
+    # Get all archives.
+    #
+    # @see #list_logs_archives_with_http_info
     def list_logs_archives(opts = {})
       data, _status_code, _headers = list_logs_archives_with_http_info(opts)
       data
     end
 
-    # Get all archives
+    # Get all archives.
+    #
     # Get the list of configured logs archives with their definitions.
-    # @param [Hash] opts the optional parameters
+    #
+    # @param opts [Hash] the optional parameters
     # @return [Array<(LogsArchives, Integer, Hash)>] LogsArchives data, response status code and response headers
     def list_logs_archives_with_http_info(opts = {})
 
@@ -512,7 +515,7 @@ module DatadogAPIClient::V2
       return_type = opts[:debug_return_type] || 'LogsArchives'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || [:AuthZ, :apiKeyAuth, :appKeyAuth]
+      auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]
 
       new_options = opts.merge(
         :operation => :list_logs_archives,
@@ -524,29 +527,28 @@ module DatadogAPIClient::V2
         :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: LogsArchivesAPI#list_logs_archives\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # Revoke role from an archive
-    # Removes a role from an archive. ([Roles API](https://docs.datadoghq.com/api/v2/roles/))
-    # @param archive_id [String] The ID of the archive.
-    # @param body [RelationshipToRole] 
-    # @param [Hash] opts the optional parameters
-    # @return [nil]
+    # Revoke role from an archive.
+    #
+    # @see #remove_role_from_archive_with_http_info
     def remove_role_from_archive(archive_id, body, opts = {})
       remove_role_from_archive_with_http_info(archive_id, body, opts)
       nil
     end
 
-    # Revoke role from an archive
+    # Revoke role from an archive.
+    #
     # Removes a role from an archive. ([Roles API](https://docs.datadoghq.com/api/v2/roles/))
+    #
     # @param archive_id [String] The ID of the archive.
     # @param body [RelationshipToRole] 
-    # @param [Hash] opts the optional parameters
+    # @param opts [Hash] the optional parameters
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
     def remove_role_from_archive_with_http_info(archive_id, body, opts = {})
 
@@ -571,7 +573,7 @@ module DatadogAPIClient::V2
         fail ArgumentError, "Missing the required parameter 'body' when calling LogsArchivesAPI.remove_role_from_archive"
       end
       # resource path
-      local_var_path = '/api/v2/logs/config/archives/{archive_id}/readers'.sub('{' + 'archive_id' + '}', CGI.escape(archive_id.to_s))
+      local_var_path = '/api/v2/logs/config/archives/{archive_id}/readers'.sub('{archive_id}', CGI.escape(archive_id.to_s).gsub('%2F', '/'))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -579,7 +581,7 @@ module DatadogAPIClient::V2
       # header parameters
       header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params['Accept'] = @api_client.select_header_accept(['*/*'])
       # HTTP header 'Content-Type'
       header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
 
@@ -605,29 +607,31 @@ module DatadogAPIClient::V2
         :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: LogsArchivesAPI#remove_role_from_archive\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # Update an archive
-    # Update a given archive configuration.  **Note**: Using this method updates your archive configuration by **replacing** your current configuration with the new one sent to your Datadog organization.
-    # @param archive_id [String] The ID of the archive.
-    # @param body [LogsArchiveCreateRequest] New definition of the archive.
-    # @param [Hash] opts the optional parameters
-    # @return [LogsArchive]
+    # Update an archive.
+    #
+    # @see #update_logs_archive_with_http_info
     def update_logs_archive(archive_id, body, opts = {})
       data, _status_code, _headers = update_logs_archive_with_http_info(archive_id, body, opts)
       data
     end
 
-    # Update an archive
-    # Update a given archive configuration.  **Note**: Using this method updates your archive configuration by **replacing** your current configuration with the new one sent to your Datadog organization.
+    # Update an archive.
+    #
+    # Update a given archive configuration.
+    #
+    # **Note**: Using this method updates your archive configuration by **replacing**
+    # your current configuration with the new one sent to your Datadog organization.
+    #
     # @param archive_id [String] The ID of the archive.
     # @param body [LogsArchiveCreateRequest] New definition of the archive.
-    # @param [Hash] opts the optional parameters
+    # @param opts [Hash] the optional parameters
     # @return [Array<(LogsArchive, Integer, Hash)>] LogsArchive data, response status code and response headers
     def update_logs_archive_with_http_info(archive_id, body, opts = {})
 
@@ -652,7 +656,7 @@ module DatadogAPIClient::V2
         fail ArgumentError, "Missing the required parameter 'body' when calling LogsArchivesAPI.update_logs_archive"
       end
       # resource path
-      local_var_path = '/api/v2/logs/config/archives/{archive_id}'.sub('{' + 'archive_id' + '}', CGI.escape(archive_id.to_s))
+      local_var_path = '/api/v2/logs/config/archives/{archive_id}'.sub('{archive_id}', CGI.escape(archive_id.to_s).gsub('%2F', '/'))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -686,27 +690,31 @@ module DatadogAPIClient::V2
         :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: LogsArchivesAPI#update_logs_archive\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # Update archive order
-    # Update the order of your archives. Since logs are processed sequentially, reordering an archive may change the structure and content of the data processed by other archives.  **Note**: Using the `PUT` method updates your archive's order by replacing the current order with the new one.
-    # @param body [LogsArchiveOrder] An object containing the new ordered list of archive IDs.
-    # @param [Hash] opts the optional parameters
-    # @return [LogsArchiveOrder]
+    # Update archive order.
+    #
+    # @see #update_logs_archive_order_with_http_info
     def update_logs_archive_order(body, opts = {})
       data, _status_code, _headers = update_logs_archive_order_with_http_info(body, opts)
       data
     end
 
-    # Update archive order
-    # Update the order of your archives. Since logs are processed sequentially, reordering an archive may change the structure and content of the data processed by other archives.  **Note**: Using the &#x60;PUT&#x60; method updates your archive&#39;s order by replacing the current order with the new one.
+    # Update archive order.
+    #
+    # Update the order of your archives. Since logs are processed sequentially, reordering an archive may change
+    # the structure and content of the data processed by other archives.
+    #
+    # **Note**: Using the `PUT` method updates your archive's order by replacing the current order
+    # with the new one.
+    #
     # @param body [LogsArchiveOrder] An object containing the new ordered list of archive IDs.
-    # @param [Hash] opts the optional parameters
+    # @param opts [Hash] the optional parameters
     # @return [Array<(LogsArchiveOrder, Integer, Hash)>] LogsArchiveOrder data, response status code and response headers
     def update_logs_archive_order_with_http_info(body, opts = {})
 
@@ -761,7 +769,7 @@ module DatadogAPIClient::V2
         :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: LogsArchivesAPI#update_logs_archive_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end