From 63d511ad2791e89459670a540752285f6b5349fe Mon Sep 17 00:00:00 2001 From: spalger Date: Tue, 27 Oct 2015 10:40:28 -0500 Subject: [PATCH] [apis] regenerate --- docs/api_methods_2_1.asciidoc | 62 +++++++++++++++++++++++++++++ src/lib/apis/2_1.js | 75 +++++++++++++++++++++++++++++++++++ src/lib/apis/2_x.js | 75 +++++++++++++++++++++++++++++++++++ 3 files changed, 212 insertions(+) diff --git a/docs/api_methods_2_1.asciidoc b/docs/api_methods_2_1.asciidoc index c7b137a77..efc4f53bd 100644 --- a/docs/api_methods_2_1.asciidoc +++ b/docs/api_methods_2_1.asciidoc @@ -2450,6 +2450,37 @@ Options::: link:#[back to top] +[[api-cat-repositories-2-1]] +=== `cat.repositories` + +[source,js] +-------- +client.cat.repositories([params, [callback]]) +-------- + +// no description + +The default method is `GET` and the usual <> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-repositories.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 +`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 + +link:#[back to top] + [[api-cat-segments-2-1]] === `cat.segments` @@ -2512,6 +2543,37 @@ The default method is `GET` and the usual <> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-snapshots.html[the elasticsearch docs] for more about this method. + +// no examples + + +*Params* + +[horizontal] +`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 +`repository`:: +`String, String[], Boolean` -- Name of repository from which to fetch the snapshot information + +link:#[back to top] + [[api-cat-threadpool-2-1]] === `cat.threadPool` diff --git a/src/lib/apis/2_1.js b/src/lib/apis/2_1.js index 434b28af7..1d82dbe62 100644 --- a/src/lib/apis/2_1.js +++ b/src/lib/apis/2_1.js @@ -649,6 +649,43 @@ api.cat.prototype.recovery = ca({ ] }); +/** + * Perform a [cat.repositories](http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-repositories.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 + * @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 + */ +api.cat.prototype.repositories = ca({ + params: { + local: { + type: 'boolean', + 'default': false + }, + masterTimeout: { + type: 'time', + name: 'master_timeout' + }, + h: { + type: 'list' + }, + help: { + type: 'boolean', + 'default': false + }, + v: { + type: 'boolean', + 'default': false + } + }, + url: { + fmt: '/_cat/repositories' + } +}); + /** * Perform a [cat.segments](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/cat-segments.html) request * @@ -734,6 +771,44 @@ api.cat.prototype.shards = ca({ ] }); +/** + * Perform a [cat.snapshots](http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-snapshots.html) request + * + * @param {Object} params - An object with parameters used to carry out this action + * @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 {String, String[], Boolean} params.repository - Name of repository from which to fetch the snapshot information + */ +api.cat.prototype.snapshots = ca({ + params: { + masterTimeout: { + type: 'time', + name: 'master_timeout' + }, + h: { + type: 'list' + }, + help: { + type: 'boolean', + 'default': false + }, + v: { + type: 'boolean', + 'default': false + } + }, + url: { + fmt: '/_cat/snapshots/<%=repository%>', + req: { + repository: { + type: 'list' + } + } + } +}); + /** * Perform a [cat.threadPool](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/cat-thread-pool.html) request * diff --git a/src/lib/apis/2_x.js b/src/lib/apis/2_x.js index de3d93b6e..fe0c342fd 100644 --- a/src/lib/apis/2_x.js +++ b/src/lib/apis/2_x.js @@ -649,6 +649,43 @@ api.cat.prototype.recovery = ca({ ] }); +/** + * Perform a [cat.repositories](http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-repositories.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 + * @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 + */ +api.cat.prototype.repositories = ca({ + params: { + local: { + type: 'boolean', + 'default': false + }, + masterTimeout: { + type: 'time', + name: 'master_timeout' + }, + h: { + type: 'list' + }, + help: { + type: 'boolean', + 'default': false + }, + v: { + type: 'boolean', + 'default': false + } + }, + url: { + fmt: '/_cat/repositories' + } +}); + /** * Perform a [cat.segments](http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-segments.html) request * @@ -734,6 +771,44 @@ api.cat.prototype.shards = ca({ ] }); +/** + * Perform a [cat.snapshots](http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-snapshots.html) request + * + * @param {Object} params - An object with parameters used to carry out this action + * @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 {String, String[], Boolean} params.repository - Name of repository from which to fetch the snapshot information + */ +api.cat.prototype.snapshots = ca({ + params: { + masterTimeout: { + type: 'time', + name: 'master_timeout' + }, + h: { + type: 'list' + }, + help: { + type: 'boolean', + 'default': false + }, + v: { + type: 'boolean', + 'default': false + } + }, + url: { + fmt: '/_cat/snapshots/<%=repository%>', + req: { + repository: { + type: 'list' + } + } + } +}); + /** * Perform a [cat.threadPool](http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-thread-pool.html) request *