elasticsearch-api 7.17.11 → 9.0.2

data/lib/elasticsearch/api/actions/tasks/list.rb

@@ -14,53 +14,105 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
-
+#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Tasks
       module Actions
-        # Returns a list of tasks.
+        # Get all tasks.
+        # Get information about the tasks currently running on one or more nodes in the cluster.
+        # WARNING: The task management API is new and should still be considered a beta feature.
+        # The API may change in ways that are not backwards compatible.
+        # **Identifying running tasks**
+        # The +X-Opaque-Id header+, when provided on the HTTP request header, is going to be returned as a header in the response as well as in the headers field for in the task information.
+        # This enables you to track certain calls or associate certain tasks with the client that started them.
+        # For example:
+        # +
+        # curl -i -H "X-Opaque-Id: 123456" "http://localhost:9200/_tasks?group_by=parents"
+        # +
+        # The API returns the following result:
+        # +
+        # HTTP/1.1 200 OK
+        # X-Opaque-Id: 123456
+        # content-type: application/json; charset=UTF-8
+        # content-length: 831
+        # {
+        #   "tasks" : {
+        #     "u5lcZHqcQhu-rUoFaqDphA:45" : {
+        #       "node" : "u5lcZHqcQhu-rUoFaqDphA",
+        #       "id" : 45,
+        #       "type" : "transport",
+        #       "action" : "cluster:monitor/tasks/lists",
+        #       "start_time_in_millis" : 1513823752749,
+        #       "running_time_in_nanos" : 293139,
+        #       "cancellable" : false,
+        #       "headers" : {
+        #         "X-Opaque-Id" : "123456"
+        #       },
+        #       "children" : [
+        #         {
+        #           "node" : "u5lcZHqcQhu-rUoFaqDphA",
+        #           "id" : 46,
+        #           "type" : "direct",
+        #           "action" : "cluster:monitor/tasks/lists[n]",
+        #           "start_time_in_millis" : 1513823752750,
+        #           "running_time_in_nanos" : 92133,
+        #           "cancellable" : false,
+        #           "parent_task_id" : "u5lcZHqcQhu-rUoFaqDphA:45",
+        #           "headers" : {
+        #             "X-Opaque-Id" : "123456"
+        #           }
+        #         }
+        #       ]
+        #     }
+        #   }
+        #  }
+        # +
+        # In this example, +X-Opaque-Id: 123456+ is the ID as a part of the response header.
+        # The +X-Opaque-Id+ in the task +headers+ is the ID for the task that was initiated by the REST request.
+        # The +X-Opaque-Id+ in the children +headers+ is the child task of the task that was initiated by the REST request.
         # This functionality is Experimental and may be changed or removed
         # completely in a future release. Elastic will take a best effort approach
         # to fix any issues, but experimental features are not subject to the
         # support SLA of official GA features.
         #
-        # @option arguments [List] :nodes A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes
-        # @option arguments [List] :actions A comma-separated list of actions that should be returned. Leave empty to return all.
-        # @option arguments [Boolean] :detailed Return detailed task information (default: false)
-        # @option arguments [String] :parent_task_id Return tasks with specified parent task id (node_id:task_number). Set to -1 to return all.
-        # @option arguments [Boolean] :wait_for_completion Wait for the matching tasks to complete (default: false)
-        # @option arguments [String] :group_by Group tasks by nodes or parent/child relationships (options: nodes, parents, none)
-        # @option arguments [Time] :timeout Explicit operation timeout
+        # @option arguments [String] :actions A comma-separated list or wildcard expression of actions used to limit the request.
+        #  For example, you can use +cluser:*+ to retrieve all cluster-related tasks.
+        # @option arguments [Boolean] :detailed If +true+, the response includes detailed information about the running tasks.
+        #  This information is useful to distinguish tasks from each other but is more costly to run.
+        # @option arguments [String] :group_by A key that is used to group tasks in the response.
+        #  The task lists can be grouped either by nodes or by parent tasks.
+        # @option arguments [String, Array] :nodes A comma-separated list of node IDs or names that is used to limit the returned information.
+        # @option arguments [String] :parent_task_id A parent task identifier that is used to limit returned information.
+        #  To return all tasks, omit this parameter or use a value of +-1+.
+        #  If the parent task is not found, the API does not return a 404 response code.
+        # @option arguments [Time] :timeout The period to wait for each node to respond.
+        #  If a node does not respond before its timeout expires, the response does not include its information.
+        #  However, timed out nodes are included in the +node_failures+ property. Server default: 30s.
+        # @option arguments [Boolean] :wait_for_completion If +true+, the request blocks until the operation is complete.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/tasks.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-tasks
         #
         def list(arguments = {})
-          headers = arguments.delete(:headers) || {}
+          request_opts = { endpoint: arguments[:endpoint] || 'tasks.list' }
 
           arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
 
           method = Elasticsearch::API::HTTP_GET
-          path   = "_tasks"
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+          path   = '_tasks'
+          params = Utils.process_params(arguments)
 
-          body = nil
-          perform_request(method, path, params, body, headers).body
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers, request_opts)
+          )
         end
-
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.2.0
-        ParamsRegistry.register(:list, [
-          :nodes,
-          :actions,
-          :detailed,
-          :parent_task_id,
-          :wait_for_completion,
-          :group_by,
-          :timeout
-        ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/terms_enum.rb

@@ -0,0 +1,68 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
+module Elasticsearch
+  module API
+    module Actions
+      # Get terms in an index.
+      # Discover terms that match a partial string in an index.
+      # This API is designed for low-latency look-ups used in auto-complete scenarios.
+      #
+      # @option arguments [String] :index A comma-separated list of data streams, indices, and index aliases to search.
+      #  Wildcard (+*+) expressions are supported.
+      #  To search all data streams or indices, omit this parameter or use +*+  or +_all+. (*Required*)
+      # @option arguments [Hash] :headers Custom HTTP headers
+      # @option arguments [Hash] :body request body
+      #
+      # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-terms-enum
+      #
+      def terms_enum(arguments = {})
+        request_opts = { endpoint: arguments[:endpoint] || 'terms_enum' }
+
+        defined_params = [:index].each_with_object({}) do |variable, set_variables|
+          set_variables[variable] = arguments[variable] if arguments.key?(variable)
+        end
+        request_opts[:defined_params] = defined_params unless defined_params.empty?
+
+        raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
+
+        arguments = arguments.clone
+        headers = arguments.delete(:headers) || {}
+
+        body = arguments.delete(:body)
+
+        _index = arguments.delete(:index)
+
+        method = if body
+                   Elasticsearch::API::HTTP_POST
+                 else
+                   Elasticsearch::API::HTTP_GET
+                 end
+
+        path   = "#{Utils.listify(_index)}/_terms_enum"
+        params = {}
+
+        Elasticsearch::API::Response.new(
+          perform_request(method, path, params, body, headers, request_opts)
+        )
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/termvectors.rb

@@ -14,94 +14,104 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
-
+#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Actions
-      # Returns information and statistics about terms in the fields of a particular document.
+      # Get term vector information.
+      # Get information and statistics about terms in the fields of a particular document.
+      # You can retrieve term vectors for documents stored in the index or for artificial documents passed in the body of the request.
+      # You can specify the fields you are interested in through the +fields+ parameter or by adding the fields to the request body.
+      # For example:
+      # +
+      # GET /my-index-000001/_termvectors/1?fields=message
+      # +
+      # Fields can be specified using wildcards, similar to the multi match query.
+      # Term vectors are real-time by default, not near real-time.
+      # This can be changed by setting +realtime+ parameter to +false+.
+      # You can request three types of values: _term information_, _term statistics_, and _field statistics_.
+      # By default, all term information and field statistics are returned for all fields but term statistics are excluded.
+      # **Term information**
+      # * term frequency in the field (always returned)
+      # * term positions (+positions: true+)
+      # * start and end offsets (+offsets: true+)
+      # * term payloads (+payloads: true+), as base64 encoded bytes
+      # If the requested information wasn't stored in the index, it will be computed on the fly if possible.
+      # Additionally, term vectors could be computed for documents not even existing in the index, but instead provided by the user.
       #
-      # @option arguments [String] :index The index in which the document resides. (*Required*)
-      # @option arguments [String] :id The id of the document, when not specified a doc param should be supplied.
-      # @option arguments [String] :type The type of the document.
-      # @option arguments [Boolean] :term_statistics Specifies if total term frequency and document frequency should be returned.
-      # @option arguments [Boolean] :field_statistics Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned.
-      # @option arguments [List] :fields A comma-separated list of fields to return.
-      # @option arguments [Boolean] :offsets Specifies if term offsets should be returned.
-      # @option arguments [Boolean] :positions Specifies if term positions should be returned.
-      # @option arguments [Boolean] :payloads Specifies if term payloads should be returned.
-      # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random).
-      # @option arguments [String] :routing Specific routing value.
-      # @option arguments [Boolean] :realtime Specifies if request is real-time as opposed to near-real-time (default: true).
-      # @option arguments [Number] :version Explicit version number for concurrency control
-      # @option arguments [String] :version_type Specific version type (options: internal, external, external_gte, force)
+      # @option arguments [String] :index The name of the index that contains the document. (*Required*)
+      # @option arguments [String] :id A unique identifier for the document.
+      # @option arguments [String, Array<String>] :fields A comma-separated list or wildcard expressions of fields to include in the statistics.
+      #  It is used as the default list unless a specific field list is provided in the +completion_fields+ or +fielddata_fields+ parameters.
+      # @option arguments [Boolean] :field_statistics If +true+, the response includes:
+      #  - The document count (how many documents contain this field).
+      #  - The sum of document frequencies (the sum of document frequencies for all terms in this field).
+      #  - The sum of total term frequencies (the sum of total term frequencies of each term in this field). Server default: true.
+      # @option arguments [Boolean] :offsets If +true+, the response includes term offsets. Server default: true.
+      # @option arguments [Boolean] :payloads If +true+, the response includes term payloads. Server default: true.
+      # @option arguments [Boolean] :positions If +true+, the response includes term positions. Server default: true.
+      # @option arguments [String] :preference The node or shard the operation should be performed on.
+      #  It is random by default.
+      # @option arguments [Boolean] :realtime If true, the request is real-time as opposed to near-real-time. Server default: true.
+      # @option arguments [String] :routing A custom value that is used to route operations to a specific shard.
+      # @option arguments [Boolean] :term_statistics If +true+, the response includes:
+      #  - The total term frequency (how often a term occurs in all documents).
+      #  - The document frequency (the number of documents containing the current term).
+      #  By default these values are not returned since term statistics can have a serious performance impact.
+      # @option arguments [Integer] :version If +true+, returns the document version as part of a hit.
+      # @option arguments [String] :version_type The version type.
       # @option arguments [Hash] :headers Custom HTTP headers
-      # @option arguments [Hash] :body Define parameters and or supply a document to get termvectors for. See documentation.
-      #
-      # *Deprecation notice*:
-      # Specifying types in urls has been deprecated
-      # Deprecated since version 7.0.0
-      #
+      # @option arguments [Hash] :body request body
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/docs-termvectors.html
+      # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-termvectors
       #
       def termvectors(arguments = {})
+        request_opts = { endpoint: arguments[:endpoint] || 'termvectors' }
+
+        defined_params = [:index, :id].each_with_object({}) do |variable, set_variables|
+          set_variables[variable] = arguments[variable] if arguments.key?(variable)
+        end
+        request_opts[:defined_params] = defined_params unless defined_params.empty?
+
         raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
 
+        arguments = arguments.clone
         headers = arguments.delete(:headers) || {}
 
-        arguments = arguments.clone
+        body = arguments.delete(:body)
 
         _index = arguments.delete(:index)
 
         _id = arguments.delete(:id)
 
-        _type = arguments.delete(:type)
-
-        method = if arguments[:body]
+        method = if body
                    Elasticsearch::API::HTTP_POST
                  else
                    Elasticsearch::API::HTTP_GET
                  end
 
-        endpoint = arguments.delete(:endpoint) || '_termvectors'
-        path   = if _index && _type && _id
-                   "#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/#{Utils.__listify(_id)}/#{endpoint}"
-                 elsif _index && _type
-                   "#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/#{endpoint}"
-                 elsif _index && _id
-                   "#{Utils.__listify(_index)}/#{endpoint}/#{Utils.__listify(_id)}"
-                 else
-                   "#{Utils.__listify(_index)}/#{endpoint}"
-                 end
+        arguments.delete(:endpoint)
+        path = if _index && _id
+                 "#{Utils.listify(_index)}/_termvectors/#{Utils.listify(_id)}"
+               else
+                 "#{Utils.listify(_index)}/_termvectors"
+               end
+        params = Utils.process_params(arguments)
 
-        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-
-        body = arguments[:body]
-        perform_request(method, path, params, body, headers).body
+        Elasticsearch::API::Response.new(
+          perform_request(method, path, params, body, headers, request_opts)
+        )
       end
 
       # Deprecated: Use the plural version, {#termvectors}
       #
       def termvector(arguments = {})
-        termvectors(arguments.merge endpoint: '_termvector')
+        warn '[DEPRECATION] `termvector` is deprecated. Please use the plural version, `termvectors` instead.'
+        termvectors(arguments.merge(endpoint: '_termvector'))
       end
-
-      # Register this action with its valid params when the module is loaded.
-      #
-      # @since 6.2.0
-      ParamsRegistry.register(:termvectors, [
-        :term_statistics,
-        :field_statistics,
-        :fields,
-        :offsets,
-        :positions,
-        :payloads,
-        :preference,
-        :routing,
-        :realtime,
-        :version,
-        :version_type
-      ].freeze)
     end
   end
 end

data/lib/elasticsearch/api/actions/text_structure/find_field_structure.rb

@@ -0,0 +1,127 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
+module Elasticsearch
+  module API
+    module TextStructure
+      module Actions
+        # Find the structure of a text field.
+        # Find the structure of a text field in an Elasticsearch index.
+        # This API provides a starting point for extracting further information from log messages already ingested into Elasticsearch.
+        # For example, if you have ingested data into a very simple index that has just +@timestamp+ and message fields, you can use this API to see what common structure exists in the message field.
+        # The response from the API contains:
+        # * Sample messages.
+        # * Statistics that reveal the most common values for all fields detected within the text and basic numeric statistics for numeric fields.
+        # * Information about the structure of the text, which is useful when you write ingest configurations to index it or similarly formatted text.
+        # * Appropriate mappings for an Elasticsearch index, which you could use to ingest the text.
+        # All this information can be calculated by the structure finder with no guidance.
+        # However, you can optionally override some of the decisions about the text structure by specifying one or more query parameters.
+        # If the structure finder produces unexpected results, specify the +explain+ query parameter and an explanation will appear in the response.
+        # It helps determine why the returned structure was chosen.
+        #
+        # @option arguments [String] :column_names If +format+ is set to +delimited+, you can specify the column names in a comma-separated list.
+        #  If this parameter is not specified, the structure finder uses the column names from the header row of the text.
+        #  If the text does not have a header row, columns are named "column1", "column2", "column3", for example.
+        # @option arguments [String] :delimiter If you have set +format+ to +delimited+, you can specify the character used to delimit the values in each row.
+        #  Only a single character is supported; the delimiter cannot have multiple characters.
+        #  By default, the API considers the following possibilities: comma, tab, semi-colon, and pipe (+|+).
+        #  In this default scenario, all rows must have the same number of fields for the delimited format to be detected.
+        #  If you specify a delimiter, up to 10% of the rows can have a different number of columns than the first row.
+        # @option arguments [Integer] :documents_to_sample The number of documents to include in the structural analysis.
+        #  The minimum value is 2. Server default: 1000.
+        # @option arguments [String] :ecs_compatibility The mode of compatibility with ECS compliant Grok patterns.
+        #  Use this parameter to specify whether to use ECS Grok patterns instead of legacy ones when the structure finder creates a Grok pattern.
+        #  This setting primarily has an impact when a whole message Grok pattern such as +%{CATALINALOG}+ matches the input.
+        #  If the structure finder identifies a common structure but has no idea of the meaning then generic field names such as +path+, +ipaddress+, +field1+, and +field2+ are used in the +grok_pattern+ output.
+        #  The intention in that situation is that a user who knows the meanings will rename the fields before using them. Server default: disabled.
+        # @option arguments [Boolean] :explain If +true+, the response includes a field named +explanation+, which is an array of strings that indicate how the structure finder produced its result.
+        # @option arguments [String] :field The field that should be analyzed. (*Required*)
+        # @option arguments [String] :format The high level structure of the text.
+        #  By default, the API chooses the format.
+        #  In this default scenario, all rows must have the same number of fields for a delimited format to be detected.
+        #  If the format is set to delimited and the delimiter is not set, however, the API tolerates up to 5% of rows that have a different number of columns than the first row.
+        # @option arguments [String] :grok_pattern If the format is +semi_structured_text+, you can specify a Grok pattern that is used to extract fields from every message in the text.
+        #  The name of the timestamp field in the Grok pattern must match what is specified in the +timestamp_field+ parameter.
+        #  If that parameter is not specified, the name of the timestamp field in the Grok pattern must match "timestamp".
+        #  If +grok_pattern+ is not specified, the structure finder creates a Grok pattern.
+        # @option arguments [String] :index The name of the index that contains the analyzed field. (*Required*)
+        # @option arguments [String] :quote If the format is +delimited+, you can specify the character used to quote the values in each row if they contain newlines or the delimiter character.
+        #  Only a single character is supported.
+        #  If this parameter is not specified, the default value is a double quote (+"+).
+        #  If your delimited text format does not use quoting, a workaround is to set this argument to a character that does not appear anywhere in the sample.
+        # @option arguments [Boolean] :should_trim_fields If the format is +delimited+, you can specify whether values between delimiters should have whitespace trimmed from them.
+        #  If this parameter is not specified and the delimiter is pipe (+|+), the default value is true.
+        #  Otherwise, the default value is +false+.
+        # @option arguments [Time] :timeout The maximum amount of time that the structure analysis can take.
+        #  If the analysis is still running when the timeout expires, it will be stopped. Server default: 25s.
+        # @option arguments [String] :timestamp_field The name of the field that contains the primary timestamp of each record in the text.
+        #  In particular, if the text was ingested into an index, this is the field that would be used to populate the +@timestamp+ field.If the format is +semi_structured_text+, this field must match the name of the appropriate extraction in the +grok_pattern+.
+        #  Therefore, for semi-structured text, it is best not to specify this parameter unless +grok_pattern+ is also specified.For structured text, if you specify this parameter, the field must exist within the text.If this parameter is not specified, the structure finder makes a decision about which field (if any) is the primary timestamp field.
+        #  For structured text, it is not compulsory to have a timestamp in the text.
+        # @option arguments [String] :timestamp_format The Java time format of the timestamp field in the text.
+        #  Only a subset of Java time format letter groups are supported:
+        #  - +a+
+        #  - +d+
+        #  - +dd+
+        #  - +EEE+
+        #  - +EEEE+
+        #  - +H+
+        #  - +HH+
+        #  - +h+
+        #  - +M+
+        #  - +MM+
+        #  - +MMM+
+        #  - +MMMM+
+        #  - +mm+
+        #  - +ss+
+        #  - +XX+
+        #  - +XXX+
+        #  - +yy+
+        #  - +yyyy+
+        #  - +zzz+
+        #  Additionally +S+ letter groups (fractional seconds) of length one to nine are supported providing they occur after +ss+ and are separated from the +ss+ by a period (+.+), comma (+,+), or colon (+:+).
+        #  Spacing and punctuation is also permitted with the exception a question mark (+?+), newline, and carriage return, together with literal text enclosed in single quotes.
+        #  For example, +MM/dd HH.mm.ss,SSSSSS 'in' yyyy+ is a valid override format.One valuable use case for this parameter is when the format is semi-structured text, there are multiple timestamp formats in the text, and you know which format corresponds to the primary timestamp, but you do not want to specify the full +grok_pattern+.
+        #  Another is when the timestamp format is one that the structure finder does not consider by default.If this parameter is not specified, the structure finder chooses the best format from a built-in set.If the special value +null+ is specified, the structure finder will not look for a primary timestamp in the text.
+        #  When the format is semi-structured text, this will result in the structure finder treating the text as single-line messages.
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-text_structure
+        #
+        def find_field_structure(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'text_structure.find_field_structure' }
+
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          method = Elasticsearch::API::HTTP_GET
+          path   = '_text_structure/find_field_structure'
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers, request_opts)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/text_structure/find_message_structure.rb

@@ -0,0 +1,126 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
+module Elasticsearch
+  module API
+    module TextStructure
+      module Actions
+        # Find the structure of text messages.
+        # Find the structure of a list of text messages.
+        # The messages must contain data that is suitable to be ingested into Elasticsearch.
+        # This API provides a starting point for ingesting data into Elasticsearch in a format that is suitable for subsequent use with other Elastic Stack functionality.
+        # Use this API rather than the find text structure API if your input text has already been split up into separate messages by some other process.
+        # The response from the API contains:
+        # * Sample messages.
+        # * Statistics that reveal the most common values for all fields detected within the text and basic numeric statistics for numeric fields.
+        # * Information about the structure of the text, which is useful when you write ingest configurations to index it or similarly formatted text.
+        # Appropriate mappings for an Elasticsearch index, which you could use to ingest the text.
+        # All this information can be calculated by the structure finder with no guidance.
+        # However, you can optionally override some of the decisions about the text structure by specifying one or more query parameters.
+        # If the structure finder produces unexpected results, specify the +explain+ query parameter and an explanation will appear in the response.
+        # It helps determine why the returned structure was chosen.
+        #
+        # @option arguments [String] :column_names If the format is +delimited+, you can specify the column names in a comma-separated list.
+        #  If this parameter is not specified, the structure finder uses the column names from the header row of the text.
+        #  If the text does not have a header role, columns are named "column1", "column2", "column3", for example.
+        # @option arguments [String] :delimiter If you the format is +delimited+, you can specify the character used to delimit the values in each row.
+        #  Only a single character is supported; the delimiter cannot have multiple characters.
+        #  By default, the API considers the following possibilities: comma, tab, semi-colon, and pipe (+|+).
+        #  In this default scenario, all rows must have the same number of fields for the delimited format to be detected.
+        #  If you specify a delimiter, up to 10% of the rows can have a different number of columns than the first row.
+        # @option arguments [String] :ecs_compatibility The mode of compatibility with ECS compliant Grok patterns.
+        #  Use this parameter to specify whether to use ECS Grok patterns instead of legacy ones when the structure finder creates a Grok pattern.
+        #  This setting primarily has an impact when a whole message Grok pattern such as +%{CATALINALOG}+ matches the input.
+        #  If the structure finder identifies a common structure but has no idea of meaning then generic field names such as +path+, +ipaddress+, +field1+, and +field2+ are used in the +grok_pattern+ output, with the intention that a user who knows the meanings rename these fields before using it. Server default: disabled.
+        # @option arguments [Boolean] :explain If this parameter is set to true, the response includes a field named +explanation+, which is an array of strings that indicate how the structure finder produced its result.
+        # @option arguments [String] :format The high level structure of the text.
+        #  By default, the API chooses the format.
+        #  In this default scenario, all rows must have the same number of fields for a delimited format to be detected.
+        #  If the format is +delimited+ and the delimiter is not set, however, the API tolerates up to 5% of rows that have a different number of columns than the first row.
+        # @option arguments [String] :grok_pattern If the format is +semi_structured_text+, you can specify a Grok pattern that is used to extract fields from every message in the text.
+        #  The name of the timestamp field in the Grok pattern must match what is specified in the +timestamp_field+ parameter.
+        #  If that parameter is not specified, the name of the timestamp field in the Grok pattern must match "timestamp".
+        #  If +grok_pattern+ is not specified, the structure finder creates a Grok pattern.
+        # @option arguments [String] :quote If the format is +delimited+, you can specify the character used to quote the values in each row if they contain newlines or the delimiter character.
+        #  Only a single character is supported.
+        #  If this parameter is not specified, the default value is a double quote (+"+).
+        #  If your delimited text format does not use quoting, a workaround is to set this argument to a character that does not appear anywhere in the sample.
+        # @option arguments [Boolean] :should_trim_fields If the format is +delimited+, you can specify whether values between delimiters should have whitespace trimmed from them.
+        #  If this parameter is not specified and the delimiter is pipe (+|+), the default value is true.
+        #  Otherwise, the default value is +false+.
+        # @option arguments [Time] :timeout The maximum amount of time that the structure analysis can take.
+        #  If the analysis is still running when the timeout expires, it will be stopped. Server default: 25s.
+        # @option arguments [String] :timestamp_field The name of the field that contains the primary timestamp of each record in the text.
+        #  In particular, if the text was ingested into an index, this is the field that would be used to populate the +@timestamp+ field.If the format is +semi_structured_text+, this field must match the name of the appropriate extraction in the +grok_pattern+.
+        #  Therefore, for semi-structured text, it is best not to specify this parameter unless +grok_pattern+ is also specified.For structured text, if you specify this parameter, the field must exist within the text.If this parameter is not specified, the structure finder makes a decision about which field (if any) is the primary timestamp field.
+        #  For structured text, it is not compulsory to have a timestamp in the text.
+        # @option arguments [String] :timestamp_format The Java time format of the timestamp field in the text.
+        #  Only a subset of Java time format letter groups are supported:
+        #  - +a+
+        #  - +d+
+        #  - +dd+
+        #  - +EEE+
+        #  - +EEEE+
+        #  - +H+
+        #  - +HH+
+        #  - +h+
+        #  - +M+
+        #  - +MM+
+        #  - +MMM+
+        #  - +MMMM+
+        #  - +mm+
+        #  - +ss+
+        #  - +XX+
+        #  - +XXX+
+        #  - +yy+
+        #  - +yyyy+
+        #  - +zzz+
+        #  Additionally +S+ letter groups (fractional seconds) of length one to nine are supported providing they occur after +ss+ and are separated from the +ss+ by a period (+.+), comma (+,+), or colon (+:+).
+        #  Spacing and punctuation is also permitted with the exception a question mark (+?+), newline, and carriage return, together with literal text enclosed in single quotes.
+        #  For example, +MM/dd HH.mm.ss,SSSSSS 'in' yyyy+ is a valid override format.One valuable use case for this parameter is when the format is semi-structured text, there are multiple timestamp formats in the text, and you know which format corresponds to the primary timestamp, but you do not want to specify the full +grok_pattern+.
+        #  Another is when the timestamp format is one that the structure finder does not consider by default.If this parameter is not specified, the structure finder chooses the best format from a built-in set.If the special value +null+ is specified, the structure finder will not look for a primary timestamp in the text.
+        #  When the format is semi-structured text, this will result in the structure finder treating the text as single-line messages.
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body request body
+        #
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-text-structure-find-message-structure
+        #
+        def find_message_structure(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'text_structure.find_message_structure' }
+
+          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body = arguments.delete(:body)
+
+          method = Elasticsearch::API::HTTP_POST
+          path   = '_text_structure/find_message_structure'
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers, request_opts)
+          )
+        end
+      end
+    end
+  end
+end