habsi/elasticsearch-js
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

API generation

Browse Source
This commit is contained in:
delvedor
2019-04-10 11:45:50 +02:00
parent 48c6ad15a6
commit 1afa23b11d
3 changed files with 48 additions and 586 deletions
Download Patch File Download Diff File Expand all files Collapse all files

143
docs/reference.asciidoc
View File

@ -4289,149 +4289,6 @@ link:http://www.elastic.co/guide/en/elasticsearch/reference/current[Reference]
|===
<<<<<<< HEAD
=======
=== dataFrame.deleteDataFrameTransform
[source,js]
----
client.dataFrame.deleteDataFrameTransform([params] [, options] [, callback])
----
link:{ref}/delete-data-frame-transform.html[Reference]
[cols=2*]
|===
|`transform_id` or `transformId`
|`string` - The id of the transform to delete
|===
=== dataFrame.getDataFrameTransform
[source,js]
----
client.dataFrame.getDataFrameTransform([params] [, options] [, callback])
----
link:{ref}/get-data-frame-transform.html[Reference]
[cols=2*]
|===
|`transform_id` or `transformId`
|`string` - The id or comma delimited list of id expressions of the transforms to get, '_all' or '*' implies get all transforms
|`from`
|`number` - skips a number of transform configs, defaults to 0
|`size`
|`number` - specifies a max number of transforms to get, defaults to 100
|===
=== dataFrame.getDataFrameTransformStats
[source,js]
----
client.dataFrame.getDataFrameTransformStats([params] [, options] [, callback])
----
link:{ref}/get-data-frame-transform-stats.html[Reference]
[cols=2*]
|===
|`transform_id` or `transformId`
|`string` - The id of the transform for which to get stats. '_all' or '*' implies all transforms
|`from`
|`number` - skips a number of transform stats, defaults to 0
|`size`
|`number` - specifies a max number of transform stats to get, defaults to 100
|===
=== dataFrame.previewDataFrameTransform
[source,js]
----
client.dataFrame.previewDataFrameTransform([params] [, options] [, callback])
----
link:{ref}/preview-data-frame-transform.html[Reference]
[cols=2*]
|===
|`body`
|`object` - The definition for the data_frame transform to preview
|===
=== dataFrame.putDataFrameTransform
[source,js]
----
client.dataFrame.putDataFrameTransform([params] [, options] [, callback])
----
link:{ref}/put-data-frame-transform.html[Reference]
[cols=2*]
|===
|`transform_id` or `transformId`
|`string` - The id of the new transform.
|`body`
|`object` - The data frame transform definition
|===
=== dataFrame.startDataFrameTransform
[source,js]
----
client.dataFrame.startDataFrameTransform([params] [, options] [, callback])
----
link:{ref}/start-data-frame-transform.html[Reference]
[cols=2*]
|===
|`transform_id` or `transformId`
|`string` - The id of the transform to start
|`timeout`
|`string` - Controls the time to wait for the transform to start
|===
=== dataFrame.stopDataFrameTransform
[source,js]
----
client.dataFrame.stopDataFrameTransform([params] [, options] [, callback])
----
link:{ref}/stop-data-frame-transform.html[Reference]
[cols=2*]
|===
|`transform_id` or `transformId`
|`string` - The id of the transform to stop
|`wait_for_completion` or `waitForCompletion`
|`boolean` - Whether to wait for the transform to fully stop before returning or not. Default to false
|`timeout`
|`string` - Controls the time to wait until the transform has stopped. Default to 30 seconds
|===
=== graph.explore
[source,js]
----
client.graph.explore([params] [, options] [, callback])
----
link:{ref}/graph-explore-api.html[Reference]
[cols=2*]
|===
|`index`
|`string, string[]` - A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
|`type`
|`string, string[]` - A comma-separated list of document types to search; leave empty to perform the operation on all types
|`routing`
|`string` - Specific routing value
|`timeout`
|`string` - Explicit operation timeout
|`body`
|`object` - Graph Query DSL
|===
>>>>>>> a21281f... Improve typings (#813)
=== ilm.deleteLifecycle
[source,js]
----