|
@@ -9,13 +9,12 @@
|
|
|
|
|
|
experimental::[]
|
|
|
|
|
|
-The Find File Structure API can be used to find the structure of a text file
|
|
|
-and other information that will be useful to import its contents to an {es}
|
|
|
-index. It accepts a +{request}+ object and responds
|
|
|
-with a +{response}+ object.
|
|
|
+Determines the structure of a text file and other information that will be
|
|
|
+useful to import its contents to an {es} index. It accepts a +{request}+ object
|
|
|
+and responds with a +{response}+ object.
|
|
|
|
|
|
[id="{upid}-{api}-request"]
|
|
|
-==== Find File Structure Request
|
|
|
+==== Find file structure request
|
|
|
|
|
|
A sample from the beginning of the file (or the entire file contents if
|
|
|
it's small) must be added to the +{request}+ object using the
|
|
@@ -28,7 +27,7 @@ include-tagged::{doc-tests-file}[{api}-request]
|
|
|
<1> Create a new `FindFileStructureRequest` object
|
|
|
<2> Add the contents of `anInterestingFile` to the request
|
|
|
|
|
|
-==== Optional Arguments
|
|
|
+==== Optional arguments
|
|
|
|
|
|
The following arguments are optional.
|
|
|
|
|
@@ -43,7 +42,7 @@ include-tagged::{doc-tests-file}[{api}-request-options]
|
|
|
include::../execution.asciidoc[]
|
|
|
|
|
|
[id="{upid}-{api}-response"]
|
|
|
-==== Find File Structure Response
|
|
|
+==== Find file structure response
|
|
|
|
|
|
A +{response}+ contains information about the file structure,
|
|
|
as well as mappings and an ingest pipeline that could be used
|