diff --git a/docs/api_methods_1_0.asciidoc b/docs/api_methods_1_0.asciidoc index 66b0fe717..1c619aa03 100644 --- a/docs/api_methods_1_0.asciidoc +++ b/docs/api_methods_1_0.asciidoc @@ -41,6 +41,7 @@ NOTE: At this time, you must opt into the 1.0 API by setting the `apiVersion` co * <> * <> * <> +* <> * <> * <> * <> @@ -2136,6 +2137,39 @@ The default method is `GET` and the usual <> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-thread-pool.html[the elasticsearch docs] for more about this method. + +// no examples + + +==== Params + +[horizontal] +`local`:: +`Boolean` -- Return local information, do not retrieve the state from master node (default: false) +`masterTimeout`:: +`Date, Number` -- Explicit operation timeout for connection to master node +`h`:: +`String, String[], Boolean` -- Comma-separated list of column names to display +`help`:: +`Boolean` -- Return help information +`v`:: +`Boolean` -- Verbose mode. Display column headers +`fullId`:: +`Boolean` -- Enables displaying the complete node ids + +link:#[back to top] + [[api-cluster-getsettings-1-0]] === `cluster.getSettings` diff --git a/docs/api_methods_1_x.asciidoc b/docs/api_methods_1_x.asciidoc index 9aa524ddc..a7c15c720 100644 --- a/docs/api_methods_1_x.asciidoc +++ b/docs/api_methods_1_x.asciidoc @@ -41,6 +41,7 @@ NOTE: At this time, you must opt into the 1.x API by setting the `apiVersion` co * <> * <> * <> +* <> * <> * <> * <> @@ -2136,6 +2137,39 @@ The default method is `GET` and the usual <> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-thread-pool.html[the elasticsearch docs] for more about this method. + +// no examples + + +==== Params + +[horizontal] +`local`:: +`Boolean` -- Return local information, do not retrieve the state from master node (default: false) +`masterTimeout`:: +`Date, Number` -- Explicit operation timeout for connection to master node +`h`:: +`String, String[], Boolean` -- Comma-separated list of column names to display +`help`:: +`Boolean` -- Return help information +`v`:: +`Boolean` -- Verbose mode. Display column headers +`fullId`:: +`Boolean` -- Enables displaying the complete node ids + +link:#[back to top] + [[api-cluster-getsettings-1-x]] === `cluster.getSettings` diff --git a/docs/api_methods_master.asciidoc b/docs/api_methods_master.asciidoc index c296ba823..dc3ea5e1b 100644 --- a/docs/api_methods_master.asciidoc +++ b/docs/api_methods_master.asciidoc @@ -41,6 +41,7 @@ NOTE: At this time, you must opt into the master API by setting the `apiVersion` * <> * <> * <> +* <> * <> * <> * <> @@ -2136,6 +2137,39 @@ The default method is `GET` and the usual <> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-thread-pool.html[the elasticsearch docs] for more about this method. + +// no examples + + +==== Params + +[horizontal] +`local`:: +`Boolean` -- Return local information, do not retrieve the state from master node (default: false) +`masterTimeout`:: +`Date, Number` -- Explicit operation timeout for connection to master node +`h`:: +`String, String[], Boolean` -- Comma-separated list of column names to display +`help`:: +`Boolean` -- Return help information +`v`:: +`Boolean` -- Verbose mode. Display column headers +`fullId`:: +`Boolean` -- Enables displaying the complete node ids + +link:#[back to top] + [[api-cluster-getsettings-master]] === `cluster.getSettings` diff --git a/src/lib/apis/1_0.js b/src/lib/apis/1_0.js index 47e63256d..0479b8aec 100644 --- a/src/lib/apis/1_0.js +++ b/src/lib/apis/1_0.js @@ -565,6 +565,48 @@ api.cat.prototype.shards = ca({ ] }); +/** + * Perform a [cat.threadPool](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-thread-pool.html) request + * + * @param {Object} params - An object with parameters used to carry out this action + * @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false) + * @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {String, String[], Boolean} params.h - Comma-separated list of column names to display + * @param {Boolean} params.help - Return help information + * @param {Boolean} params.v - Verbose mode. Display column headers + * @param {Boolean} params.fullId - Enables displaying the complete node ids + */ +api.cat.prototype.threadPool = ca({ + params: { + local: { + type: 'boolean' + }, + masterTimeout: { + type: 'time', + name: 'master_timeout' + }, + h: { + type: 'list' + }, + help: { + type: 'boolean', + 'default': false + }, + v: { + type: 'boolean', + 'default': false + }, + fullId: { + type: 'boolean', + 'default': false, + name: 'full_id' + } + }, + url: { + fmt: '/_cat/thread_pool' + } +}); + /** * Perform a [clearScroll](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-request-scroll.html) request * diff --git a/src/lib/apis/1_x.js b/src/lib/apis/1_x.js index 47e63256d..0479b8aec 100644 --- a/src/lib/apis/1_x.js +++ b/src/lib/apis/1_x.js @@ -565,6 +565,48 @@ api.cat.prototype.shards = ca({ ] }); +/** + * Perform a [cat.threadPool](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-thread-pool.html) request + * + * @param {Object} params - An object with parameters used to carry out this action + * @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false) + * @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {String, String[], Boolean} params.h - Comma-separated list of column names to display + * @param {Boolean} params.help - Return help information + * @param {Boolean} params.v - Verbose mode. Display column headers + * @param {Boolean} params.fullId - Enables displaying the complete node ids + */ +api.cat.prototype.threadPool = ca({ + params: { + local: { + type: 'boolean' + }, + masterTimeout: { + type: 'time', + name: 'master_timeout' + }, + h: { + type: 'list' + }, + help: { + type: 'boolean', + 'default': false + }, + v: { + type: 'boolean', + 'default': false + }, + fullId: { + type: 'boolean', + 'default': false, + name: 'full_id' + } + }, + url: { + fmt: '/_cat/thread_pool' + } +}); + /** * Perform a [clearScroll](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-request-scroll.html) request * diff --git a/src/lib/apis/master.js b/src/lib/apis/master.js index 277a11c03..c6459b892 100644 --- a/src/lib/apis/master.js +++ b/src/lib/apis/master.js @@ -565,6 +565,48 @@ api.cat.prototype.shards = ca({ ] }); +/** + * Perform a [cat.threadPool](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-thread-pool.html) request + * + * @param {Object} params - An object with parameters used to carry out this action + * @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false) + * @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {String, String[], Boolean} params.h - Comma-separated list of column names to display + * @param {Boolean} params.help - Return help information + * @param {Boolean} params.v - Verbose mode. Display column headers + * @param {Boolean} params.fullId - Enables displaying the complete node ids + */ +api.cat.prototype.threadPool = ca({ + params: { + local: { + type: 'boolean' + }, + masterTimeout: { + type: 'time', + name: 'master_timeout' + }, + h: { + type: 'list' + }, + help: { + type: 'boolean', + 'default': false + }, + v: { + type: 'boolean', + 'default': false + }, + fullId: { + type: 'boolean', + 'default': false, + name: 'full_id' + } + }, + url: { + fmt: '/_cat/thread_pool' + } +}); + /** * Perform a [clearScroll](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-request-scroll.html) request *