elasticsearch-api 8.17.2 → 9.0.0

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

@@ -15,32 +15,95 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# 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
-        # Finds the structure of a text field in an index.
+        # 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] :index The index containing the analyzed field (*Required*)
-        # @option arguments [String] :field The field that should be analyzed (*Required*)
-        # @option arguments [Integer] :documents_to_sample How many documents should be included in the analysis
-        # @option arguments [Time] :timeout Timeout after which the analysis will be aborted
-        # @option arguments [String] :format Optional parameter to specify the high level file format (options: ndjson, xml, delimited, semi_structured_text)
-        # @option arguments [List] :column_names Optional parameter containing a comma separated list of the column names for a delimited file
-        # @option arguments [String] :delimiter Optional parameter to specify the delimiter character for a delimited file - must be a single character
-        # @option arguments [String] :quote Optional parameter to specify the quote character for a delimited file - must be a single character
-        # @option arguments [Boolean] :should_trim_fields Optional parameter to specify whether the values between delimiters in a delimited file should have whitespace trimmed from them
-        # @option arguments [String] :grok_pattern Optional parameter to specify the Grok pattern that should be used to extract fields from messages in a semi-structured text file
-        # @option arguments [String] :ecs_compatibility Optional parameter to specify the compatibility mode with ECS Grok patterns - may be either 'v1' or 'disabled'
-        # @option arguments [String] :timestamp_field Optional parameter to specify the timestamp field in the file
-        # @option arguments [String] :timestamp_format Optional parameter to specify the timestamp format in the file - may be either a Joda or Java time format
-        # @option arguments [Boolean] :explain Whether to include a commentary on how the structure was derived
+        # @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/guide/en/elasticsearch/reference/8.17/find-field-structure.html
+        # @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' }
@@ -48,7 +111,7 @@ module Elasticsearch
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          body   = nil
+          body = nil
 
           method = Elasticsearch::API::HTTP_GET
           path   = '_text_structure/find_field_structure'

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

@@ -15,30 +15,92 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# 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
-        # Finds the structure of a list of messages. The messages must contain data that is suitable to be ingested into Elasticsearch.
+        # 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 [Time] :timeout Timeout after which the analysis will be aborted
-        # @option arguments [String] :format Optional parameter to specify the high level file format (options: ndjson, xml, delimited, semi_structured_text)
-        # @option arguments [List] :column_names Optional parameter containing a comma separated list of the column names for a delimited file
-        # @option arguments [String] :delimiter Optional parameter to specify the delimiter character for a delimited file - must be a single character
-        # @option arguments [String] :quote Optional parameter to specify the quote character for a delimited file - must be a single character
-        # @option arguments [Boolean] :should_trim_fields Optional parameter to specify whether the values between delimiters in a delimited file should have whitespace trimmed from them
-        # @option arguments [String] :grok_pattern Optional parameter to specify the Grok pattern that should be used to extract fields from messages in a semi-structured text file
-        # @option arguments [String] :ecs_compatibility Optional parameter to specify the compatibility mode with ECS Grok patterns - may be either 'v1' or 'disabled'
-        # @option arguments [String] :timestamp_field Optional parameter to specify the timestamp field in the file
-        # @option arguments [String] :timestamp_format Optional parameter to specify the timestamp format in the file - may be either a Joda or Java time format
-        # @option arguments [Boolean] :explain Whether to include a commentary on how the structure was derived
+        # @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 JSON object with one field [messages], containing an array of messages to be analyzed (*Required*)
+        # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/find-message-structure.html
+        # @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' }
@@ -48,7 +110,7 @@ module Elasticsearch
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          body   = arguments.delete(:body)
+          body = arguments.delete(:body)
 
           method = Elasticsearch::API::HTTP_POST
           path   = '_text_structure/find_message_structure'

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

@@ -15,34 +15,106 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# 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
-        # Finds the structure of a text file. The text file must contain data that is suitable to be ingested into Elasticsearch.
+        # Find the structure of a text file.
+        # The text file 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.
+        # Unlike other Elasticsearch endpoints, the data that is posted to this endpoint does not need to be UTF-8 encoded and in JSON format.
+        # It must, however, be text; binary text formats are not currently supported.
+        # The size is limited to the Elasticsearch HTTP receive buffer size, which defaults to 100 Mb.
+        # The response from the API contains:
+        # * A couple of messages from the beginning of the text.
+        # * 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.
         #
-        # @option arguments [Integer] :lines_to_sample How many lines of the file should be included in the analysis
-        # @option arguments [Integer] :line_merge_size_limit Maximum number of characters permitted in a single message when lines are merged to create messages.
-        # @option arguments [Time] :timeout Timeout after which the analysis will be aborted
-        # @option arguments [String] :charset Optional parameter to specify the character set of the file
-        # @option arguments [String] :format Optional parameter to specify the high level file format (options: ndjson, xml, delimited, semi_structured_text)
-        # @option arguments [Boolean] :has_header_row Optional parameter to specify whether a delimited file includes the column names in its first row
-        # @option arguments [List] :column_names Optional parameter containing a comma separated list of the column names for a delimited file
-        # @option arguments [String] :delimiter Optional parameter to specify the delimiter character for a delimited file - must be a single character
-        # @option arguments [String] :quote Optional parameter to specify the quote character for a delimited file - must be a single character
-        # @option arguments [Boolean] :should_trim_fields Optional parameter to specify whether the values between delimiters in a delimited file should have whitespace trimmed from them
-        # @option arguments [String] :grok_pattern Optional parameter to specify the Grok pattern that should be used to extract fields from messages in a semi-structured text file
-        # @option arguments [String] :ecs_compatibility Optional parameter to specify the compatibility mode with ECS Grok patterns - may be either 'v1' or 'disabled'
-        # @option arguments [String] :timestamp_field Optional parameter to specify the timestamp field in the file
-        # @option arguments [String] :timestamp_format Optional parameter to specify the timestamp format in the file - may be either a Joda or Java time format
-        # @option arguments [Boolean] :explain Whether to include a commentary on how the structure was derived
+        # @option arguments [String] :charset The text's character set.
+        #  It must be a character set that is supported by the JVM that Elasticsearch uses.
+        #  For example, +UTF-8+, +UTF-16LE+, +windows-1252+, or +EUC-JP+.
+        #  If this parameter is not specified, the structure finder chooses an appropriate character set.
+        # @option arguments [String] :column_names If you have set format 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 role, 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 [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.
+        #  Valid values are +disabled+ and +v1+.
+        #  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.
+        #  If the structure finder produces unexpected results for some text, use this query parameter to help you determine why the returned structure was chosen.
+        # @option arguments [String] :format The high level structure of the text.
+        #  Valid values are +ndjson+, +xml+, +delimited+, and +semi_structured_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 you have set +format+ to +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 [Boolean] :has_header_row If you have set +format+ to +delimited+, you can use this parameter to indicate whether the column names are in the first row of the text.
+        #  If this parameter is not specified, the structure finder guesses based on the similarity of the first row of the text to other rows.
+        # @option arguments [Integer] :line_merge_size_limit The maximum number of characters in a message when lines are merged to form messages while analyzing semi-structured text.
+        #  If you have extremely long messages you may need to increase this, but be aware that this may lead to very long processing times if the way to group lines into messages is misdetected. Server default: 10000.
+        # @option arguments [Integer] :lines_to_sample The number of lines to include in the structural analysis, starting from the beginning of the text.
+        #  The minimum is 2.
+        #  If the value of this parameter is greater than the number of lines in the text, the analysis proceeds (as long as there are at least two lines in the text) for all of the lines.NOTE: The number of lines and the variation of the lines affects the speed of the analysis.
+        #  For example, if you upload text where the first 1000 lines are all variations on the same message, the analysis will find more commonality than would be seen with a bigger sample.
+        #  If possible, however, it is more efficient to upload sample text with more variety in the first 1000 lines than to request analysis of 100000 lines to achieve some variety. Server default: 1000.
+        # @option arguments [String] :quote If you have set +format+ to +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 you have set +format+ to +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 then 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 were 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 separated from the +ss+ by a +.+, +,+ or +:+.
+        #  Spacing and punctuation is also permitted with the exception of +?+, 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 The contents of the file to be analyzed (*Required*)
+        # @option arguments [Hash] :body text_files
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/find-structure.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-text-structure-find-structure
         #
         def find_structure(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'text_structure.find_structure' }
@@ -52,14 +124,14 @@ module Elasticsearch
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          body   = arguments.delete(:body)
+          body = arguments.delete(:body)
 
           method = Elasticsearch::API::HTTP_POST
           path   = '_text_structure/find_structure'
           params = Utils.process_params(arguments)
 
           payload = if body.is_a? Array
-                      Elasticsearch::API::Utils.__bulkify(body)
+                      Elasticsearch::API::Utils.bulkify(body)
                     else
                       body
                     end

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

@@ -15,20 +15,24 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# 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
-        # Tests a Grok pattern on some text.
+        # Test a Grok pattern.
+        # Test a Grok pattern on one or more lines of text.
+        # The API indicates whether the lines match the pattern together with the offsets and lengths of the matched substrings.
         #
-        # @option arguments [String] :ecs_compatibility Optional parameter to specify the compatibility mode with ECS Grok patterns - may be either 'v1' or 'disabled'
+        # @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.
+        #  Valid values are +disabled+ and +v1+. Server default: disabled.
         # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body The Grok pattern and text. (*Required*)
+        # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/test-grok-pattern.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-text-structure-test-grok-pattern
         #
         def test_grok_pattern(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'text_structure.test_grok_pattern' }
@@ -38,7 +42,7 @@ module Elasticsearch
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          body   = arguments.delete(:body)
+          body = arguments.delete(:body)
 
           method = Elasticsearch::API::HTTP_POST
           path   = '_text_structure/test_grok_pattern'

data/lib/elasticsearch/api/actions/transform/delete_transform.rb

@@ -15,22 +15,24 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# 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 Transform
       module Actions
-        # Deletes an existing transform.
+        # Delete a transform.
         #
-        # @option arguments [String] :transform_id The id of the transform to delete
-        # @option arguments [Boolean] :force When `true`, the transform is deleted regardless of its current state. The default value is `false`, meaning that the transform must be `stopped` before it can be deleted.
-        # @option arguments [Boolean] :delete_dest_index When `true`, the destination index is deleted together with the transform. The default value is `false`, meaning that the destination index will not be deleted.
-        # @option arguments [Time] :timeout Controls the time to wait for the transform deletion
+        # @option arguments [String] :transform_id Identifier for the transform. (*Required*)
+        # @option arguments [Boolean] :force If this value is false, the transform must be stopped before it can be deleted. If true, the transform is
+        #  deleted regardless of its current state.
+        # @option arguments [Boolean] :delete_dest_index If this value is true, the destination index is deleted together with the transform. If false, the destination
+        #  index will not be deleted
+        # @option arguments [Time] :timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/delete-transform.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-transform-delete-transform
         #
         def delete_transform(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'transform.delete_transform' }
@@ -50,7 +52,7 @@ module Elasticsearch
           _transform_id = arguments.delete(:transform_id)
 
           method = Elasticsearch::API::HTTP_DELETE
-          path   = "_transform/#{Utils.__listify(_transform_id)}"
+          path   = "_transform/#{Utils.listify(_transform_id)}"
           params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(

data/lib/elasticsearch/api/actions/transform/get_node_stats.rb

@@ -15,9 +15,9 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# 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 Transform
@@ -26,7 +26,7 @@ module Elasticsearch
         #
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-transform-node-stats.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform-node-stats.html
         #
         def get_node_stats(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'transform.get_node_stats' }
@@ -34,9 +34,14 @@ module Elasticsearch
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          body   = nil
+          body = arguments.delete(:body)
+
+          method = if body
+                     Elasticsearch::API::HTTP_POST
+                   else
+                     Elasticsearch::API::HTTP_GET
+                   end
 
-          method = Elasticsearch::API::HTTP_GET
           path   = '_transform/_node_stats'
           params = {}
 

data/lib/elasticsearch/api/actions/transform/get_transform.rb

@@ -15,23 +15,34 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# 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 Transform
       module Actions
-        # Retrieves configuration information for transforms.
+        # Get transforms.
+        # Get configuration information for transforms.
         #
-        # @option arguments [String] :transform_id The id or comma delimited list of id expressions of the transforms to get, '_all' or '*' implies get all transforms
-        # @option arguments [Integer] :from skips a number of transform configs, defaults to 0
-        # @option arguments [Integer] :size specifies a max number of transforms to get, defaults to 100
-        # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no transforms. (This includes `_all` string or when no transforms have been specified)
-        # @option arguments [Boolean] :exclude_generated Omits fields that are illegal to set on transform PUT
+        # @option arguments [String, Array<String>] :transform_id Identifier for the transform. It can be a transform identifier or a
+        #  wildcard expression. You can get information for all transforms by using
+        #  +_all+, by specifying +*+ as the +<transform_id>+, or by omitting the
+        #  +<transform_id>+.
+        # @option arguments [Boolean] :allow_no_match Specifies what to do when the request:
+        #  - Contains wildcard expressions and there are no transforms that match.
+        #  - Contains the _all string or no identifiers and there are no matches.
+        #  - Contains wildcard expressions and there are only partial matches.
+        #  If this parameter is false, the request returns a 404 status code when
+        #  there are no matches or only partial matches. Server default: true.
+        # @option arguments [Integer] :from Skips the specified number of transforms. Server default: 0.
+        # @option arguments [Integer] :size Specifies the maximum number of transforms to obtain. Server default: 100.
+        # @option arguments [Boolean] :exclude_generated Excludes fields that were automatically added when creating the
+        #  transform. This allows the configuration to be in an acceptable format to
+        #  be retrieved and then added to another cluster.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-transform.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-transform-get-transform
         #
         def get_transform(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'transform.get_transform' }
@@ -50,7 +61,7 @@ module Elasticsearch
 
           method = Elasticsearch::API::HTTP_GET
           path   = if _transform_id
-                     "_transform/#{Utils.__listify(_transform_id)}"
+                     "_transform/#{Utils.listify(_transform_id)}"
                    else
                      '_transform'
                    end