1 2 3[[Elasticsearch_Namespaces_TextStructureNamespace]] 4=== Elasticsearch\Namespaces\TextStructureNamespace 5 6 7 8Class TextStructureNamespace 9 10*Description* 11 12 13NOTE: this file is autogenerated using util/GenerateEndpoints.php 14and Elasticsearch 7.12.1 (3186837139b9c6b6d23c3200870651f10d3343b7) 15 16 17*Methods* 18 19The class defines the following methods: 20 21* <<Elasticsearch_Namespaces_TextStructureNamespacefindStructure_findStructure,`findStructure()`>> 22 23 24 25[[Elasticsearch_Namespaces_TextStructureNamespacefindStructure_findStructure]] 26.`findStructure(array $params = [])` 27**** 28[source,php] 29---- 30/* 31$params['lines_to_sample'] = (int) How many lines of the file should be included in the analysis (Default = 1000) 32$params['line_merge_size_limit'] = (int) Maximum number of characters permitted in a single message when lines are merged to create messages. (Default = 10000) 33$params['timeout'] = (time) Timeout after which the analysis will be aborted (Default = 25s) 34$params['charset'] = (string) Optional parameter to specify the character set of the file 35$params['format'] = (enum) Optional parameter to specify the high level file format (Options = ndjson,xml,delimited,semi_structured_text) 36$params['has_header_row'] = (boolean) Optional parameter to specify whether a delimited file includes the column names in its first row 37$params['column_names'] = (list) Optional parameter containing a comma separated list of the column names for a delimited file 38$params['delimiter'] = (string) Optional parameter to specify the delimiter character for a delimited file - must be a single character 39$params['quote'] = (string) Optional parameter to specify the quote character for a delimited file - must be a single character 40$params['should_trim_fields'] = (boolean) Optional parameter to specify whether the values between delimiters in a delimited file should have whitespace trimmed from them 41$params['grok_pattern'] = (string) Optional parameter to specify the Grok pattern that should be used to extract fields from messages in a semi-structured text file 42$params['timestamp_field'] = (string) Optional parameter to specify the timestamp field in the file 43$params['timestamp_format'] = (string) Optional parameter to specify the timestamp format in the file - may be either a Joda or Java time format 44$params['explain'] = (boolean) Whether to include a commentary on how the structure was derived (Default = false) 45$params['body'] = (array) The contents of the file to be analyzed (Required) 46*/ 47---- 48**** 49 50 51