datadog_api_client 1.8.0 → 1.9.0

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

@@ -23,18 +23,18 @@ module DatadogAPIClient::V2
       @api_client = api_client
     end
 
-    # Aggregate events
-    # The API endpoint to aggregate events into buckets and compute metrics and timeseries.
-    # @param body [LogsAggregateRequest] 
-    # @param opts [Hash] the optional parameters
-    # @return [LogsAggregateResponse]
+    # Aggregate events.
+    #
+    # @see #aggregate_logs_with_http_info
     def aggregate_logs(body, opts = {})
       data, _status_code, _headers = aggregate_logs_with_http_info(body, opts)
       data
     end
 
-    # Aggregate events
+    # Aggregate events.
+    #
     # The API endpoint to aggregate events into buckets and compute metrics and timeseries.
+    #
     # @param body [LogsAggregateRequest] 
     # @param opts [Hash] the optional parameters
     # @return [Array<(LogsAggregateResponse, Integer, Hash)>] LogsAggregateResponse data, response status code and response headers
@@ -91,34 +91,23 @@ 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: LogsAPI#aggregate_logs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # Search logs
-    # List endpoint returns logs that match a log search query.
-    # [Results are paginated][1].
-    #
-    # Use this endpoint to build complex logs filtering and search.
-    #
-    # **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].**
+    # Search logs.
     #
-    # [1]: /logs/guide/collect-multiple-logs-with-pagination
-    # [2]: https://docs.datadoghq.com/logs/archives
-    # @param opts [Hash] the optional parameters
-    # @option opts [LogsListRequest] :body 
-    # @return [LogsListResponse]
+    # @see #list_logs_with_http_info
     def list_logs(opts = {})
       data, _status_code, _headers = list_logs_with_http_info(opts)
       data
     end
 
-    # Search logs
+    # Search logs.
+    #
     # List endpoint returns logs that match a log search query.
     # [Results are paginated][1].
     #
@@ -130,6 +119,7 @@ module DatadogAPIClient::V2
     #
     # [1]: /logs/guide/collect-multiple-logs-with-pagination
     # [2]: https://docs.datadoghq.com/logs/archives
+    #
     # @param opts [Hash] the optional parameters
     # @option opts [LogsListRequest] :body 
     # @return [Array<(LogsListResponse, Integer, Hash)>] LogsListResponse data, response status code and response headers
@@ -182,40 +172,43 @@ 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: LogsAPI#list_logs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # Get a list of logs
-    # List endpoint returns logs that match a log search query.
-    # [Results are paginated][1].
+    # Search logs.
     #
-    # Use this endpoint to see your latest logs.
+    # Provide a paginated version of {#list_logs}, returning all items.
     #
-    # **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].**
+    # To use it you need to use a block: list_logs_with_pagination { |item| p item }
     #
-    # [1]: /logs/guide/collect-multiple-logs-with-pagination
-    # [2]: https://docs.datadoghq.com/logs/archives
-    # @param opts [Hash] the optional parameters
-    # @option opts [String] :filter_query Search query following logs syntax.
-    # @option opts [String] :filter_index For customers with multiple indexes, the indexes to search Defaults to '*' which means all indexes
-    # @option opts [Time] :filter_from Minimum timestamp for requested logs.
-    # @option opts [Time] :filter_to Maximum timestamp for requested logs.
-    # @option opts [LogsSort] :sort Order of logs in results.
-    # @option opts [String] :page_cursor List following results with a cursor provided in the previous query.
-    # @option opts [Integer] :page_limit Maximum number of logs in the response.
-    # @return [LogsListResponse]
+    # @yield [Log] Paginated items
+    def list_logs_with_pagination(opts = {})
+        page_size = @api_client.get_attribute_from_path(opts, "body.page.limit", 10)
+        @api_client.set_attribute_from_path(opts, "body.page.limit", LogsListRequest, page_size)
+        while true do
+            response = list_logs(opts)
+            @api_client.get_attribute_from_path(response, "data").each { |item| yield(item) }
+            if @api_client.get_attribute_from_path(response, "data").length < page_size
+              break
+            end
+            @api_client.set_attribute_from_path(opts, "body.page.cursor", LogsListRequest, @api_client.get_attribute_from_path(response, "meta.page.after"))
+        end
+    end
+
+    # Get a list of logs.
+    #
+    # @see #list_logs_get_with_http_info
     def list_logs_get(opts = {})
       data, _status_code, _headers = list_logs_get_with_http_info(opts)
       data
     end
 
-    # Get a list of logs
+    # Get a list of logs.
+    #
     # List endpoint returns logs that match a log search query.
     # [Results are paginated][1].
     #
@@ -227,6 +220,7 @@ module DatadogAPIClient::V2
     #
     # [1]: /logs/guide/collect-multiple-logs-with-pagination
     # [2]: https://docs.datadoghq.com/logs/archives
+    #
     # @param opts [Hash] the optional parameters
     # @option opts [String] :filter_query Search query following logs syntax.
     # @option opts [String] :filter_index For customers with multiple indexes, the indexes to search Defaults to '*' which means all indexes
@@ -297,48 +291,43 @@ 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: LogsAPI#list_logs_get\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:
+    # Get a list of logs.
     #
-    # - 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
+    # Provide a paginated version of {#list_logs_get}, returning all items.
     #
-    # 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.
+    # To use it you need to use a block: list_logs_get_with_pagination { |item| p item }
     #
-    # Datadog recommends sending your logs compressed.
-    # Add the `Content-Encoding: gzip` header to the request when sending compressed logs.
+    # @yield [Log] Paginated items
+    def list_logs_get_with_pagination(opts = {})
+        page_size = @api_client.get_attribute_from_path(opts, "page_limit", 10)
+        @api_client.set_attribute_from_path(opts, "page_limit", Integer, page_size)
+        while true do
+            response = list_logs_get(opts)
+            @api_client.get_attribute_from_path(response, "data").each { |item| yield(item) }
+            if @api_client.get_attribute_from_path(response, "data").length < page_size
+              break
+            end
+            @api_client.set_attribute_from_path(opts, "page_cursor", Integer, @api_client.get_attribute_from_path(response, "meta.page.after"))
+        end
+    end
+
+    # Send logs.
     #
-    # The status codes answered by the HTTP API are:
-    # - 202: Accepted: the request has been accepted for processing
-    # - 400: Bad request (likely an issue in the payload formatting)
-    # - 401: Unauthorized (likely a missing API Key)
-    # - 403: Permission issue (likely using an invalid API Key)
-    # - 408: Request Timeout, request should be retried after some time
-    # - 413: Payload too large (batch is above 5MB uncompressed)
-    # - 429: Too Many Requests, request should be retried after some time
-    # - 500: Internal Server Error, the server encountered an unexpected condition that prevented it from fulfilling the request, request should be retried after some time
-    # - 503: Service Unavailable, the server is not ready to handle the request probably because it is overloaded, 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
@@ -362,6 +351,7 @@ module DatadogAPIClient::V2
     # - 429: Too Many Requests, request should be retried after some time
     # - 500: Internal Server Error, the server encountered an unexpected condition that prevented it from fulfilling the request, request should be retried after some time
     # - 503: Service Unavailable, the server is not ready to handle the request probably because it is overloaded, 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.
@@ -426,7 +416,7 @@ 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: LogsAPI#submit_log\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end

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

@@ -23,19 +23,18 @@ module DatadogAPIClient::V2
       @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 opts [Hash] 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 opts [Hash] the optional parameters
@@ -97,25 +96,25 @@ 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 opts [Hash] 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 opts [Hash] the optional parameters
     # @return [Array<(LogsArchive, Integer, Hash)>] LogsArchive data, response status code and response headers
@@ -172,25 +171,25 @@ 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 opts [Hash] 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 opts [Hash] the optional parameters
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
@@ -245,25 +244,25 @@ 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 opts [Hash] 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 opts [Hash] the optional parameters
     # @return [Array<(LogsArchive, Integer, Hash)>] LogsArchive data, response status code and response headers
@@ -318,26 +317,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#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 opts [Hash] 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 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 = {})
@@ -387,25 +386,25 @@ 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 opts [Hash] 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 opts [Hash] the optional parameters
     # @return [Array<(RolesResponse, Integer, Hash)>] RolesResponse data, response status code and response headers
@@ -460,24 +459,25 @@ 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 opts [Hash] 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 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 = {})
@@ -527,26 +527,25 @@ 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 opts [Hash] 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 opts [Hash] the optional parameters
@@ -608,32 +607,28 @@ 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.
+    # Update an archive.
     #
-    # **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 opts [Hash] the optional parameters
-    # @return [LogsArchive]
+    # @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 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 opts [Hash] the optional parameters
@@ -695,33 +690,29 @@ 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.
+    # Update archive order.
     #
-    # **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 opts [Hash] the optional parameters
-    # @return [LogsArchiveOrder]
+    # @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 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 opts [Hash] the optional parameters
     # @return [Array<(LogsArchiveOrder, Integer, Hash)>] LogsArchiveOrder data, response status code and response headers
@@ -778,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