From 29eb81a52c794c1334003e79f4ec9884592f0858 Mon Sep 17 00:00:00 2001 From: spalger Date: Wed, 16 Nov 2016 12:29:56 -0700 Subject: [PATCH] [docs] label timestamp/duration types differently --- docs/api_methods.asciidoc | 194 +++++++++++++-------------- docs/api_methods_0_90.asciidoc | 94 ++++++------- docs/api_methods_1_0.asciidoc | 130 +++++++++--------- docs/api_methods_1_1.asciidoc | 134 +++++++++---------- docs/api_methods_1_2.asciidoc | 136 +++++++++---------- docs/api_methods_1_3.asciidoc | 136 +++++++++---------- docs/api_methods_1_4.asciidoc | 140 ++++++++++---------- docs/api_methods_1_5.asciidoc | 148 ++++++++++----------- docs/api_methods_1_6.asciidoc | 148 ++++++++++----------- docs/api_methods_1_7.asciidoc | 168 ++++++++++++------------ docs/api_methods_2_0.asciidoc | 152 ++++++++++----------- docs/api_methods_2_1.asciidoc | 156 +++++++++++----------- docs/api_methods_2_2.asciidoc | 156 +++++++++++----------- docs/api_methods_2_3.asciidoc | 162 +++++++++++------------ docs/api_methods_2_4.asciidoc | 176 ++++++++++++------------- scripts/generate/templates/index.js | 5 +- src/lib/apis/0_90.js | 94 ++++++------- src/lib/apis/1_0.js | 130 +++++++++--------- src/lib/apis/1_1.js | 134 +++++++++---------- src/lib/apis/1_2.js | 136 +++++++++---------- src/lib/apis/1_3.js | 136 +++++++++---------- src/lib/apis/1_4.js | 140 ++++++++++---------- src/lib/apis/1_5.js | 148 ++++++++++----------- src/lib/apis/1_6.js | 148 ++++++++++----------- src/lib/apis/1_7.js | 168 ++++++++++++------------ src/lib/apis/2_0.js | 152 ++++++++++----------- src/lib/apis/2_1.js | 156 +++++++++++----------- src/lib/apis/2_2.js | 156 +++++++++++----------- src/lib/apis/2_3.js | 162 +++++++++++------------ src/lib/apis/2_4.js | 176 ++++++++++++------------- src/lib/apis/5_0.js | 194 +++++++++++++-------------- src/lib/apis/5_x.js | 196 ++++++++++++++-------------- src/lib/apis/master.js | 196 ++++++++++++++-------------- 33 files changed, 2429 insertions(+), 2428 deletions(-) diff --git a/docs/api_methods.asciidoc b/docs/api_methods.asciidoc index 544bb2b11..eac4c1e47 100644 --- a/docs/api_methods.asciidoc +++ b/docs/api_methods.asciidoc @@ -56,7 +56,7 @@ Options::: `routing`:: `String` -- Specific routing value `timeout`:: -`Date, Number` -- Explicit operation timeout +`DurationString` -- Explicit operation timeout `type`:: `String` -- Default document type for items which don't provide one `fields`:: @@ -304,11 +304,11 @@ Options::: `routing`:: `String` -- Specific routing value `timeout`:: -`Date, Number` -- Explicit operation timeout +`DurationString` -- Explicit operation timeout `timestamp`:: -`Date, Number` -- Explicit timestamp for the document +`Timestamp` -- Explicit timestamp for the document `ttl`:: -`Date, Number` -- Expiration time for the document +`DurationString` -- Expiration time for the document `version`:: `Number` -- Explicit version number for concurrency control `versionType`:: @@ -373,7 +373,7 @@ Options::: `routing`:: `String` -- Specific routing value `timeout`:: -`Date, Number` -- Explicit operation timeout +`DurationString` -- Explicit operation timeout `version`:: `Number` -- Explicit version number for concurrency control `versionType`:: @@ -478,7 +478,7 @@ Options::: `routing`:: `String, String[], Boolean` -- A comma-separated list of specific routing values `scroll`:: -`Date, Number` -- Specify how long a consistent view of the index should be maintained for scrolled search +`DurationString` -- Specify how long a consistent view of the index should be maintained for scrolled search `searchType`:: `String` -- Search operation type Options::: @@ -486,7 +486,7 @@ Options::: * `"dfs_query_then_fetch"` `searchTimeout`:: -`Date, Number` -- Explicit timeout for each search request. Defaults to no timeout. +`DurationString` -- Explicit timeout for each search request. Defaults to no timeout. `size`:: `Number` -- Number of hits to return (default: 10) `sort`:: @@ -508,7 +508,7 @@ Options::: `refresh`:: `Boolean` -- Should the effected indexes be refreshed? `[timeout=1m]`:: -`Date, Number` -- Time each individual bulk request should wait for shards that are unavailable. +`DurationString` -- Time each individual bulk request should wait for shards that are unavailable. `waitForActiveShards`:: `String` -- Sets the number of shard copies that must be active before proceeding with the delete by query operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1) `scrollSize`:: @@ -982,11 +982,11 @@ Options::: `routing`:: `String` -- Specific routing value `timeout`:: -`Date, Number` -- Explicit operation timeout +`DurationString` -- Explicit operation timeout `timestamp`:: -`Date, Number` -- Explicit timestamp for the document +`Timestamp` -- Explicit timestamp for the document `ttl`:: -`Date, Number` -- Expiration time for the document +`DurationString` -- Expiration time for the document `version`:: `Number` -- Explicit version number for concurrency control `versionType`:: @@ -1494,7 +1494,7 @@ The default method is `POST` and the usual <: pairs @@ -2933,7 +2933,7 @@ api.scroll = ca({ * @param {String} [params.suggestMode=missing] - Specify suggest mode * @param {Number} params.suggestSize - How many suggestions to return in response * @param {String} params.suggestText - The source text for which the suggestions should be returned - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {Boolean} params.version - Specify whether to return document version as part of a hit * @param {String, String[], Boolean} params.index - A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices * @param {String, String[], Boolean} params.type - A comma-separated list of document types to search; leave empty to perform the operation on all types @@ -3152,9 +3152,9 @@ api.suggest = ca({ * @param {Number} params.retryOnConflict - Specify how many times should the operation be retried when a conflict occurs (default: 0) * @param {String} params.routing - Specific routing value * @param {String} params.script - The URL-encoded script definition (instead of using request body) - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.timestamp - Explicit timestamp for the document - * @param {Date, Number} params.ttl - Expiration time for the document + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.timestamp - Explicit timestamp for the document + * @param {DurationString} params.ttl - Expiration time for the document * @param {Number} params.version - Explicit version number for concurrency control * @param {String} params.versionType - Specific version type * @param {String} params.id - Document ID @@ -3252,9 +3252,9 @@ api.update = ca({ * @param {Boolean} params.refresh - Refresh the index after performing the operation * @param {String} [params.replication=sync] - Specific replication type * @param {String} params.routing - Specific routing value - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.timestamp - Explicit timestamp for the document - * @param {Date, Number} params.ttl - Expiration time for the document + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.timestamp - Explicit timestamp for the document + * @param {DurationString} params.ttl - Expiration time for the document * @param {Number} params.version - Explicit version number for concurrency control * @param {String} params.versionType - Specific version type * @param {String} params.id - Document ID diff --git a/src/lib/apis/1_0.js b/src/lib/apis/1_0.js index 20278ed68..99f93e77b 100644 --- a/src/lib/apis/1_0.js +++ b/src/lib/apis/1_0.js @@ -12,7 +12,7 @@ api._namespaces = ['cat', 'cluster', 'indices', 'nodes', 'snapshot']; * @param {Boolean} params.refresh - Refresh the index after performing the operation * @param {String} [params.replication=sync] - Explicitely set the replication type * @param {String} params.routing - Specific routing value - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String} params.type - Default document type for items which don't provide one * @param {String} params.index - Default index for items which don't provide one */ @@ -83,7 +83,7 @@ api.cat = namespace(); * * @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 {DurationString} 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 @@ -131,7 +131,7 @@ api.cat.prototype.aliases = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.bytes - The unit in which to display byte values * @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 {DurationString} 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 @@ -187,7 +187,7 @@ api.cat.prototype.allocation = ca({ * * @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 {DurationString} 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 @@ -234,7 +234,7 @@ api.cat.prototype.count = ca({ * * @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 {DurationString} 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.ts=true] - Set to false to disable timestamping @@ -294,7 +294,7 @@ api.cat.prototype.help = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.bytes - The unit in which to display byte values * @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 {DurationString} 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.pri - Set to true to return stats only for primary shards @@ -355,7 +355,7 @@ api.cat.prototype.indices = ca({ * * @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 {DurationString} 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 @@ -391,7 +391,7 @@ api.cat.prototype.master = ca({ * * @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 {DurationString} 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 @@ -427,7 +427,7 @@ api.cat.prototype.nodes = ca({ * * @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 {DurationString} 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 @@ -464,7 +464,7 @@ api.cat.prototype.pendingTasks = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.bytes - The unit in which to display byte values * @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 {DurationString} 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 @@ -520,7 +520,7 @@ api.cat.prototype.recovery = ca({ * * @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 {DurationString} 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 @@ -567,7 +567,7 @@ api.cat.prototype.shards = ca({ * * @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 {DurationString} 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 @@ -634,8 +634,8 @@ api.cluster = namespace(); * * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) - * @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout */ api.cluster.prototype.getSettings = ca({ params: { @@ -662,8 +662,8 @@ api.cluster.prototype.getSettings = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} [params.level=cluster] - Specify the level of detail for returned information * @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 {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout * @param {Number} params.waitForActiveShards - Wait until the specified number of shards is active * @param {String} params.waitForNodes - Wait until the specified number of nodes is available * @param {Number} params.waitForRelocatingShards - Wait until the specified number of relocating shards is finished @@ -734,7 +734,7 @@ api.cluster.prototype.health = ca({ * * @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 - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master */ api.cluster.prototype.pendingTasks = ca({ params: { @@ -776,8 +776,8 @@ api.cluster.prototype.putSettings = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.dryRun - Simulate the operation only and return the resulting state * @param {Boolean} params.filterMetadata - Don't return cluster state metadata (default: false) - * @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout */ api.cluster.prototype.reroute = ca({ params: { @@ -808,7 +808,7 @@ api.cluster.prototype.reroute = ca({ * * @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 - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String, String[], Boolean} params.indexTemplates - A comma separated list to return specific index templates when returning metadata * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) * @param {String, String[], Boolean} params.index - A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices @@ -1085,7 +1085,7 @@ api.countPercolate = ca({ * @param {Boolean} params.refresh - Refresh the index after performing the operation * @param {String} [params.replication=sync] - Specific replication type * @param {String} params.routing - Specific routing value - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {Number} params.version - Explicit version number for concurrency control * @param {String} params.versionType - Specific version type * @param {String} params.id - The document ID @@ -1166,7 +1166,7 @@ api['delete'] = ca({ * @param {String} params.q - Query in the Lucene query string syntax * @param {String} params.routing - Specific routing value * @param {String} params.source - The URL-encoded query definition (instead of using the request body) - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String, String[], Boolean} params.index - A comma-separated list of indices to restrict the operation; use `_all` to perform the operation on all indices * @param {String, String[], Boolean} params.type - A comma-separated list of types to restrict the operation */ @@ -1565,8 +1565,8 @@ api.getSource = ca({ * @param {Boolean} params.refresh - Refresh the index after performing the operation * @param {String} [params.replication=sync] - Specific replication type * @param {String} params.routing - Specific routing value - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.timestamp - Explicit timestamp for the document + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.timestamp - Explicit timestamp for the document * @param {Duration} params.ttl - Expiration time for the document * @param {Number} params.version - Explicit version number for concurrency control * @param {String} params.versionType - Specific version type @@ -1818,8 +1818,8 @@ api.indices.prototype.clearCache = ca({ * Perform a [indices.close](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-open-close.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) * @param {String} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both. @@ -1867,8 +1867,8 @@ api.indices.prototype.close = ca({ * Perform a [indices.create](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-create-index.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String} params.index - The name of the index */ api.indices.prototype.create = ca({ @@ -1896,8 +1896,8 @@ api.indices.prototype.create = ca({ * Perform a [indices.delete](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-delete-index.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String, String[], Boolean} params.index - A comma-separated list of indices to delete; use `_all` or `*` string to delete all indices */ api.indices.prototype['delete'] = ca({ @@ -1925,8 +1925,8 @@ api.indices.prototype['delete'] = ca({ * Perform a [indices.deleteAlias](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-aliases.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit timestamp for the document - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit timestamp for the document + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String, String[], Boolean} params.index - A comma-separated list of index names (supports wildcards); use `_all` for all indices * @param {String, String[], Boolean} params.name - A comma-separated list of aliases to delete (supports wildcards); use `_all` to delete all aliases for the specified indices. */ @@ -1958,7 +1958,7 @@ api.indices.prototype.deleteAlias = ca({ * Perform a [indices.deleteMapping](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-delete-mapping.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String, String[], Boolean} params.index - A comma-separated list of index names (supports wildcards); use `_all` for all indices * @param {String, String[], Boolean} params.type - A comma-separated list of document types to delete (supports wildcards); use `_all` to delete all document types in the specified indices. */ @@ -1987,8 +1987,8 @@ api.indices.prototype.deleteMapping = ca({ * Perform a [indices.deleteTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-templates.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String} params.name - The name of the template */ api.indices.prototype.deleteTemplate = ca({ @@ -2016,7 +2016,7 @@ api.indices.prototype.deleteTemplate = ca({ * Perform a [indices.deleteWarmer](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-warmers.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String, String[], Boolean} params.name - A comma-separated list of warmer names to delete (supports wildcards); use `_all` to delete all warmers in the specified indices. You must specify a name either in the uri or in the parameters. * @param {String, String[], Boolean} params.index - A comma-separated list of index names to delete warmers from (supports wildcards); use `_all` to perform the operation on all indices. */ @@ -2354,7 +2354,7 @@ api.indices.prototype.getAlias = ca({ * Perform a [indices.getAliases](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-aliases.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false) * @param {String, String[], Boolean} params.index - A comma-separated list of index names to filter aliases * @param {String, String[], Boolean} params.name - A comma-separated list of alias names to filter @@ -2754,8 +2754,8 @@ api.indices.prototype.getWarmer = ca({ * Perform a [indices.open](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-open-close.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) * @param {String} [params.expandWildcards=closed] - Whether to expand wildcard expression to concrete indices that are open, closed or both. @@ -2871,8 +2871,8 @@ api.indices.prototype.optimize = ca({ * Perform a [indices.putAlias](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-aliases.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit timestamp for the document - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit timestamp for the document + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String, String[], Boolean} params.index - A comma-separated list of index names the alias should point to (supports wildcards); use `_all` or omit to perform the operation on all indices. * @param {String} params.name - The name of the alias to be created or updated */ @@ -2915,8 +2915,8 @@ api.indices.prototype.putAlias = ca({ * * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.ignoreConflicts - Specify whether to ignore conflicts while updating the mapping (default: false) - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) * @param {String} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both. @@ -2983,7 +2983,7 @@ api.indices.prototype.putMapping = ca({ * Perform a [indices.putSettings](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-update-settings.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) * @param {String} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both. @@ -3040,8 +3040,8 @@ api.indices.prototype.putSettings = ca({ * * @param {Object} params - An object with parameters used to carry out this action * @param {Number} params.order - The order for this template when merging multiple matching ones (higher numbers are merged later, overriding the lower numbers) - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) * @param {String} params.name - The name of the template */ @@ -3078,7 +3078,7 @@ api.indices.prototype.putTemplate = ca({ * Perform a [indices.putWarmer](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-warmers.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) in the search request to warm * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices in the search request to warm. (This includes `_all` string or when no indices have been specified) * @param {String} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both, in the search request to warm. @@ -3483,8 +3483,8 @@ api.indices.prototype.status = ca({ * Perform a [indices.updateAliases](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-aliases.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Request timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Request timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master */ api.indices.prototype.updateAliases = ca({ params: { @@ -3989,7 +3989,7 @@ api.nodes = namespace(); * Perform a [nodes.hotThreads](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cluster-nodes-hot-threads.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.interval - The interval for the second sampling of threads + * @param {DurationString} params.interval - The interval for the second sampling of threads * @param {Number} params.snapshots - Number of samples of thread stacktrace (default: 10) * @param {Number} params.threads - Specify the number of threads to provide information for (default: 3) * @param {String} params.type - The type to sample (default: cpu) @@ -4110,7 +4110,7 @@ api.nodes.prototype.info = ca({ * Perform a [nodes.shutdown](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cluster-nodes-shutdown.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.delay - Set the delay for the operation (default: 1s) + * @param {DurationString} params.delay - Set the delay for the operation (default: 1s) * @param {Boolean} params.exit - Exit the JVM as well (default: true) * @param {String, String[], Boolean} params.nodeId - A comma-separated list of node IDs or names to perform the operation on; use `_local` to perform the operation on the node you're connected to, leave empty to perform the operation on all nodes */ @@ -4506,7 +4506,7 @@ api.scroll = ca({ * @param {String} [params.suggestMode=missing] - Specify suggest mode * @param {Number} params.suggestSize - How many suggestions to return in response * @param {Text} params.suggestText - The source text for which the suggestions should be returned - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {Boolean} params.trackScores - Whether to calculate and return scores even if they are not used for sorting * @param {Boolean} params.version - Specify whether to return document version as part of a hit * @param {String, String[], Boolean} params.index - A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices @@ -4752,7 +4752,7 @@ api.snapshot = namespace(); * Perform a [snapshot.create](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {Boolean} params.waitForCompletion - Should this request wait until the operation has completed before returning * @param {String} params.repository - A repository name * @param {String} params.snapshot - A snapshot name @@ -4787,8 +4787,8 @@ api.snapshot.prototype.create = ca({ * Perform a [snapshot.createRepository](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/modules-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 {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String} params.repository - A repository name */ api.snapshot.prototype.createRepository = ca({ @@ -4817,7 +4817,7 @@ api.snapshot.prototype.createRepository = ca({ * Perform a [snapshot.delete](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {String} params.repository - A repository name * @param {String} params.snapshot - A snapshot name */ @@ -4846,8 +4846,8 @@ api.snapshot.prototype['delete'] = ca({ * Perform a [snapshot.deleteRepository](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/modules-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 {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String, String[], Boolean} params.repository - A comma-separated list of repository names */ api.snapshot.prototype.deleteRepository = ca({ @@ -4875,7 +4875,7 @@ api.snapshot.prototype.deleteRepository = ca({ * Perform a [snapshot.get](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {String} params.repository - A repository name * @param {String, String[], Boolean} params.snapshot - A comma-separated list of snapshot names */ @@ -4903,7 +4903,7 @@ api.snapshot.prototype.get = ca({ * Perform a [snapshot.getRepository](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false) * @param {String, String[], Boolean} params.repository - A comma-separated list of repository names */ @@ -4936,7 +4936,7 @@ api.snapshot.prototype.getRepository = ca({ * Perform a [snapshot.restore](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {Boolean} params.waitForCompletion - Should this request wait until the operation has completed before returning * @param {String} params.repository - A repository name * @param {String} params.snapshot - A snapshot name @@ -5118,8 +5118,8 @@ api.termvector = ca({ * @param {Number} params.retryOnConflict - Specify how many times should the operation be retried when a conflict occurs (default: 0) * @param {String} params.routing - Specific routing value * @param {Anything} params.script - The URL-encoded script definition (instead of using request body) - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.timestamp - Explicit timestamp for the document + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.timestamp - Explicit timestamp for the document * @param {Duration} params.ttl - Expiration time for the document * @param {Number} params.version - Explicit version number for concurrency control * @param {String} params.versionType - Specific version type @@ -5212,8 +5212,8 @@ api.update = ca({ * @param {Boolean} params.refresh - Refresh the index after performing the operation * @param {String} [params.replication=sync] - Specific replication type * @param {String} params.routing - Specific routing value - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.timestamp - Explicit timestamp for the document + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.timestamp - Explicit timestamp for the document * @param {Duration} params.ttl - Expiration time for the document * @param {Number} params.version - Explicit version number for concurrency control * @param {String} params.versionType - Specific version type diff --git a/src/lib/apis/1_1.js b/src/lib/apis/1_1.js index 22e77b98d..59793bd10 100644 --- a/src/lib/apis/1_1.js +++ b/src/lib/apis/1_1.js @@ -12,7 +12,7 @@ api._namespaces = ['cat', 'cluster', 'indices', 'nodes', 'snapshot']; * @param {Boolean} params.refresh - Refresh the index after performing the operation * @param {String} [params.replication=sync] - Explicitely set the replication type * @param {String} params.routing - Specific routing value - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String} params.type - Default document type for items which don't provide one * @param {String} params.index - Default index for items which don't provide one */ @@ -83,7 +83,7 @@ api.cat = namespace(); * * @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 {DurationString} 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 @@ -131,7 +131,7 @@ api.cat.prototype.aliases = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.bytes - The unit in which to display byte values * @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 {DurationString} 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 @@ -187,7 +187,7 @@ api.cat.prototype.allocation = ca({ * * @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 {DurationString} 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 @@ -234,7 +234,7 @@ api.cat.prototype.count = ca({ * * @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 {DurationString} 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.ts=true] - Set to false to disable timestamping @@ -294,7 +294,7 @@ api.cat.prototype.help = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.bytes - The unit in which to display byte values * @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 {DurationString} 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.pri - Set to true to return stats only for primary shards @@ -355,7 +355,7 @@ api.cat.prototype.indices = ca({ * * @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 {DurationString} 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 @@ -391,7 +391,7 @@ api.cat.prototype.master = ca({ * * @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 {DurationString} 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 @@ -427,7 +427,7 @@ api.cat.prototype.nodes = ca({ * * @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 {DurationString} 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 @@ -463,7 +463,7 @@ api.cat.prototype.pendingTasks = ca({ * * @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 {DurationString} 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 @@ -499,7 +499,7 @@ api.cat.prototype.plugins = ca({ * * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.bytes - The unit in which to display byte values - * @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} 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 @@ -552,7 +552,7 @@ api.cat.prototype.recovery = ca({ * * @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 {DurationString} 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 @@ -599,7 +599,7 @@ api.cat.prototype.shards = ca({ * * @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 {DurationString} 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 @@ -666,8 +666,8 @@ api.cluster = namespace(); * * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) - * @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout */ api.cluster.prototype.getSettings = ca({ params: { @@ -694,8 +694,8 @@ api.cluster.prototype.getSettings = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} [params.level=cluster] - Specify the level of detail for returned information * @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 {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout * @param {Number} params.waitForActiveShards - Wait until the specified number of shards is active * @param {String} params.waitForNodes - Wait until the specified number of nodes is available * @param {Number} params.waitForRelocatingShards - Wait until the specified number of relocating shards is finished @@ -766,7 +766,7 @@ api.cluster.prototype.health = ca({ * * @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 - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master */ api.cluster.prototype.pendingTasks = ca({ params: { @@ -809,8 +809,8 @@ api.cluster.prototype.putSettings = ca({ * @param {Boolean} params.dryRun - Simulate the operation only and return the resulting state * @param {Boolean} params.explain - Return an explanation of why the commands can or cannot be executed * @param {Boolean} params.filterMetadata - Don't return cluster state metadata (default: false) - * @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout */ api.cluster.prototype.reroute = ca({ params: { @@ -844,7 +844,7 @@ api.cluster.prototype.reroute = ca({ * * @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 - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String, String[], Boolean} params.indexTemplates - A comma separated list to return specific index templates when returning metadata * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) * @param {String, String[], Boolean} params.index - A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices @@ -1123,7 +1123,7 @@ api.countPercolate = ca({ * @param {Boolean} params.refresh - Refresh the index after performing the operation * @param {String} [params.replication=sync] - Specific replication type * @param {String} params.routing - Specific routing value - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {Number} params.version - Explicit version number for concurrency control * @param {String} params.versionType - Specific version type * @param {String} params.id - The document ID @@ -1206,7 +1206,7 @@ api['delete'] = ca({ * @param {String} params.q - Query in the Lucene query string syntax * @param {String} params.routing - Specific routing value * @param {String} params.source - The URL-encoded query definition (instead of using the request body) - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String, String[], Boolean} params.index - A comma-separated list of indices to restrict the operation; use `_all` to perform the operation on all indices * @param {String, String[], Boolean} params.type - A comma-separated list of types to restrict the operation */ @@ -1609,8 +1609,8 @@ api.getSource = ca({ * @param {Boolean} params.refresh - Refresh the index after performing the operation * @param {String} [params.replication=sync] - Specific replication type * @param {String} params.routing - Specific routing value - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.timestamp - Explicit timestamp for the document + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.timestamp - Explicit timestamp for the document * @param {Duration} params.ttl - Expiration time for the document * @param {Number} params.version - Explicit version number for concurrency control * @param {String} params.versionType - Specific version type @@ -1869,8 +1869,8 @@ api.indices.prototype.clearCache = ca({ * Perform a [indices.close](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/indices-open-close.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) * @param {String} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both. @@ -1918,8 +1918,8 @@ api.indices.prototype.close = ca({ * Perform a [indices.create](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/indices-create-index.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String} params.index - The name of the index */ api.indices.prototype.create = ca({ @@ -1947,8 +1947,8 @@ api.indices.prototype.create = ca({ * Perform a [indices.delete](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/indices-delete-index.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String, String[], Boolean} params.index - A comma-separated list of indices to delete; use `_all` or `*` string to delete all indices */ api.indices.prototype['delete'] = ca({ @@ -1976,8 +1976,8 @@ api.indices.prototype['delete'] = ca({ * Perform a [indices.deleteAlias](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/indices-aliases.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit timestamp for the document - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit timestamp for the document + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String, String[], Boolean} params.index - A comma-separated list of index names (supports wildcards); use `_all` for all indices * @param {String, String[], Boolean} params.name - A comma-separated list of aliases to delete (supports wildcards); use `_all` to delete all aliases for the specified indices. */ @@ -2009,7 +2009,7 @@ api.indices.prototype.deleteAlias = ca({ * Perform a [indices.deleteMapping](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/indices-delete-mapping.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String, String[], Boolean} params.index - A comma-separated list of index names (supports wildcards); use `_all` for all indices * @param {String, String[], Boolean} params.type - A comma-separated list of document types to delete (supports wildcards); use `_all` to delete all document types in the specified indices. */ @@ -2038,8 +2038,8 @@ api.indices.prototype.deleteMapping = ca({ * Perform a [indices.deleteTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/indices-templates.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String} params.name - The name of the template */ api.indices.prototype.deleteTemplate = ca({ @@ -2067,7 +2067,7 @@ api.indices.prototype.deleteTemplate = ca({ * Perform a [indices.deleteWarmer](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/indices-warmers.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String, String[], Boolean} params.name - A comma-separated list of warmer names to delete (supports wildcards); use `_all` to delete all warmers in the specified indices. You must specify a name either in the uri or in the parameters. * @param {String, String[], Boolean} params.index - A comma-separated list of index names to delete warmers from (supports wildcards); use `_all` to perform the operation on all indices. */ @@ -2405,7 +2405,7 @@ api.indices.prototype.getAlias = ca({ * Perform a [indices.getAliases](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/indices-aliases.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false) * @param {String, String[], Boolean} params.index - A comma-separated list of index names to filter aliases * @param {String, String[], Boolean} params.name - A comma-separated list of alias names to filter @@ -2805,8 +2805,8 @@ api.indices.prototype.getWarmer = ca({ * Perform a [indices.open](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/indices-open-close.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) * @param {String} [params.expandWildcards=closed] - Whether to expand wildcard expression to concrete indices that are open, closed or both. @@ -2926,8 +2926,8 @@ api.indices.prototype.optimize = ca({ * Perform a [indices.putAlias](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/indices-aliases.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit timestamp for the document - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit timestamp for the document + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String, String[], Boolean} params.index - A comma-separated list of index names the alias should point to (supports wildcards); use `_all` or omit to perform the operation on all indices. * @param {String} params.name - The name of the alias to be created or updated */ @@ -2970,8 +2970,8 @@ api.indices.prototype.putAlias = ca({ * * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.ignoreConflicts - Specify whether to ignore conflicts while updating the mapping (default: false) - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) * @param {String} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both. @@ -3038,7 +3038,7 @@ api.indices.prototype.putMapping = ca({ * Perform a [indices.putSettings](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/indices-update-settings.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) * @param {String} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both. @@ -3095,8 +3095,8 @@ api.indices.prototype.putSettings = ca({ * * @param {Object} params - An object with parameters used to carry out this action * @param {Number} params.order - The order for this template when merging multiple matching ones (higher numbers are merged later, overriding the lower numbers) - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) * @param {String} params.name - The name of the template */ @@ -3133,7 +3133,7 @@ api.indices.prototype.putTemplate = ca({ * Perform a [indices.putWarmer](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/indices-warmers.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) in the search request to warm * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices in the search request to warm. (This includes `_all` string or when no indices have been specified) * @param {String} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both, in the search request to warm. @@ -3578,8 +3578,8 @@ api.indices.prototype.status = ca({ * Perform a [indices.updateAliases](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/indices-aliases.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Request timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Request timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master */ api.indices.prototype.updateAliases = ca({ params: { @@ -4084,7 +4084,7 @@ api.nodes = namespace(); * Perform a [nodes.hotThreads](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/cluster-nodes-hot-threads.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.interval - The interval for the second sampling of threads + * @param {DurationString} params.interval - The interval for the second sampling of threads * @param {Number} params.snapshots - Number of samples of thread stacktrace (default: 10) * @param {Number} params.threads - Specify the number of threads to provide information for (default: 3) * @param {String} params.type - The type to sample (default: cpu) @@ -4205,7 +4205,7 @@ api.nodes.prototype.info = ca({ * Perform a [nodes.shutdown](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/cluster-nodes-shutdown.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.delay - Set the delay for the operation (default: 1s) + * @param {DurationString} params.delay - Set the delay for the operation (default: 1s) * @param {Boolean} params.exit - Exit the JVM as well (default: true) * @param {String, String[], Boolean} params.nodeId - A comma-separated list of node IDs or names to perform the operation on; use `_local` to perform the operation on the node you're connected to, leave empty to perform the operation on all nodes */ @@ -4603,7 +4603,7 @@ api.scroll = ca({ * @param {String} [params.suggestMode=missing] - Specify suggest mode * @param {Number} params.suggestSize - How many suggestions to return in response * @param {Text} params.suggestText - The source text for which the suggestions should be returned - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {Boolean} params.trackScores - Whether to calculate and return scores even if they are not used for sorting * @param {Boolean} params.version - Specify whether to return document version as part of a hit * @param {String, String[], Boolean} params.index - A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices @@ -4884,7 +4884,7 @@ api.snapshot = namespace(); * Perform a [snapshot.create](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {Boolean} params.waitForCompletion - Should this request wait until the operation has completed before returning * @param {String} params.repository - A repository name * @param {String} params.snapshot - A snapshot name @@ -4919,8 +4919,8 @@ api.snapshot.prototype.create = ca({ * Perform a [snapshot.createRepository](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/modules-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 {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String} params.repository - A repository name */ api.snapshot.prototype.createRepository = ca({ @@ -4949,7 +4949,7 @@ api.snapshot.prototype.createRepository = ca({ * Perform a [snapshot.delete](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {String} params.repository - A repository name * @param {String} params.snapshot - A snapshot name */ @@ -4978,8 +4978,8 @@ api.snapshot.prototype['delete'] = ca({ * Perform a [snapshot.deleteRepository](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/modules-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 {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String, String[], Boolean} params.repository - A comma-separated list of repository names */ api.snapshot.prototype.deleteRepository = ca({ @@ -5007,7 +5007,7 @@ api.snapshot.prototype.deleteRepository = ca({ * Perform a [snapshot.get](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {String} params.repository - A repository name * @param {String, String[], Boolean} params.snapshot - A comma-separated list of snapshot names */ @@ -5035,7 +5035,7 @@ api.snapshot.prototype.get = ca({ * Perform a [snapshot.getRepository](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false) * @param {String, String[], Boolean} params.repository - A comma-separated list of repository names */ @@ -5068,7 +5068,7 @@ api.snapshot.prototype.getRepository = ca({ * Perform a [snapshot.restore](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {Boolean} params.waitForCompletion - Should this request wait until the operation has completed before returning * @param {String} params.repository - A repository name * @param {String} params.snapshot - A snapshot name @@ -5103,7 +5103,7 @@ api.snapshot.prototype.restore = ca({ * Perform a [snapshot.status](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {String} params.repository - A repository name * @param {String, String[], Boolean} params.snapshot - A comma-separated list of snapshot names */ @@ -5291,8 +5291,8 @@ api.termvector = ca({ * @param {Number} params.retryOnConflict - Specify how many times should the operation be retried when a conflict occurs (default: 0) * @param {String} params.routing - Specific routing value * @param {Anything} params.script - The URL-encoded script definition (instead of using request body) - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.timestamp - Explicit timestamp for the document + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.timestamp - Explicit timestamp for the document * @param {Duration} params.ttl - Expiration time for the document * @param {Number} params.version - Explicit version number for concurrency control * @param {String} params.versionType - Specific version type @@ -5387,8 +5387,8 @@ api.update = ca({ * @param {Boolean} params.refresh - Refresh the index after performing the operation * @param {String} [params.replication=sync] - Specific replication type * @param {String} params.routing - Specific routing value - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.timestamp - Explicit timestamp for the document + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.timestamp - Explicit timestamp for the document * @param {Duration} params.ttl - Expiration time for the document * @param {Number} params.version - Explicit version number for concurrency control * @param {String} params.versionType - Specific version type diff --git a/src/lib/apis/1_2.js b/src/lib/apis/1_2.js index 3f049d81d..e1fcd9430 100644 --- a/src/lib/apis/1_2.js +++ b/src/lib/apis/1_2.js @@ -12,7 +12,7 @@ api._namespaces = ['cat', 'cluster', 'indices', 'nodes', 'snapshot']; * @param {Boolean} params.refresh - Refresh the index after performing the operation * @param {String} [params.replication=sync] - Explicitely set the replication type * @param {String} params.routing - Specific routing value - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String} params.type - Default document type for items which don't provide one * @param {String} params.index - Default index for items which don't provide one */ @@ -83,7 +83,7 @@ api.cat = namespace(); * * @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 {DurationString} 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 @@ -131,7 +131,7 @@ api.cat.prototype.aliases = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.bytes - The unit in which to display byte values * @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 {DurationString} 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 @@ -187,7 +187,7 @@ api.cat.prototype.allocation = ca({ * * @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 {DurationString} 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 @@ -235,7 +235,7 @@ api.cat.prototype.count = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.bytes - The unit in which to display byte values * @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 {DurationString} 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 @@ -294,7 +294,7 @@ api.cat.prototype.fielddata = ca({ * * @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 {DurationString} 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.ts=true] - Set to false to disable timestamping @@ -354,7 +354,7 @@ api.cat.prototype.help = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.bytes - The unit in which to display byte values * @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 {DurationString} 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.pri - Set to true to return stats only for primary shards @@ -415,7 +415,7 @@ api.cat.prototype.indices = ca({ * * @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 {DurationString} 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 @@ -451,7 +451,7 @@ api.cat.prototype.master = ca({ * * @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 {DurationString} 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 @@ -487,7 +487,7 @@ api.cat.prototype.nodes = ca({ * * @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 {DurationString} 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 @@ -523,7 +523,7 @@ api.cat.prototype.pendingTasks = ca({ * * @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 {DurationString} 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 @@ -559,7 +559,7 @@ api.cat.prototype.plugins = ca({ * * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.bytes - The unit in which to display byte values - * @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} 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 @@ -612,7 +612,7 @@ api.cat.prototype.recovery = ca({ * * @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 {DurationString} 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 @@ -659,7 +659,7 @@ api.cat.prototype.shards = ca({ * * @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 {DurationString} 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 @@ -726,8 +726,8 @@ api.cluster = namespace(); * * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) - * @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout */ api.cluster.prototype.getSettings = ca({ params: { @@ -754,8 +754,8 @@ api.cluster.prototype.getSettings = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} [params.level=cluster] - Specify the level of detail for returned information * @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 {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout * @param {Number} params.waitForActiveShards - Wait until the specified number of shards is active * @param {String} params.waitForNodes - Wait until the specified number of nodes is available * @param {Number} params.waitForRelocatingShards - Wait until the specified number of relocating shards is finished @@ -826,7 +826,7 @@ api.cluster.prototype.health = ca({ * * @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 - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master */ api.cluster.prototype.pendingTasks = ca({ params: { @@ -869,8 +869,8 @@ api.cluster.prototype.putSettings = ca({ * @param {Boolean} params.dryRun - Simulate the operation only and return the resulting state * @param {Boolean} params.explain - Return an explanation of why the commands can or cannot be executed * @param {Boolean} params.filterMetadata - Don't return cluster state metadata (default: false) - * @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout */ api.cluster.prototype.reroute = ca({ params: { @@ -904,7 +904,7 @@ api.cluster.prototype.reroute = ca({ * * @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 - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) * @param {String, String[], Boolean} params.index - A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices * @param {String, String[], Boolean} params.metric - Limit the information returned to the specified metrics @@ -1178,7 +1178,7 @@ api.countPercolate = ca({ * @param {Boolean} params.refresh - Refresh the index after performing the operation * @param {String} [params.replication=sync] - Specific replication type * @param {String} params.routing - Specific routing value - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {Number} params.version - Explicit version number for concurrency control * @param {String} params.versionType - Specific version type * @param {String} params.id - The document ID @@ -1261,7 +1261,7 @@ api['delete'] = ca({ * @param {String} params.q - Query in the Lucene query string syntax * @param {String} params.routing - Specific routing value * @param {String} params.source - The URL-encoded query definition (instead of using the request body) - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String, String[], Boolean} params.index - A comma-separated list of indices to restrict the operation; use `_all` to perform the operation on all indices * @param {String, String[], Boolean} params.type - A comma-separated list of types to restrict the operation */ @@ -1664,8 +1664,8 @@ api.getSource = ca({ * @param {Boolean} params.refresh - Refresh the index after performing the operation * @param {String} [params.replication=sync] - Specific replication type * @param {String} params.routing - Specific routing value - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.timestamp - Explicit timestamp for the document + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.timestamp - Explicit timestamp for the document * @param {Duration} params.ttl - Expiration time for the document * @param {Number} params.version - Explicit version number for concurrency control * @param {String} params.versionType - Specific version type @@ -1924,8 +1924,8 @@ api.indices.prototype.clearCache = ca({ * Perform a [indices.close](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/indices-open-close.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) * @param {String} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both. @@ -1973,8 +1973,8 @@ api.indices.prototype.close = ca({ * Perform a [indices.create](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/indices-create-index.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String} params.index - The name of the index */ api.indices.prototype.create = ca({ @@ -2002,8 +2002,8 @@ api.indices.prototype.create = ca({ * Perform a [indices.delete](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/indices-delete-index.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String, String[], Boolean} params.index - A comma-separated list of indices to delete; use `_all` or `*` string to delete all indices */ api.indices.prototype['delete'] = ca({ @@ -2031,8 +2031,8 @@ api.indices.prototype['delete'] = ca({ * Perform a [indices.deleteAlias](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/indices-aliases.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit timestamp for the document - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit timestamp for the document + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String, String[], Boolean} params.index - A comma-separated list of index names (supports wildcards); use `_all` for all indices * @param {String, String[], Boolean} params.name - A comma-separated list of aliases to delete (supports wildcards); use `_all` to delete all aliases for the specified indices. */ @@ -2064,7 +2064,7 @@ api.indices.prototype.deleteAlias = ca({ * Perform a [indices.deleteMapping](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/indices-delete-mapping.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String, String[], Boolean} params.index - A comma-separated list of index names (supports wildcards); use `_all` for all indices * @param {String, String[], Boolean} params.type - A comma-separated list of document types to delete (supports wildcards); use `_all` to delete all document types in the specified indices. */ @@ -2093,8 +2093,8 @@ api.indices.prototype.deleteMapping = ca({ * Perform a [indices.deleteTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/indices-templates.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String} params.name - The name of the template */ api.indices.prototype.deleteTemplate = ca({ @@ -2122,7 +2122,7 @@ api.indices.prototype.deleteTemplate = ca({ * Perform a [indices.deleteWarmer](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/indices-warmers.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String, String[], Boolean} params.name - A comma-separated list of warmer names to delete (supports wildcards); use `_all` to delete all warmers in the specified indices. You must specify a name either in the uri or in the parameters. * @param {String, String[], Boolean} params.index - A comma-separated list of index names to delete warmers from (supports wildcards); use `_all` to perform the operation on all indices. */ @@ -2460,7 +2460,7 @@ api.indices.prototype.getAlias = ca({ * Perform a [indices.getAliases](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/indices-aliases.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false) * @param {String, String[], Boolean} params.index - A comma-separated list of index names to filter aliases * @param {String, String[], Boolean} params.name - A comma-separated list of alias names to filter @@ -2860,8 +2860,8 @@ api.indices.prototype.getWarmer = ca({ * Perform a [indices.open](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/indices-open-close.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) * @param {String} [params.expandWildcards=closed] - Whether to expand wildcard expression to concrete indices that are open, closed or both. @@ -2981,8 +2981,8 @@ api.indices.prototype.optimize = ca({ * Perform a [indices.putAlias](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/indices-aliases.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit timestamp for the document - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit timestamp for the document + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String, String[], Boolean} params.index - A comma-separated list of index names the alias should point to (supports wildcards); use `_all` or omit to perform the operation on all indices. * @param {String} params.name - The name of the alias to be created or updated */ @@ -3025,8 +3025,8 @@ api.indices.prototype.putAlias = ca({ * * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.ignoreConflicts - Specify whether to ignore conflicts while updating the mapping (default: false) - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) * @param {String} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both. @@ -3093,7 +3093,7 @@ api.indices.prototype.putMapping = ca({ * Perform a [indices.putSettings](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/indices-update-settings.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) * @param {String} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both. @@ -3150,8 +3150,8 @@ api.indices.prototype.putSettings = ca({ * * @param {Object} params - An object with parameters used to carry out this action * @param {Number} params.order - The order for this template when merging multiple matching ones (higher numbers are merged later, overriding the lower numbers) - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) * @param {String} params.name - The name of the template */ @@ -3188,7 +3188,7 @@ api.indices.prototype.putTemplate = ca({ * Perform a [indices.putWarmer](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/indices-warmers.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) in the search request to warm * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices in the search request to warm. (This includes `_all` string or when no indices have been specified) * @param {String} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both, in the search request to warm. @@ -3590,8 +3590,8 @@ api.indices.prototype.status = ca({ * Perform a [indices.updateAliases](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/indices-aliases.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Request timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Request timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master */ api.indices.prototype.updateAliases = ca({ params: { @@ -4096,7 +4096,7 @@ api.nodes = namespace(); * Perform a [nodes.hotThreads](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/cluster-nodes-hot-threads.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.interval - The interval for the second sampling of threads + * @param {DurationString} params.interval - The interval for the second sampling of threads * @param {Number} params.snapshots - Number of samples of thread stacktrace (default: 10) * @param {Number} params.threads - Specify the number of threads to provide information for (default: 3) * @param {String} params.type - The type to sample (default: cpu) @@ -4217,7 +4217,7 @@ api.nodes.prototype.info = ca({ * Perform a [nodes.shutdown](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/cluster-nodes-shutdown.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.delay - Set the delay for the operation (default: 1s) + * @param {DurationString} params.delay - Set the delay for the operation (default: 1s) * @param {Boolean} params.exit - Exit the JVM as well (default: true) * @param {String, String[], Boolean} params.nodeId - A comma-separated list of node IDs or names to perform the operation on; use `_local` to perform the operation on the node you're connected to, leave empty to perform the operation on all nodes */ @@ -4617,7 +4617,7 @@ api.scroll = ca({ * @param {String} [params.suggestMode=missing] - Specify suggest mode * @param {Number} params.suggestSize - How many suggestions to return in response * @param {Text} params.suggestText - The source text for which the suggestions should be returned - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {Boolean} params.trackScores - Whether to calculate and return scores even if they are not used for sorting * @param {Boolean} params.version - Specify whether to return document version as part of a hit * @param {String, String[], Boolean} params.index - A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices @@ -4945,7 +4945,7 @@ api.snapshot = namespace(); * Perform a [snapshot.create](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {Boolean} params.waitForCompletion - Should this request wait until the operation has completed before returning * @param {String} params.repository - A repository name * @param {String} params.snapshot - A snapshot name @@ -4980,8 +4980,8 @@ api.snapshot.prototype.create = ca({ * Perform a [snapshot.createRepository](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/modules-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 {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String} params.repository - A repository name */ api.snapshot.prototype.createRepository = ca({ @@ -5010,7 +5010,7 @@ api.snapshot.prototype.createRepository = ca({ * Perform a [snapshot.delete](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {String} params.repository - A repository name * @param {String} params.snapshot - A snapshot name */ @@ -5039,8 +5039,8 @@ api.snapshot.prototype['delete'] = ca({ * Perform a [snapshot.deleteRepository](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/modules-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 {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String, String[], Boolean} params.repository - A comma-separated list of repository names */ api.snapshot.prototype.deleteRepository = ca({ @@ -5068,7 +5068,7 @@ api.snapshot.prototype.deleteRepository = ca({ * Perform a [snapshot.get](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {String} params.repository - A repository name * @param {String, String[], Boolean} params.snapshot - A comma-separated list of snapshot names */ @@ -5096,7 +5096,7 @@ api.snapshot.prototype.get = ca({ * Perform a [snapshot.getRepository](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false) * @param {String, String[], Boolean} params.repository - A comma-separated list of repository names */ @@ -5129,7 +5129,7 @@ api.snapshot.prototype.getRepository = ca({ * Perform a [snapshot.restore](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {Boolean} params.waitForCompletion - Should this request wait until the operation has completed before returning * @param {String} params.repository - A repository name * @param {String} params.snapshot - A snapshot name @@ -5164,7 +5164,7 @@ api.snapshot.prototype.restore = ca({ * Perform a [snapshot.status](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {String} params.repository - A repository name * @param {String, String[], Boolean} params.snapshot - A comma-separated list of snapshot names */ @@ -5352,8 +5352,8 @@ api.termvector = ca({ * @param {Number} params.retryOnConflict - Specify how many times should the operation be retried when a conflict occurs (default: 0) * @param {String} params.routing - Specific routing value * @param {Anything} params.script - The URL-encoded script definition (instead of using request body) - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.timestamp - Explicit timestamp for the document + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.timestamp - Explicit timestamp for the document * @param {Duration} params.ttl - Expiration time for the document * @param {Number} params.version - Explicit version number for concurrency control * @param {String} params.versionType - Specific version type @@ -5446,8 +5446,8 @@ api.update = ca({ * @param {Boolean} params.refresh - Refresh the index after performing the operation * @param {String} [params.replication=sync] - Specific replication type * @param {String} params.routing - Specific routing value - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.timestamp - Explicit timestamp for the document + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.timestamp - Explicit timestamp for the document * @param {Duration} params.ttl - Expiration time for the document * @param {Number} params.version - Explicit version number for concurrency control * @param {String} params.versionType - Specific version type diff --git a/src/lib/apis/1_3.js b/src/lib/apis/1_3.js index 4a66ef22c..afaab77ec 100644 --- a/src/lib/apis/1_3.js +++ b/src/lib/apis/1_3.js @@ -12,7 +12,7 @@ api._namespaces = ['cat', 'cluster', 'indices', 'nodes', 'snapshot']; * @param {Boolean} params.refresh - Refresh the index after performing the operation * @param {String} [params.replication=sync] - Explicitely set the replication type * @param {String} params.routing - Specific routing value - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String} params.type - Default document type for items which don't provide one * @param {String} params.index - Default index for items which don't provide one */ @@ -83,7 +83,7 @@ api.cat = namespace(); * * @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 {DurationString} 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 @@ -131,7 +131,7 @@ api.cat.prototype.aliases = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.bytes - The unit in which to display byte values * @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 {DurationString} 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 @@ -187,7 +187,7 @@ api.cat.prototype.allocation = ca({ * * @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 {DurationString} 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 @@ -235,7 +235,7 @@ api.cat.prototype.count = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.bytes - The unit in which to display byte values * @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 {DurationString} 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 @@ -294,7 +294,7 @@ api.cat.prototype.fielddata = ca({ * * @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 {DurationString} 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.ts=true] - Set to false to disable timestamping @@ -354,7 +354,7 @@ api.cat.prototype.help = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.bytes - The unit in which to display byte values * @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 {DurationString} 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.pri - Set to true to return stats only for primary shards @@ -415,7 +415,7 @@ api.cat.prototype.indices = ca({ * * @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 {DurationString} 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 @@ -451,7 +451,7 @@ api.cat.prototype.master = ca({ * * @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 {DurationString} 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 @@ -487,7 +487,7 @@ api.cat.prototype.nodes = ca({ * * @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 {DurationString} 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 @@ -523,7 +523,7 @@ api.cat.prototype.pendingTasks = ca({ * * @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 {DurationString} 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 @@ -559,7 +559,7 @@ api.cat.prototype.plugins = ca({ * * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.bytes - The unit in which to display byte values - * @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} 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 @@ -650,7 +650,7 @@ api.cat.prototype.segments = ca({ * * @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 {DurationString} 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 @@ -697,7 +697,7 @@ api.cat.prototype.shards = ca({ * * @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 {DurationString} 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 @@ -764,8 +764,8 @@ api.cluster = namespace(); * * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) - * @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout */ api.cluster.prototype.getSettings = ca({ params: { @@ -792,8 +792,8 @@ api.cluster.prototype.getSettings = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} [params.level=cluster] - Specify the level of detail for returned information * @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 {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout * @param {Number} params.waitForActiveShards - Wait until the specified number of shards is active * @param {String} params.waitForNodes - Wait until the specified number of nodes is available * @param {Number} params.waitForRelocatingShards - Wait until the specified number of relocating shards is finished @@ -864,7 +864,7 @@ api.cluster.prototype.health = ca({ * * @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 - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master */ api.cluster.prototype.pendingTasks = ca({ params: { @@ -907,8 +907,8 @@ api.cluster.prototype.putSettings = ca({ * @param {Boolean} params.dryRun - Simulate the operation only and return the resulting state * @param {Boolean} params.explain - Return an explanation of why the commands can or cannot be executed * @param {Boolean} params.filterMetadata - Don't return cluster state metadata (default: false) - * @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout */ api.cluster.prototype.reroute = ca({ params: { @@ -942,7 +942,7 @@ api.cluster.prototype.reroute = ca({ * * @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 - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) * @param {String, String[], Boolean} params.index - A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices * @param {String, String[], Boolean} params.metric - Limit the information returned to the specified metrics @@ -1216,7 +1216,7 @@ api.countPercolate = ca({ * @param {Boolean} params.refresh - Refresh the index after performing the operation * @param {String} [params.replication=sync] - Specific replication type * @param {String} params.routing - Specific routing value - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {Number} params.version - Explicit version number for concurrency control * @param {String} params.versionType - Specific version type * @param {String} params.id - The document ID @@ -1299,7 +1299,7 @@ api['delete'] = ca({ * @param {String} params.q - Query in the Lucene query string syntax * @param {String} params.routing - Specific routing value * @param {String} params.source - The URL-encoded query definition (instead of using the request body) - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String, String[], Boolean} params.index - A comma-separated list of indices to restrict the operation; use `_all` to perform the operation on all indices * @param {String, String[], Boolean} params.type - A comma-separated list of types to restrict the operation */ @@ -1780,8 +1780,8 @@ api.getTemplate = ca({ * @param {Boolean} params.refresh - Refresh the index after performing the operation * @param {String} [params.replication=sync] - Specific replication type * @param {String} params.routing - Specific routing value - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.timestamp - Explicit timestamp for the document + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.timestamp - Explicit timestamp for the document * @param {Duration} params.ttl - Expiration time for the document * @param {Number} params.version - Explicit version number for concurrency control * @param {String} params.versionType - Specific version type @@ -2040,8 +2040,8 @@ api.indices.prototype.clearCache = ca({ * Perform a [indices.close](http://www.elastic.co/guide/en/elasticsearch/reference/1.3/indices-open-close.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) * @param {String} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both. @@ -2089,8 +2089,8 @@ api.indices.prototype.close = ca({ * Perform a [indices.create](http://www.elastic.co/guide/en/elasticsearch/reference/1.3/indices-create-index.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String} params.index - The name of the index */ api.indices.prototype.create = ca({ @@ -2118,8 +2118,8 @@ api.indices.prototype.create = ca({ * Perform a [indices.delete](http://www.elastic.co/guide/en/elasticsearch/reference/1.3/indices-delete-index.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String, String[], Boolean} params.index - A comma-separated list of indices to delete; use `_all` or `*` string to delete all indices */ api.indices.prototype['delete'] = ca({ @@ -2147,8 +2147,8 @@ api.indices.prototype['delete'] = ca({ * Perform a [indices.deleteAlias](http://www.elastic.co/guide/en/elasticsearch/reference/1.3/indices-aliases.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit timestamp for the document - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit timestamp for the document + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String, String[], Boolean} params.index - A comma-separated list of index names (supports wildcards); use `_all` for all indices * @param {String, String[], Boolean} params.name - A comma-separated list of aliases to delete (supports wildcards); use `_all` to delete all aliases for the specified indices. */ @@ -2180,7 +2180,7 @@ api.indices.prototype.deleteAlias = ca({ * Perform a [indices.deleteMapping](http://www.elastic.co/guide/en/elasticsearch/reference/1.3/indices-delete-mapping.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String, String[], Boolean} params.index - A comma-separated list of index names (supports wildcards); use `_all` for all indices * @param {String, String[], Boolean} params.type - A comma-separated list of document types to delete (supports wildcards); use `_all` to delete all document types in the specified indices. */ @@ -2209,8 +2209,8 @@ api.indices.prototype.deleteMapping = ca({ * Perform a [indices.deleteTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/1.3/indices-templates.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String} params.name - The name of the template */ api.indices.prototype.deleteTemplate = ca({ @@ -2238,7 +2238,7 @@ api.indices.prototype.deleteTemplate = ca({ * Perform a [indices.deleteWarmer](http://www.elastic.co/guide/en/elasticsearch/reference/1.3/indices-warmers.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String, String[], Boolean} params.name - A comma-separated list of warmer names to delete (supports wildcards); use `_all` to delete all warmers in the specified indices. You must specify a name either in the uri or in the parameters. * @param {String, String[], Boolean} params.index - A comma-separated list of index names to delete warmers from (supports wildcards); use `_all` to perform the operation on all indices. */ @@ -2576,7 +2576,7 @@ api.indices.prototype.getAlias = ca({ * Perform a [indices.getAliases](http://www.elastic.co/guide/en/elasticsearch/reference/1.3/indices-aliases.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false) * @param {String, String[], Boolean} params.index - A comma-separated list of index names to filter aliases * @param {String, String[], Boolean} params.name - A comma-separated list of alias names to filter @@ -2976,8 +2976,8 @@ api.indices.prototype.getWarmer = ca({ * Perform a [indices.open](http://www.elastic.co/guide/en/elasticsearch/reference/1.3/indices-open-close.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) * @param {String} [params.expandWildcards=closed] - Whether to expand wildcard expression to concrete indices that are open, closed or both. @@ -3097,8 +3097,8 @@ api.indices.prototype.optimize = ca({ * Perform a [indices.putAlias](http://www.elastic.co/guide/en/elasticsearch/reference/1.3/indices-aliases.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit timestamp for the document - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit timestamp for the document + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String, String[], Boolean} params.index - A comma-separated list of index names the alias should point to (supports wildcards); use `_all` or omit to perform the operation on all indices. * @param {String} params.name - The name of the alias to be created or updated */ @@ -3141,8 +3141,8 @@ api.indices.prototype.putAlias = ca({ * * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.ignoreConflicts - Specify whether to ignore conflicts while updating the mapping (default: false) - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) * @param {String} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both. @@ -3209,7 +3209,7 @@ api.indices.prototype.putMapping = ca({ * Perform a [indices.putSettings](http://www.elastic.co/guide/en/elasticsearch/reference/1.3/indices-update-settings.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) * @param {String} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both. @@ -3267,8 +3267,8 @@ api.indices.prototype.putSettings = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {Number} params.order - The order for this template when merging multiple matching ones (higher numbers are merged later, overriding the lower numbers) * @param {Boolean} params.create - Whether the index template should only be added if new or can also replace an existing one - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) * @param {String} params.name - The name of the template */ @@ -3309,7 +3309,7 @@ api.indices.prototype.putTemplate = ca({ * Perform a [indices.putWarmer](http://www.elastic.co/guide/en/elasticsearch/reference/1.3/indices-warmers.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) in the search request to warm * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices in the search request to warm. (This includes `_all` string or when no indices have been specified) * @param {String} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both, in the search request to warm. @@ -3711,8 +3711,8 @@ api.indices.prototype.status = ca({ * Perform a [indices.updateAliases](http://www.elastic.co/guide/en/elasticsearch/reference/1.3/indices-aliases.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Request timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Request timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master */ api.indices.prototype.updateAliases = ca({ params: { @@ -4217,7 +4217,7 @@ api.nodes = namespace(); * Perform a [nodes.hotThreads](http://www.elastic.co/guide/en/elasticsearch/reference/1.3/cluster-nodes-hot-threads.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.interval - The interval for the second sampling of threads + * @param {DurationString} params.interval - The interval for the second sampling of threads * @param {Number} params.snapshots - Number of samples of thread stacktrace (default: 10) * @param {Number} params.threads - Specify the number of threads to provide information for (default: 3) * @param {String} params.type - The type to sample (default: cpu) @@ -4338,7 +4338,7 @@ api.nodes.prototype.info = ca({ * Perform a [nodes.shutdown](http://www.elastic.co/guide/en/elasticsearch/reference/1.3/cluster-nodes-shutdown.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.delay - Set the delay for the operation (default: 1s) + * @param {DurationString} params.delay - Set the delay for the operation (default: 1s) * @param {Boolean} params.exit - Exit the JVM as well (default: true) * @param {String, String[], Boolean} params.nodeId - A comma-separated list of node IDs or names to perform the operation on; use `_local` to perform the operation on the node you're connected to, leave empty to perform the operation on all nodes */ @@ -4781,7 +4781,7 @@ api.scroll = ca({ * @param {String} [params.suggestMode=missing] - Specify suggest mode * @param {Number} params.suggestSize - How many suggestions to return in response * @param {Text} params.suggestText - The source text for which the suggestions should be returned - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {Boolean} params.trackScores - Whether to calculate and return scores even if they are not used for sorting * @param {Boolean} params.version - Specify whether to return document version as part of a hit * @param {String, String[], Boolean} params.index - A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices @@ -5113,7 +5113,7 @@ api.snapshot = namespace(); * Perform a [snapshot.create](http://www.elastic.co/guide/en/elasticsearch/reference/1.3/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {Boolean} params.waitForCompletion - Should this request wait until the operation has completed before returning * @param {String} params.repository - A repository name * @param {String} params.snapshot - A snapshot name @@ -5148,8 +5148,8 @@ api.snapshot.prototype.create = ca({ * Perform a [snapshot.createRepository](http://www.elastic.co/guide/en/elasticsearch/reference/1.3/modules-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 {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String} params.repository - A repository name */ api.snapshot.prototype.createRepository = ca({ @@ -5178,7 +5178,7 @@ api.snapshot.prototype.createRepository = ca({ * Perform a [snapshot.delete](http://www.elastic.co/guide/en/elasticsearch/reference/1.3/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {String} params.repository - A repository name * @param {String} params.snapshot - A snapshot name */ @@ -5207,8 +5207,8 @@ api.snapshot.prototype['delete'] = ca({ * Perform a [snapshot.deleteRepository](http://www.elastic.co/guide/en/elasticsearch/reference/1.3/modules-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 {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String, String[], Boolean} params.repository - A comma-separated list of repository names */ api.snapshot.prototype.deleteRepository = ca({ @@ -5236,7 +5236,7 @@ api.snapshot.prototype.deleteRepository = ca({ * Perform a [snapshot.get](http://www.elastic.co/guide/en/elasticsearch/reference/1.3/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {String} params.repository - A repository name * @param {String, String[], Boolean} params.snapshot - A comma-separated list of snapshot names */ @@ -5264,7 +5264,7 @@ api.snapshot.prototype.get = ca({ * Perform a [snapshot.getRepository](http://www.elastic.co/guide/en/elasticsearch/reference/1.3/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false) * @param {String, String[], Boolean} params.repository - A comma-separated list of repository names */ @@ -5297,7 +5297,7 @@ api.snapshot.prototype.getRepository = ca({ * Perform a [snapshot.restore](http://www.elastic.co/guide/en/elasticsearch/reference/1.3/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {Boolean} params.waitForCompletion - Should this request wait until the operation has completed before returning * @param {String} params.repository - A repository name * @param {String} params.snapshot - A snapshot name @@ -5332,7 +5332,7 @@ api.snapshot.prototype.restore = ca({ * Perform a [snapshot.status](http://www.elastic.co/guide/en/elasticsearch/reference/1.3/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {String} params.repository - A repository name * @param {String, String[], Boolean} params.snapshot - A comma-separated list of snapshot names */ @@ -5520,8 +5520,8 @@ api.termvector = ca({ * @param {Number} params.retryOnConflict - Specify how many times should the operation be retried when a conflict occurs (default: 0) * @param {String} params.routing - Specific routing value * @param {Anything} params.script - The URL-encoded script definition (instead of using request body) - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.timestamp - Explicit timestamp for the document + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.timestamp - Explicit timestamp for the document * @param {Duration} params.ttl - Expiration time for the document * @param {Number} params.version - Explicit version number for concurrency control * @param {String} params.versionType - Specific version type @@ -5614,8 +5614,8 @@ api.update = ca({ * @param {Boolean} params.refresh - Refresh the index after performing the operation * @param {String} [params.replication=sync] - Specific replication type * @param {String} params.routing - Specific routing value - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.timestamp - Explicit timestamp for the document + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.timestamp - Explicit timestamp for the document * @param {Duration} params.ttl - Expiration time for the document * @param {Number} params.version - Explicit version number for concurrency control * @param {String} params.versionType - Specific version type diff --git a/src/lib/apis/1_4.js b/src/lib/apis/1_4.js index ed2703513..2a0cf7325 100644 --- a/src/lib/apis/1_4.js +++ b/src/lib/apis/1_4.js @@ -12,7 +12,7 @@ api._namespaces = ['cat', 'cluster', 'indices', 'nodes', 'snapshot']; * @param {Boolean} params.refresh - Refresh the index after performing the operation * @param {String} [params.replication=sync] - Explicitely set the replication type * @param {String} params.routing - Specific routing value - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String} params.type - Default document type for items which don't provide one * @param {String} params.index - Default index for items which don't provide one */ @@ -83,7 +83,7 @@ api.cat = namespace(); * * @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 {DurationString} 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 @@ -131,7 +131,7 @@ api.cat.prototype.aliases = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.bytes - The unit in which to display byte values * @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 {DurationString} 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 @@ -187,7 +187,7 @@ api.cat.prototype.allocation = ca({ * * @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 {DurationString} 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 @@ -235,7 +235,7 @@ api.cat.prototype.count = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.bytes - The unit in which to display byte values * @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 {DurationString} 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 @@ -294,7 +294,7 @@ api.cat.prototype.fielddata = ca({ * * @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 {DurationString} 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.ts=true] - Set to false to disable timestamping @@ -354,7 +354,7 @@ api.cat.prototype.help = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.bytes - The unit in which to display byte values * @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 {DurationString} 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.pri - Set to true to return stats only for primary shards @@ -415,7 +415,7 @@ api.cat.prototype.indices = ca({ * * @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 {DurationString} 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 @@ -451,7 +451,7 @@ api.cat.prototype.master = ca({ * * @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 {DurationString} 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 @@ -487,7 +487,7 @@ api.cat.prototype.nodes = ca({ * * @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 {DurationString} 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 @@ -523,7 +523,7 @@ api.cat.prototype.pendingTasks = ca({ * * @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 {DurationString} 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 @@ -559,7 +559,7 @@ api.cat.prototype.plugins = ca({ * * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.bytes - The unit in which to display byte values - * @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} 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 @@ -650,7 +650,7 @@ api.cat.prototype.segments = ca({ * * @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 {DurationString} 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 @@ -697,7 +697,7 @@ api.cat.prototype.shards = ca({ * * @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 {DurationString} 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 @@ -764,8 +764,8 @@ api.cluster = namespace(); * * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) - * @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout */ api.cluster.prototype.getSettings = ca({ params: { @@ -792,8 +792,8 @@ api.cluster.prototype.getSettings = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} [params.level=cluster] - Specify the level of detail for returned information * @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 {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout * @param {Number} params.waitForActiveShards - Wait until the specified number of shards is active * @param {String} params.waitForNodes - Wait until the specified number of nodes is available * @param {Number} params.waitForRelocatingShards - Wait until the specified number of relocating shards is finished @@ -864,7 +864,7 @@ api.cluster.prototype.health = ca({ * * @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 - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master */ api.cluster.prototype.pendingTasks = ca({ params: { @@ -907,8 +907,8 @@ api.cluster.prototype.putSettings = ca({ * @param {Boolean} params.dryRun - Simulate the operation only and return the resulting state * @param {Boolean} params.explain - Return an explanation of why the commands can or cannot be executed * @param {String, String[], Boolean} params.metric - Limit the information returned to the specified metrics. Defaults to all but metadata - * @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout */ api.cluster.prototype.reroute = ca({ params: { @@ -950,7 +950,7 @@ api.cluster.prototype.reroute = ca({ * * @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 - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) * @param {String, String[], Boolean} params.index - A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices * @param {String, String[], Boolean} params.metric - Limit the information returned to the specified metrics @@ -1232,7 +1232,7 @@ api.countPercolate = ca({ * @param {Boolean} params.refresh - Refresh the index after performing the operation * @param {String} [params.replication=sync] - Specific replication type * @param {String} params.routing - Specific routing value - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {Number} params.version - Explicit version number for concurrency control * @param {String} params.versionType - Specific version type * @param {String} params.id - The document ID @@ -1315,7 +1315,7 @@ api['delete'] = ca({ * @param {String} params.q - Query in the Lucene query string syntax * @param {String} params.routing - Specific routing value * @param {String} params.source - The URL-encoded query definition (instead of using the request body) - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String, String[], Boolean} params.index - A comma-separated list of indices to restrict the operation; use `_all` to perform the operation on all indices * @param {String, String[], Boolean} params.type - A comma-separated list of types to restrict the operation */ @@ -1866,8 +1866,8 @@ api.getTemplate = ca({ * @param {Boolean} params.refresh - Refresh the index after performing the operation * @param {String} [params.replication=sync] - Specific replication type * @param {String} params.routing - Specific routing value - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.timestamp - Explicit timestamp for the document + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.timestamp - Explicit timestamp for the document * @param {Duration} params.ttl - Expiration time for the document * @param {Number} params.version - Explicit version number for concurrency control * @param {String} params.versionType - Specific version type @@ -2137,8 +2137,8 @@ api.indices.prototype.clearCache = ca({ * Perform a [indices.close](http://www.elastic.co/guide/en/elasticsearch/reference/1.4/indices-open-close.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) * @param {String} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both. @@ -2188,8 +2188,8 @@ api.indices.prototype.close = ca({ * Perform a [indices.create](http://www.elastic.co/guide/en/elasticsearch/reference/1.4/indices-create-index.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String} params.index - The name of the index */ api.indices.prototype.create = ca({ @@ -2217,8 +2217,8 @@ api.indices.prototype.create = ca({ * Perform a [indices.delete](http://www.elastic.co/guide/en/elasticsearch/reference/1.4/indices-delete-index.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String, String[], Boolean} params.index - A comma-separated list of indices to delete; use `_all` or `*` string to delete all indices */ api.indices.prototype['delete'] = ca({ @@ -2246,8 +2246,8 @@ api.indices.prototype['delete'] = ca({ * Perform a [indices.deleteAlias](http://www.elastic.co/guide/en/elasticsearch/reference/1.4/indices-aliases.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit timestamp for the document - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit timestamp for the document + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String, String[], Boolean} params.index - A comma-separated list of index names (supports wildcards); use `_all` for all indices * @param {String, String[], Boolean} params.name - A comma-separated list of aliases to delete (supports wildcards); use `_all` to delete all aliases for the specified indices. */ @@ -2279,7 +2279,7 @@ api.indices.prototype.deleteAlias = ca({ * Perform a [indices.deleteMapping](http://www.elastic.co/guide/en/elasticsearch/reference/1.4/indices-delete-mapping.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String, String[], Boolean} params.index - A comma-separated list of index names (supports wildcards); use `_all` for all indices * @param {String, String[], Boolean} params.type - A comma-separated list of document types to delete (supports wildcards); use `_all` to delete all document types in the specified indices. */ @@ -2308,8 +2308,8 @@ api.indices.prototype.deleteMapping = ca({ * Perform a [indices.deleteTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/1.4/indices-templates.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String} params.name - The name of the template */ api.indices.prototype.deleteTemplate = ca({ @@ -2337,7 +2337,7 @@ api.indices.prototype.deleteTemplate = ca({ * Perform a [indices.deleteWarmer](http://www.elastic.co/guide/en/elasticsearch/reference/1.4/indices-warmers.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String, String[], Boolean} params.name - A comma-separated list of warmer names to delete (supports wildcards); use `_all` to delete all warmers in the specified indices. You must specify a name either in the uri or in the parameters. * @param {String, String[], Boolean} params.index - A comma-separated list of index names to delete warmers from (supports wildcards); use `_all` to perform the operation on all indices. */ @@ -2749,7 +2749,7 @@ api.indices.prototype.getAlias = ca({ * Perform a [indices.getAliases](http://www.elastic.co/guide/en/elasticsearch/reference/1.4/indices-aliases.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false) * @param {String, String[], Boolean} params.index - A comma-separated list of index names to filter aliases * @param {String, String[], Boolean} params.name - A comma-separated list of alias names to filter @@ -3208,8 +3208,8 @@ api.indices.prototype.getWarmer = ca({ * Perform a [indices.open](http://www.elastic.co/guide/en/elasticsearch/reference/1.4/indices-open-close.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) * @param {String} [params.expandWildcards=closed] - Whether to expand wildcard expression to concrete indices that are open, closed or both. @@ -3333,8 +3333,8 @@ api.indices.prototype.optimize = ca({ * Perform a [indices.putAlias](http://www.elastic.co/guide/en/elasticsearch/reference/1.4/indices-aliases.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit timestamp for the document - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit timestamp for the document + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String, String[], Boolean} params.index - A comma-separated list of index names the alias should point to (supports wildcards); use `_all` or omit to perform the operation on all indices. * @param {String} params.name - The name of the alias to be created or updated */ @@ -3377,8 +3377,8 @@ api.indices.prototype.putAlias = ca({ * * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.ignoreConflicts - Specify whether to ignore conflicts while updating the mapping (default: false) - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) * @param {String} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both. @@ -3447,7 +3447,7 @@ api.indices.prototype.putMapping = ca({ * Perform a [indices.putSettings](http://www.elastic.co/guide/en/elasticsearch/reference/1.4/indices-update-settings.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) * @param {String} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both. @@ -3507,8 +3507,8 @@ api.indices.prototype.putSettings = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {Number} params.order - The order for this template when merging multiple matching ones (higher numbers are merged later, overriding the lower numbers) * @param {Boolean} params.create - Whether the index template should only be added if new or can also replace an existing one - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) * @param {String} params.name - The name of the template */ @@ -3549,7 +3549,7 @@ api.indices.prototype.putTemplate = ca({ * Perform a [indices.putWarmer](http://www.elastic.co/guide/en/elasticsearch/reference/1.4/indices-warmers.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) in the search request to warm * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices in the search request to warm. (This includes `_all` string or when no indices have been specified) * @param {String} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both, in the search request to warm. @@ -3961,8 +3961,8 @@ api.indices.prototype.status = ca({ * Perform a [indices.updateAliases](http://www.elastic.co/guide/en/elasticsearch/reference/1.4/indices-aliases.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Request timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Request timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master */ api.indices.prototype.updateAliases = ca({ params: { @@ -4537,7 +4537,7 @@ api.nodes = namespace(); * Perform a [nodes.hotThreads](http://www.elastic.co/guide/en/elasticsearch/reference/1.4/cluster-nodes-hot-threads.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.interval - The interval for the second sampling of threads + * @param {DurationString} params.interval - The interval for the second sampling of threads * @param {Number} params.snapshots - Number of samples of thread stacktrace (default: 10) * @param {Number} params.threads - Specify the number of threads to provide information for (default: 3) * @param {String} params.type - The type to sample (default: cpu) @@ -4658,7 +4658,7 @@ api.nodes.prototype.info = ca({ * Perform a [nodes.shutdown](http://www.elastic.co/guide/en/elasticsearch/reference/1.4/cluster-nodes-shutdown.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.delay - Set the delay for the operation (default: 1s) + * @param {DurationString} params.delay - Set the delay for the operation (default: 1s) * @param {Boolean} params.exit - Exit the JVM as well (default: true) * @param {String, String[], Boolean} params.nodeId - A comma-separated list of node IDs or names to perform the operation on; use `_local` to perform the operation on the node you're connected to, leave empty to perform the operation on all nodes */ @@ -5186,7 +5186,7 @@ api.scroll = ca({ * @param {String} [params.suggestMode=missing] - Specify suggest mode * @param {Number} params.suggestSize - How many suggestions to return in response * @param {Text} params.suggestText - The source text for which the suggestions should be returned - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {Boolean} params.trackScores - Whether to calculate and return scores even if they are not used for sorting * @param {Boolean} params.version - Specify whether to return document version as part of a hit * @param {Boolean} params.queryCache - Specify if query cache should be used for this request or not, defaults to index level setting @@ -5613,7 +5613,7 @@ api.snapshot = namespace(); * Perform a [snapshot.create](http://www.elastic.co/guide/en/elasticsearch/reference/1.4/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {Boolean} params.waitForCompletion - Should this request wait until the operation has completed before returning * @param {String} params.repository - A repository name * @param {String} params.snapshot - A snapshot name @@ -5648,8 +5648,8 @@ api.snapshot.prototype.create = ca({ * Perform a [snapshot.createRepository](http://www.elastic.co/guide/en/elasticsearch/reference/1.4/modules-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 {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout * @param {Boolean} params.verify - Whether to verify the repository after creation * @param {String} params.repository - A repository name */ @@ -5682,7 +5682,7 @@ api.snapshot.prototype.createRepository = ca({ * Perform a [snapshot.delete](http://www.elastic.co/guide/en/elasticsearch/reference/1.4/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {String} params.repository - A repository name * @param {String} params.snapshot - A snapshot name */ @@ -5711,8 +5711,8 @@ api.snapshot.prototype['delete'] = ca({ * Perform a [snapshot.deleteRepository](http://www.elastic.co/guide/en/elasticsearch/reference/1.4/modules-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 {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String, String[], Boolean} params.repository - A comma-separated list of repository names */ api.snapshot.prototype.deleteRepository = ca({ @@ -5740,7 +5740,7 @@ api.snapshot.prototype.deleteRepository = ca({ * Perform a [snapshot.get](http://www.elastic.co/guide/en/elasticsearch/reference/1.4/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {String} params.repository - A repository name * @param {String, String[], Boolean} params.snapshot - A comma-separated list of snapshot names */ @@ -5768,7 +5768,7 @@ api.snapshot.prototype.get = ca({ * Perform a [snapshot.getRepository](http://www.elastic.co/guide/en/elasticsearch/reference/1.4/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false) * @param {String, String[], Boolean} params.repository - A comma-separated list of repository names */ @@ -5801,7 +5801,7 @@ api.snapshot.prototype.getRepository = ca({ * Perform a [snapshot.restore](http://www.elastic.co/guide/en/elasticsearch/reference/1.4/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {Boolean} params.waitForCompletion - Should this request wait until the operation has completed before returning * @param {String} params.repository - A repository name * @param {String} params.snapshot - A snapshot name @@ -5836,7 +5836,7 @@ api.snapshot.prototype.restore = ca({ * Perform a [snapshot.status](http://www.elastic.co/guide/en/elasticsearch/reference/1.4/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {String} params.repository - A repository name * @param {String, String[], Boolean} params.snapshot - A comma-separated list of snapshot names */ @@ -5877,8 +5877,8 @@ api.snapshot.prototype.status = ca({ * Perform a [snapshot.verifyRepository](http://www.elastic.co/guide/en/elasticsearch/reference/1.4/modules-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 {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String} params.repository - A repository name */ api.snapshot.prototype.verifyRepository = ca({ @@ -6074,8 +6074,8 @@ api.termvector = ca({ * @param {Anything} params.script - The URL-encoded script definition (instead of using request body) * @param {Anything} params.scriptId - The id of a stored script * @param {Boolean} params.scriptedUpsert - True if the script referenced in script or script_id should be called to perform inserts - defaults to false - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.timestamp - Explicit timestamp for the document + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.timestamp - Explicit timestamp for the document * @param {Duration} params.ttl - Expiration time for the document * @param {Number} params.version - Explicit version number for concurrency control * @param {String} params.versionType - Specific version type @@ -6175,8 +6175,8 @@ api.update = ca({ * @param {Boolean} params.refresh - Refresh the index after performing the operation * @param {String} [params.replication=sync] - Specific replication type * @param {String} params.routing - Specific routing value - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.timestamp - Explicit timestamp for the document + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.timestamp - Explicit timestamp for the document * @param {Duration} params.ttl - Expiration time for the document * @param {Number} params.version - Explicit version number for concurrency control * @param {String} params.versionType - Specific version type diff --git a/src/lib/apis/1_5.js b/src/lib/apis/1_5.js index 3bcf87feb..532245aab 100644 --- a/src/lib/apis/1_5.js +++ b/src/lib/apis/1_5.js @@ -12,7 +12,7 @@ api._namespaces = ['cat', 'cluster', 'indices', 'nodes', 'snapshot']; * @param {Boolean} params.refresh - Refresh the index after performing the operation * @param {String} [params.replication=sync] - Explicitely set the replication type * @param {String} params.routing - Specific routing value - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String} params.type - Default document type for items which don't provide one * @param {String} params.index - Default index for items which don't provide one */ @@ -83,7 +83,7 @@ api.cat = namespace(); * * @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 {DurationString} 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 @@ -131,7 +131,7 @@ api.cat.prototype.aliases = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.bytes - The unit in which to display byte values * @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 {DurationString} 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 @@ -187,7 +187,7 @@ api.cat.prototype.allocation = ca({ * * @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 {DurationString} 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 @@ -235,7 +235,7 @@ api.cat.prototype.count = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.bytes - The unit in which to display byte values * @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 {DurationString} 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 @@ -294,7 +294,7 @@ api.cat.prototype.fielddata = ca({ * * @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 {DurationString} 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.ts=true] - Set to false to disable timestamping @@ -354,7 +354,7 @@ api.cat.prototype.help = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.bytes - The unit in which to display byte values * @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 {DurationString} 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.pri - Set to true to return stats only for primary shards @@ -415,7 +415,7 @@ api.cat.prototype.indices = ca({ * * @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 {DurationString} 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 @@ -451,7 +451,7 @@ api.cat.prototype.master = ca({ * * @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 {DurationString} 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 @@ -487,7 +487,7 @@ api.cat.prototype.nodes = ca({ * * @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 {DurationString} 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 @@ -523,7 +523,7 @@ api.cat.prototype.pendingTasks = ca({ * * @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 {DurationString} 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 @@ -559,7 +559,7 @@ api.cat.prototype.plugins = ca({ * * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.bytes - The unit in which to display byte values - * @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} 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 @@ -650,7 +650,7 @@ api.cat.prototype.segments = ca({ * * @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 {DurationString} 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 @@ -697,7 +697,7 @@ api.cat.prototype.shards = ca({ * * @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 {DurationString} 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 @@ -764,8 +764,8 @@ api.cluster = namespace(); * * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) - * @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout */ api.cluster.prototype.getSettings = ca({ params: { @@ -792,8 +792,8 @@ api.cluster.prototype.getSettings = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} [params.level=cluster] - Specify the level of detail for returned information * @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 {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout * @param {Number} params.waitForActiveShards - Wait until the specified number of shards is active * @param {String} params.waitForNodes - Wait until the specified number of nodes is available * @param {Number} params.waitForRelocatingShards - Wait until the specified number of relocating shards is finished @@ -864,7 +864,7 @@ api.cluster.prototype.health = ca({ * * @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 - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master */ api.cluster.prototype.pendingTasks = ca({ params: { @@ -886,8 +886,8 @@ api.cluster.prototype.pendingTasks = ca({ * * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) - * @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout */ api.cluster.prototype.putSettings = ca({ params: { @@ -916,8 +916,8 @@ api.cluster.prototype.putSettings = ca({ * @param {Boolean} params.dryRun - Simulate the operation only and return the resulting state * @param {Boolean} params.explain - Return an explanation of why the commands can or cannot be executed * @param {String, String[], Boolean} params.metric - Limit the information returned to the specified metrics. Defaults to all but metadata - * @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout */ api.cluster.prototype.reroute = ca({ params: { @@ -959,7 +959,7 @@ api.cluster.prototype.reroute = ca({ * * @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 - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) @@ -1263,7 +1263,7 @@ api.countPercolate = ca({ * @param {Boolean} params.refresh - Refresh the index after performing the operation * @param {String} [params.replication=sync] - Specific replication type * @param {String} params.routing - Specific routing value - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {Number} params.version - Explicit version number for concurrency control * @param {String} params.versionType - Specific version type * @param {String} params.id - The document ID @@ -1346,7 +1346,7 @@ api['delete'] = ca({ * @param {String} params.q - Query in the Lucene query string syntax * @param {String} params.routing - Specific routing value * @param {String} params.source - The URL-encoded query definition (instead of using the request body) - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String, String[], Boolean} params.index - A comma-separated list of indices to restrict the operation; use `_all` to perform the operation on all indices * @param {String, String[], Boolean} params.type - A comma-separated list of types to restrict the operation */ @@ -1897,8 +1897,8 @@ api.getTemplate = ca({ * @param {Boolean} params.refresh - Refresh the index after performing the operation * @param {String} [params.replication=sync] - Specific replication type * @param {String} params.routing - Specific routing value - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.timestamp - Explicit timestamp for the document + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.timestamp - Explicit timestamp for the document * @param {Duration} params.ttl - Expiration time for the document * @param {Number} params.version - Explicit version number for concurrency control * @param {String} params.versionType - Specific version type @@ -2168,8 +2168,8 @@ api.indices.prototype.clearCache = ca({ * Perform a [indices.close](http://www.elastic.co/guide/en/elasticsearch/reference/1.5/indices-open-close.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) * @param {String} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both. @@ -2219,8 +2219,8 @@ api.indices.prototype.close = ca({ * Perform a [indices.create](http://www.elastic.co/guide/en/elasticsearch/reference/1.5/indices-create-index.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String} params.index - The name of the index */ api.indices.prototype.create = ca({ @@ -2248,8 +2248,8 @@ api.indices.prototype.create = ca({ * Perform a [indices.delete](http://www.elastic.co/guide/en/elasticsearch/reference/1.5/indices-delete-index.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String, String[], Boolean} params.index - A comma-separated list of indices to delete; use `_all` or `*` string to delete all indices */ api.indices.prototype['delete'] = ca({ @@ -2277,8 +2277,8 @@ api.indices.prototype['delete'] = ca({ * Perform a [indices.deleteAlias](http://www.elastic.co/guide/en/elasticsearch/reference/1.5/indices-aliases.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit timestamp for the document - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit timestamp for the document + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String, String[], Boolean} params.index - A comma-separated list of index names (supports wildcards); use `_all` for all indices * @param {String, String[], Boolean} params.name - A comma-separated list of aliases to delete (supports wildcards); use `_all` to delete all aliases for the specified indices. */ @@ -2310,7 +2310,7 @@ api.indices.prototype.deleteAlias = ca({ * Perform a [indices.deleteMapping](http://www.elastic.co/guide/en/elasticsearch/reference/1.5/indices-delete-mapping.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String, String[], Boolean} params.index - A comma-separated list of index names (supports wildcards); use `_all` for all indices * @param {String, String[], Boolean} params.type - A comma-separated list of document types to delete (supports wildcards); use `_all` to delete all document types in the specified indices. */ @@ -2339,8 +2339,8 @@ api.indices.prototype.deleteMapping = ca({ * Perform a [indices.deleteTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/1.5/indices-templates.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String} params.name - The name of the template */ api.indices.prototype.deleteTemplate = ca({ @@ -2368,7 +2368,7 @@ api.indices.prototype.deleteTemplate = ca({ * Perform a [indices.deleteWarmer](http://www.elastic.co/guide/en/elasticsearch/reference/1.5/indices-warmers.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String, String[], Boolean} params.name - A comma-separated list of warmer names to delete (supports wildcards); use `_all` to delete all warmers in the specified indices. You must specify a name either in the uri or in the parameters. * @param {String, String[], Boolean} params.index - A comma-separated list of index names to delete warmers from (supports wildcards); use `_all` to perform the operation on all indices. */ @@ -2517,7 +2517,7 @@ api.indices.prototype.existsAlias = ca({ * Perform a [indices.existsTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/1.5/indices-templates.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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false) * @param {String} params.name - The name of the template */ @@ -2781,7 +2781,7 @@ api.indices.prototype.getAlias = ca({ * Perform a [indices.getAliases](http://www.elastic.co/guide/en/elasticsearch/reference/1.5/indices-aliases.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false) * @param {String, String[], Boolean} params.index - A comma-separated list of index names to filter aliases * @param {String, String[], Boolean} params.name - A comma-separated list of alias names to filter @@ -3072,7 +3072,7 @@ api.indices.prototype.getSettings = ca({ * * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) - * @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false) * @param {String} params.name - The name of the template */ @@ -3245,8 +3245,8 @@ api.indices.prototype.getWarmer = ca({ * Perform a [indices.open](http://www.elastic.co/guide/en/elasticsearch/reference/1.5/indices-open-close.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) * @param {String} [params.expandWildcards=closed] - Whether to expand wildcard expression to concrete indices that are open, closed or both. @@ -3370,8 +3370,8 @@ api.indices.prototype.optimize = ca({ * Perform a [indices.putAlias](http://www.elastic.co/guide/en/elasticsearch/reference/1.5/indices-aliases.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit timestamp for the document - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit timestamp for the document + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String, String[], Boolean} params.index - A comma-separated list of index names the alias should point to (supports wildcards); use `_all` to perform the operation on all indices. * @param {String} params.name - The name of the alias to be created or updated */ @@ -3404,8 +3404,8 @@ api.indices.prototype.putAlias = ca({ * * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.ignoreConflicts - Specify whether to ignore conflicts while updating the mapping (default: false) - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) * @param {String} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both. @@ -3474,7 +3474,7 @@ api.indices.prototype.putMapping = ca({ * Perform a [indices.putSettings](http://www.elastic.co/guide/en/elasticsearch/reference/1.5/indices-update-settings.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) * @param {String} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both. @@ -3534,8 +3534,8 @@ api.indices.prototype.putSettings = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {Number} params.order - The order for this template when merging multiple matching ones (higher numbers are merged later, overriding the lower numbers) * @param {Boolean} params.create - Whether the index template should only be added if new or can also replace an existing one - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) * @param {String} params.name - The name of the template */ @@ -3576,7 +3576,7 @@ api.indices.prototype.putTemplate = ca({ * Perform a [indices.putWarmer](http://www.elastic.co/guide/en/elasticsearch/reference/1.5/indices-warmers.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) in the search request to warm * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices in the search request to warm. (This includes `_all` string or when no indices have been specified) * @param {String} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both, in the search request to warm. @@ -3988,8 +3988,8 @@ api.indices.prototype.status = ca({ * Perform a [indices.updateAliases](http://www.elastic.co/guide/en/elasticsearch/reference/1.5/indices-aliases.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Request timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Request timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master */ api.indices.prototype.updateAliases = ca({ params: { @@ -4570,7 +4570,7 @@ api.nodes = namespace(); * Perform a [nodes.hotThreads](http://www.elastic.co/guide/en/elasticsearch/reference/1.5/cluster-nodes-hot-threads.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.interval - The interval for the second sampling of threads + * @param {DurationString} params.interval - The interval for the second sampling of threads * @param {Number} params.snapshots - Number of samples of thread stacktrace (default: 10) * @param {Number} params.threads - Specify the number of threads to provide information for (default: 3) * @param {Boolean} params.ignoreIdleThreads - Don't show threads that are in known-idle places, such as waiting on a socket select or pulling from an empty task queue (default: true) @@ -4696,7 +4696,7 @@ api.nodes.prototype.info = ca({ * Perform a [nodes.shutdown](http://www.elastic.co/guide/en/elasticsearch/reference/1.5/cluster-nodes-shutdown.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.delay - Set the delay for the operation (default: 1s) + * @param {DurationString} params.delay - Set the delay for the operation (default: 1s) * @param {Boolean} params.exit - Exit the JVM as well (default: true) * @param {String, String[], Boolean} params.nodeId - A comma-separated list of node IDs or names to perform the operation on; use `_local` to perform the operation on the node you're connected to, leave empty to perform the operation on all nodes */ @@ -5223,7 +5223,7 @@ api.scroll = ca({ * @param {String} [params.suggestMode=missing] - Specify suggest mode * @param {Number} params.suggestSize - How many suggestions to return in response * @param {Text} params.suggestText - The source text for which the suggestions should be returned - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {Boolean} params.trackScores - Whether to calculate and return scores even if they are not used for sorting * @param {Boolean} params.version - Specify whether to return document version as part of a hit * @param {Boolean} params.queryCache - Specify if query cache should be used for this request or not, defaults to index level setting @@ -5646,7 +5646,7 @@ api.snapshot = namespace(); * Perform a [snapshot.create](http://www.elastic.co/guide/en/elasticsearch/reference/1.5/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {Boolean} params.waitForCompletion - Should this request wait until the operation has completed before returning * @param {String} params.repository - A repository name * @param {String} params.snapshot - A snapshot name @@ -5681,8 +5681,8 @@ api.snapshot.prototype.create = ca({ * Perform a [snapshot.createRepository](http://www.elastic.co/guide/en/elasticsearch/reference/1.5/modules-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 {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout * @param {Boolean} params.verify - Whether to verify the repository after creation * @param {String} params.repository - A repository name */ @@ -5715,7 +5715,7 @@ api.snapshot.prototype.createRepository = ca({ * Perform a [snapshot.delete](http://www.elastic.co/guide/en/elasticsearch/reference/1.5/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {String} params.repository - A repository name * @param {String} params.snapshot - A snapshot name */ @@ -5744,8 +5744,8 @@ api.snapshot.prototype['delete'] = ca({ * Perform a [snapshot.deleteRepository](http://www.elastic.co/guide/en/elasticsearch/reference/1.5/modules-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 {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String, String[], Boolean} params.repository - A comma-separated list of repository names */ api.snapshot.prototype.deleteRepository = ca({ @@ -5773,7 +5773,7 @@ api.snapshot.prototype.deleteRepository = ca({ * Perform a [snapshot.get](http://www.elastic.co/guide/en/elasticsearch/reference/1.5/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {String} params.repository - A repository name * @param {String, String[], Boolean} params.snapshot - A comma-separated list of snapshot names */ @@ -5801,7 +5801,7 @@ api.snapshot.prototype.get = ca({ * Perform a [snapshot.getRepository](http://www.elastic.co/guide/en/elasticsearch/reference/1.5/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false) * @param {String, String[], Boolean} params.repository - A comma-separated list of repository names */ @@ -5834,7 +5834,7 @@ api.snapshot.prototype.getRepository = ca({ * Perform a [snapshot.restore](http://www.elastic.co/guide/en/elasticsearch/reference/1.5/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {Boolean} params.waitForCompletion - Should this request wait until the operation has completed before returning * @param {String} params.repository - A repository name * @param {String} params.snapshot - A snapshot name @@ -5869,7 +5869,7 @@ api.snapshot.prototype.restore = ca({ * Perform a [snapshot.status](http://www.elastic.co/guide/en/elasticsearch/reference/1.5/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {String} params.repository - A repository name * @param {String, String[], Boolean} params.snapshot - A comma-separated list of snapshot names */ @@ -5910,8 +5910,8 @@ api.snapshot.prototype.status = ca({ * Perform a [snapshot.verifyRepository](http://www.elastic.co/guide/en/elasticsearch/reference/1.5/modules-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 {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String} params.repository - A repository name */ api.snapshot.prototype.verifyRepository = ca({ @@ -6112,8 +6112,8 @@ api.termvector = ca({ * @param {Anything} params.script - The URL-encoded script definition (instead of using request body) * @param {Anything} params.scriptId - The id of a stored script * @param {Boolean} params.scriptedUpsert - True if the script referenced in script or script_id should be called to perform inserts - defaults to false - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.timestamp - Explicit timestamp for the document + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.timestamp - Explicit timestamp for the document * @param {Duration} params.ttl - Expiration time for the document * @param {Number} params.version - Explicit version number for concurrency control * @param {String} params.versionType - Specific version type @@ -6213,8 +6213,8 @@ api.update = ca({ * @param {Boolean} params.refresh - Refresh the index after performing the operation * @param {String} [params.replication=sync] - Specific replication type * @param {String} params.routing - Specific routing value - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.timestamp - Explicit timestamp for the document + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.timestamp - Explicit timestamp for the document * @param {Duration} params.ttl - Expiration time for the document * @param {Number} params.version - Explicit version number for concurrency control * @param {String} params.versionType - Specific version type diff --git a/src/lib/apis/1_6.js b/src/lib/apis/1_6.js index d38f83267..1c4c3a58e 100644 --- a/src/lib/apis/1_6.js +++ b/src/lib/apis/1_6.js @@ -21,7 +21,7 @@ api._namespaces = ['cat', 'cluster', 'indices', 'nodes', 'snapshot']; * @param {Boolean} params.refresh - Refresh the index after performing the operation * @param {String} [params.replication=sync] - Explicitely set the replication type * @param {String} params.routing - Specific routing value - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String} params.type - Default document type for items which don't provide one * @param {String} params.index - Default index for items which don't provide one */ @@ -92,7 +92,7 @@ api.cat = namespace(); * * @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 {DurationString} 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 @@ -140,7 +140,7 @@ api.cat.prototype.aliases = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.bytes - The unit in which to display byte values * @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 {DurationString} 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 @@ -196,7 +196,7 @@ api.cat.prototype.allocation = ca({ * * @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 {DurationString} 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 @@ -244,7 +244,7 @@ api.cat.prototype.count = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.bytes - The unit in which to display byte values * @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 {DurationString} 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 @@ -303,7 +303,7 @@ api.cat.prototype.fielddata = ca({ * * @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 {DurationString} 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.ts=true] - Set to false to disable timestamping @@ -363,7 +363,7 @@ api.cat.prototype.help = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.bytes - The unit in which to display byte values * @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 {DurationString} 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.pri - Set to true to return stats only for primary shards @@ -424,7 +424,7 @@ api.cat.prototype.indices = ca({ * * @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 {DurationString} 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 @@ -460,7 +460,7 @@ api.cat.prototype.master = ca({ * * @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 {DurationString} 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 @@ -496,7 +496,7 @@ api.cat.prototype.nodes = ca({ * * @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 {DurationString} 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 @@ -532,7 +532,7 @@ api.cat.prototype.pendingTasks = ca({ * * @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 {DurationString} 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 @@ -568,7 +568,7 @@ api.cat.prototype.plugins = ca({ * * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.bytes - The unit in which to display byte values - * @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} 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 @@ -659,7 +659,7 @@ api.cat.prototype.segments = ca({ * * @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 {DurationString} 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 @@ -706,7 +706,7 @@ api.cat.prototype.shards = ca({ * * @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 {DurationString} 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 @@ -773,8 +773,8 @@ api.cluster = namespace(); * * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) - * @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout */ api.cluster.prototype.getSettings = ca({ params: { @@ -801,8 +801,8 @@ api.cluster.prototype.getSettings = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} [params.level=cluster] - Specify the level of detail for returned information * @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 {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout * @param {Number} params.waitForActiveShards - Wait until the specified number of shards is active * @param {String} params.waitForNodes - Wait until the specified number of nodes is available * @param {Number} params.waitForRelocatingShards - Wait until the specified number of relocating shards is finished @@ -873,7 +873,7 @@ api.cluster.prototype.health = ca({ * * @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 - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master */ api.cluster.prototype.pendingTasks = ca({ params: { @@ -895,8 +895,8 @@ api.cluster.prototype.pendingTasks = ca({ * * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) - * @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout */ api.cluster.prototype.putSettings = ca({ params: { @@ -925,8 +925,8 @@ api.cluster.prototype.putSettings = ca({ * @param {Boolean} params.dryRun - Simulate the operation only and return the resulting state * @param {Boolean} params.explain - Return an explanation of why the commands can or cannot be executed * @param {String, String[], Boolean} params.metric - Limit the information returned to the specified metrics. Defaults to all but metadata - * @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout */ api.cluster.prototype.reroute = ca({ params: { @@ -968,7 +968,7 @@ api.cluster.prototype.reroute = ca({ * * @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 - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) @@ -1302,7 +1302,7 @@ api.countPercolate = ca({ * @param {Boolean} params.refresh - Refresh the index after performing the operation * @param {String} [params.replication=sync] - Specific replication type * @param {String} params.routing - Specific routing value - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {Number} params.version - Explicit version number for concurrency control * @param {String} params.versionType - Specific version type * @param {String} params.id - The document ID @@ -1384,7 +1384,7 @@ api['delete'] = ca({ * @param {String} [params.replication=sync] - Specific replication type * @param {String} params.q - Query in the Lucene query string syntax * @param {String} params.routing - Specific routing value - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String, String[], Boolean} params.index - A comma-separated list of indices to restrict the operation; use `_all` to perform the operation on all indices * @param {String, String[], Boolean} params.type - A comma-separated list of types to restrict the operation */ @@ -1988,8 +1988,8 @@ api.getTemplate = ca({ * @param {Boolean} params.refresh - Refresh the index after performing the operation * @param {String} [params.replication=sync] - Specific replication type * @param {String} params.routing - Specific routing value - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.timestamp - Explicit timestamp for the document + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.timestamp - Explicit timestamp for the document * @param {Duration} params.ttl - Expiration time for the document * @param {Number} params.version - Explicit version number for concurrency control * @param {String} params.versionType - Specific version type @@ -2255,8 +2255,8 @@ api.indices.prototype.clearCache = ca({ * Perform a [indices.close](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-open-close.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) * @param {String} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both. @@ -2306,8 +2306,8 @@ api.indices.prototype.close = ca({ * Perform a [indices.create](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-create-index.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String} params.index - The name of the index */ api.indices.prototype.create = ca({ @@ -2335,8 +2335,8 @@ api.indices.prototype.create = ca({ * Perform a [indices.delete](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-delete-index.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String, String[], Boolean} params.index - A comma-separated list of indices to delete; use `_all` or `*` string to delete all indices */ api.indices.prototype['delete'] = ca({ @@ -2364,8 +2364,8 @@ api.indices.prototype['delete'] = ca({ * Perform a [indices.deleteAlias](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-aliases.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit timestamp for the document - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit timestamp for the document + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String, String[], Boolean} params.index - A comma-separated list of index names (supports wildcards); use `_all` for all indices * @param {String, String[], Boolean} params.name - A comma-separated list of aliases to delete (supports wildcards); use `_all` to delete all aliases for the specified indices. */ @@ -2397,7 +2397,7 @@ api.indices.prototype.deleteAlias = ca({ * Perform a [indices.deleteMapping](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-delete-mapping.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String, String[], Boolean} params.index - A comma-separated list of index names (supports wildcards); use `_all` for all indices * @param {String, String[], Boolean} params.type - A comma-separated list of document types to delete (supports wildcards); use `_all` to delete all document types in the specified indices. */ @@ -2426,8 +2426,8 @@ api.indices.prototype.deleteMapping = ca({ * Perform a [indices.deleteTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-templates.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String} params.name - The name of the template */ api.indices.prototype.deleteTemplate = ca({ @@ -2455,7 +2455,7 @@ api.indices.prototype.deleteTemplate = ca({ * Perform a [indices.deleteWarmer](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-warmers.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String, String[], Boolean} params.name - A comma-separated list of warmer names to delete (supports wildcards); use `_all` to delete all warmers in the specified indices. You must specify a name either in the uri or in the parameters. * @param {String, String[], Boolean} params.index - A comma-separated list of index names to delete warmers from (supports wildcards); use `_all` to perform the operation on all indices. */ @@ -2604,7 +2604,7 @@ api.indices.prototype.existsAlias = ca({ * Perform a [indices.existsTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-templates.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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false) * @param {String} params.name - The name of the template */ @@ -2894,7 +2894,7 @@ api.indices.prototype.getAlias = ca({ * Perform a [indices.getAliases](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-aliases.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false) * @param {String, String[], Boolean} params.index - A comma-separated list of index names to filter aliases * @param {String, String[], Boolean} params.name - A comma-separated list of alias names to filter @@ -3185,7 +3185,7 @@ api.indices.prototype.getSettings = ca({ * * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) - * @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false) * @param {String} params.name - The name of the template */ @@ -3358,8 +3358,8 @@ api.indices.prototype.getWarmer = ca({ * Perform a [indices.open](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-open-close.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) * @param {String} [params.expandWildcards=closed] - Whether to expand wildcard expression to concrete indices that are open, closed or both. @@ -3483,8 +3483,8 @@ api.indices.prototype.optimize = ca({ * Perform a [indices.putAlias](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-aliases.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit timestamp for the document - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit timestamp for the document + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String, String[], Boolean} params.index - A comma-separated list of index names the alias should point to (supports wildcards); use `_all` to perform the operation on all indices. * @param {String} params.name - The name of the alias to be created or updated */ @@ -3517,8 +3517,8 @@ api.indices.prototype.putAlias = ca({ * * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.ignoreConflicts - Specify whether to ignore conflicts while updating the mapping (default: false) - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) * @param {String} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both. @@ -3587,7 +3587,7 @@ api.indices.prototype.putMapping = ca({ * Perform a [indices.putSettings](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-update-settings.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) * @param {String} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both. @@ -3647,8 +3647,8 @@ api.indices.prototype.putSettings = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {Number} params.order - The order for this template when merging multiple matching ones (higher numbers are merged later, overriding the lower numbers) * @param {Boolean} params.create - Whether the index template should only be added if new or can also replace an existing one - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) * @param {String} params.name - The name of the template */ @@ -3689,7 +3689,7 @@ api.indices.prototype.putTemplate = ca({ * Perform a [indices.putWarmer](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-warmers.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) in the search request to warm * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices in the search request to warm. (This includes `_all` string or when no indices have been specified) * @param {String} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both, in the search request to warm. @@ -4101,8 +4101,8 @@ api.indices.prototype.status = ca({ * Perform a [indices.updateAliases](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-aliases.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Request timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Request timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master */ api.indices.prototype.updateAliases = ca({ params: { @@ -4700,7 +4700,7 @@ api.nodes = namespace(); * Perform a [nodes.hotThreads](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/cluster-nodes-hot-threads.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.interval - The interval for the second sampling of threads + * @param {DurationString} params.interval - The interval for the second sampling of threads * @param {Number} params.snapshots - Number of samples of thread stacktrace (default: 10) * @param {Number} params.threads - Specify the number of threads to provide information for (default: 3) * @param {Boolean} params.ignoreIdleThreads - Don't show threads that are in known-idle places, such as waiting on a socket select or pulling from an empty task queue (default: true) @@ -4826,7 +4826,7 @@ api.nodes.prototype.info = ca({ * Perform a [nodes.shutdown](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/cluster-nodes-shutdown.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.delay - Set the delay for the operation (default: 1s) + * @param {DurationString} params.delay - Set the delay for the operation (default: 1s) * @param {Boolean} params.exit - Exit the JVM as well (default: true) * @param {String, String[], Boolean} params.nodeId - A comma-separated list of node IDs or names to perform the operation on; use `_local` to perform the operation on the node you're connected to, leave empty to perform the operation on all nodes */ @@ -5343,7 +5343,7 @@ api.scroll = ca({ * @param {String} [params.suggestMode=missing] - Specify suggest mode * @param {Number} params.suggestSize - How many suggestions to return in response * @param {Text} params.suggestText - The source text for which the suggestions should be returned - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {Boolean} params.trackScores - Whether to calculate and return scores even if they are not used for sorting * @param {Boolean} params.version - Specify whether to return document version as part of a hit * @param {Boolean} params.queryCache - Specify if query cache should be used for this request or not, defaults to index level setting @@ -5787,7 +5787,7 @@ api.snapshot = namespace(); * Perform a [snapshot.create](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {Boolean} params.waitForCompletion - Should this request wait until the operation has completed before returning * @param {String} params.repository - A repository name * @param {String} params.snapshot - A snapshot name @@ -5822,8 +5822,8 @@ api.snapshot.prototype.create = ca({ * Perform a [snapshot.createRepository](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/modules-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 {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout * @param {Boolean} params.verify - Whether to verify the repository after creation * @param {String} params.repository - A repository name */ @@ -5856,7 +5856,7 @@ api.snapshot.prototype.createRepository = ca({ * Perform a [snapshot.delete](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {String} params.repository - A repository name * @param {String} params.snapshot - A snapshot name */ @@ -5885,8 +5885,8 @@ api.snapshot.prototype['delete'] = ca({ * Perform a [snapshot.deleteRepository](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/modules-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 {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String, String[], Boolean} params.repository - A comma-separated list of repository names */ api.snapshot.prototype.deleteRepository = ca({ @@ -5914,7 +5914,7 @@ api.snapshot.prototype.deleteRepository = ca({ * Perform a [snapshot.get](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {String} params.repository - A repository name * @param {String, String[], Boolean} params.snapshot - A comma-separated list of snapshot names */ @@ -5942,7 +5942,7 @@ api.snapshot.prototype.get = ca({ * Perform a [snapshot.getRepository](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false) * @param {String, String[], Boolean} params.repository - A comma-separated list of repository names */ @@ -5975,7 +5975,7 @@ api.snapshot.prototype.getRepository = ca({ * Perform a [snapshot.restore](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {Boolean} params.waitForCompletion - Should this request wait until the operation has completed before returning * @param {String} params.repository - A repository name * @param {String} params.snapshot - A snapshot name @@ -6010,7 +6010,7 @@ api.snapshot.prototype.restore = ca({ * Perform a [snapshot.status](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {String} params.repository - A repository name * @param {String, String[], Boolean} params.snapshot - A comma-separated list of snapshot names */ @@ -6051,8 +6051,8 @@ api.snapshot.prototype.status = ca({ * Perform a [snapshot.verifyRepository](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/modules-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 {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String} params.repository - A repository name */ api.snapshot.prototype.verifyRepository = ca({ @@ -6245,8 +6245,8 @@ api.termvector = ca({ * @param {Anything} params.script - The URL-encoded script definition (instead of using request body) * @param {Anything} params.scriptId - The id of a stored script * @param {Boolean} params.scriptedUpsert - True if the script referenced in script or script_id should be called to perform inserts - defaults to false - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.timestamp - Explicit timestamp for the document + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.timestamp - Explicit timestamp for the document * @param {Duration} params.ttl - Expiration time for the document * @param {Number} params.version - Explicit version number for concurrency control * @param {String} params.versionType - Specific version type @@ -6346,8 +6346,8 @@ api.update = ca({ * @param {Boolean} params.refresh - Refresh the index after performing the operation * @param {String} [params.replication=sync] - Specific replication type * @param {String} params.routing - Specific routing value - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.timestamp - Explicit timestamp for the document + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.timestamp - Explicit timestamp for the document * @param {Duration} params.ttl - Expiration time for the document * @param {Number} params.version - Explicit version number for concurrency control * @param {String} params.versionType - Specific version type diff --git a/src/lib/apis/1_7.js b/src/lib/apis/1_7.js index 845e0071b..289f0c832 100644 --- a/src/lib/apis/1_7.js +++ b/src/lib/apis/1_7.js @@ -21,7 +21,7 @@ api._namespaces = ['cat', 'cluster', 'indices', 'nodes', 'snapshot']; * @param {Boolean} params.refresh - Refresh the index after performing the operation * @param {String} [params.replication=sync] - Explicitely set the replication type * @param {String} params.routing - Specific routing value - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String} params.type - Default document type for items which don't provide one * @param {String} params.index - Default index for items which don't provide one */ @@ -92,7 +92,7 @@ api.cat = namespace(); * * @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 {DurationString} 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 @@ -140,7 +140,7 @@ api.cat.prototype.aliases = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.bytes - The unit in which to display byte values * @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 {DurationString} 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 @@ -196,7 +196,7 @@ api.cat.prototype.allocation = ca({ * * @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 {DurationString} 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 @@ -244,7 +244,7 @@ api.cat.prototype.count = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.bytes - The unit in which to display byte values * @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 {DurationString} 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 @@ -303,7 +303,7 @@ api.cat.prototype.fielddata = ca({ * * @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 {DurationString} 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.ts=true] - Set to false to disable timestamping @@ -363,7 +363,7 @@ api.cat.prototype.help = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.bytes - The unit in which to display byte values * @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 {DurationString} 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.pri - Set to true to return stats only for primary shards @@ -424,7 +424,7 @@ api.cat.prototype.indices = ca({ * * @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 {DurationString} 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 @@ -460,7 +460,7 @@ api.cat.prototype.master = ca({ * * @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 {DurationString} 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 @@ -496,7 +496,7 @@ api.cat.prototype.nodes = ca({ * * @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 {DurationString} 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 @@ -532,7 +532,7 @@ api.cat.prototype.pendingTasks = ca({ * * @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 {DurationString} 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 @@ -568,7 +568,7 @@ api.cat.prototype.plugins = ca({ * * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.bytes - The unit in which to display byte values - * @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} 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 @@ -659,7 +659,7 @@ api.cat.prototype.segments = ca({ * * @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 {DurationString} 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 @@ -706,7 +706,7 @@ api.cat.prototype.shards = ca({ * * @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 {DurationString} 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 @@ -773,8 +773,8 @@ api.cluster = namespace(); * * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) - * @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout */ api.cluster.prototype.getSettings = ca({ params: { @@ -801,8 +801,8 @@ api.cluster.prototype.getSettings = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} [params.level=cluster] - Specify the level of detail for returned information * @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 {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout * @param {Number} params.waitForActiveShards - Wait until the specified number of shards is active * @param {String} params.waitForNodes - Wait until the specified number of nodes is available * @param {Number} params.waitForRelocatingShards - Wait until the specified number of relocating shards is finished @@ -873,7 +873,7 @@ api.cluster.prototype.health = ca({ * * @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 - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master */ api.cluster.prototype.pendingTasks = ca({ params: { @@ -895,8 +895,8 @@ api.cluster.prototype.pendingTasks = ca({ * * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) - * @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout */ api.cluster.prototype.putSettings = ca({ params: { @@ -925,8 +925,8 @@ api.cluster.prototype.putSettings = ca({ * @param {Boolean} params.dryRun - Simulate the operation only and return the resulting state * @param {Boolean} params.explain - Return an explanation of why the commands can or cannot be executed * @param {String, String[], Boolean} params.metric - Limit the information returned to the specified metrics. Defaults to all but metadata - * @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout */ api.cluster.prototype.reroute = ca({ params: { @@ -968,7 +968,7 @@ api.cluster.prototype.reroute = ca({ * * @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 - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) @@ -1061,7 +1061,7 @@ api.cluster.prototype.state = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) * @param {Boolean} params.human - Whether to return time and byte values in human-readable format. - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String, String[], Boolean} params.nodeId - A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes */ api.cluster.prototype.stats = ca({ @@ -1306,7 +1306,7 @@ api.countPercolate = ca({ * @param {Boolean} params.refresh - Refresh the index after performing the operation * @param {String} [params.replication=sync] - Specific replication type * @param {String} params.routing - Specific routing value - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {Number} params.version - Explicit version number for concurrency control * @param {String} params.versionType - Specific version type * @param {String} params.id - The document ID @@ -1388,7 +1388,7 @@ api['delete'] = ca({ * @param {String} [params.replication=sync] - Specific replication type * @param {String} params.q - Query in the Lucene query string syntax * @param {String} params.routing - Specific routing value - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String, String[], Boolean} params.index - A comma-separated list of indices to restrict the operation; use `_all` to perform the operation on all indices * @param {String, String[], Boolean} params.type - A comma-separated list of types to restrict the operation */ @@ -1992,9 +1992,9 @@ api.getTemplate = ca({ * @param {Boolean} params.refresh - Refresh the index after performing the operation * @param {String} [params.replication=sync] - Specific replication type * @param {String} params.routing - Specific routing value - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.timestamp - Explicit timestamp for the document - * @param {Date, Number} params.ttl - Expiration time for the document + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.timestamp - Explicit timestamp for the document + * @param {DurationString} params.ttl - Expiration time for the document * @param {Number} params.version - Explicit version number for concurrency control * @param {String} params.versionType - Specific version type * @param {String} params.id - Document ID @@ -2259,8 +2259,8 @@ api.indices.prototype.clearCache = ca({ * Perform a [indices.close](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-open-close.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) * @param {String} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both. @@ -2310,8 +2310,8 @@ api.indices.prototype.close = ca({ * Perform a [indices.create](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-create-index.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String} params.index - The name of the index */ api.indices.prototype.create = ca({ @@ -2339,8 +2339,8 @@ api.indices.prototype.create = ca({ * Perform a [indices.delete](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-delete-index.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String, String[], Boolean} params.index - A comma-separated list of indices to delete; use `_all` or `*` string to delete all indices */ api.indices.prototype['delete'] = ca({ @@ -2368,8 +2368,8 @@ api.indices.prototype['delete'] = ca({ * Perform a [indices.deleteAlias](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-aliases.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit timestamp for the document - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit timestamp for the document + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String, String[], Boolean} params.index - A comma-separated list of index names (supports wildcards); use `_all` for all indices * @param {String, String[], Boolean} params.name - A comma-separated list of aliases to delete (supports wildcards); use `_all` to delete all aliases for the specified indices. */ @@ -2401,7 +2401,7 @@ api.indices.prototype.deleteAlias = ca({ * Perform a [indices.deleteMapping](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-delete-mapping.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String, String[], Boolean} params.index - A comma-separated list of index names (supports wildcards); use `_all` for all indices * @param {String, String[], Boolean} params.type - A comma-separated list of document types to delete (supports wildcards); use `_all` to delete all document types in the specified indices. */ @@ -2430,8 +2430,8 @@ api.indices.prototype.deleteMapping = ca({ * Perform a [indices.deleteTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-templates.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String} params.name - The name of the template */ api.indices.prototype.deleteTemplate = ca({ @@ -2459,7 +2459,7 @@ api.indices.prototype.deleteTemplate = ca({ * Perform a [indices.deleteWarmer](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-warmers.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String, String[], Boolean} params.name - A comma-separated list of warmer names to delete (supports wildcards); use `_all` to delete all warmers in the specified indices. You must specify a name either in the uri or in the parameters. * @param {String, String[], Boolean} params.index - A comma-separated list of index names to delete warmers from (supports wildcards); use `_all` to perform the operation on all indices. */ @@ -2608,7 +2608,7 @@ api.indices.prototype.existsAlias = ca({ * Perform a [indices.existsTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-templates.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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false) * @param {String} params.name - The name of the template */ @@ -2898,7 +2898,7 @@ api.indices.prototype.getAlias = ca({ * Perform a [indices.getAliases](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-aliases.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false) * @param {String, String[], Boolean} params.index - A comma-separated list of index names to filter aliases * @param {String, String[], Boolean} params.name - A comma-separated list of alias names to filter @@ -3189,7 +3189,7 @@ api.indices.prototype.getSettings = ca({ * * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) - * @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false) * @param {String} params.name - The name of the template */ @@ -3362,8 +3362,8 @@ api.indices.prototype.getWarmer = ca({ * Perform a [indices.open](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-open-close.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) * @param {String} [params.expandWildcards=closed] - Whether to expand wildcard expression to concrete indices that are open, closed or both. @@ -3487,8 +3487,8 @@ api.indices.prototype.optimize = ca({ * Perform a [indices.putAlias](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-aliases.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit timestamp for the document - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit timestamp for the document + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String, String[], Boolean} params.index - A comma-separated list of index names the alias should point to (supports wildcards); use `_all` to perform the operation on all indices. * @param {String} params.name - The name of the alias to be created or updated */ @@ -3521,8 +3521,8 @@ api.indices.prototype.putAlias = ca({ * * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.ignoreConflicts - Specify whether to ignore conflicts while updating the mapping (default: false) - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) * @param {String} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both. @@ -3591,7 +3591,7 @@ api.indices.prototype.putMapping = ca({ * Perform a [indices.putSettings](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-update-settings.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) * @param {String} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both. @@ -3651,8 +3651,8 @@ api.indices.prototype.putSettings = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {Number} params.order - The order for this template when merging multiple matching ones (higher numbers are merged later, overriding the lower numbers) * @param {Boolean} params.create - Whether the index template should only be added if new or can also replace an existing one - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) * @param {String} params.name - The name of the template */ @@ -3693,7 +3693,7 @@ api.indices.prototype.putTemplate = ca({ * Perform a [indices.putWarmer](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-warmers.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) in the search request to warm * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices in the search request to warm. (This includes `_all` string or when no indices have been specified) * @param {String} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both, in the search request to warm. @@ -4105,8 +4105,8 @@ api.indices.prototype.status = ca({ * Perform a [indices.updateAliases](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-aliases.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Request timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Request timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master */ api.indices.prototype.updateAliases = ca({ params: { @@ -4703,12 +4703,12 @@ api.nodes = namespace(); * Perform a [nodes.hotThreads](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/cluster-nodes-hot-threads.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.interval - The interval for the second sampling of threads + * @param {DurationString} params.interval - The interval for the second sampling of threads * @param {Number} params.snapshots - Number of samples of thread stacktrace (default: 10) * @param {Number} params.threads - Specify the number of threads to provide information for (default: 3) * @param {Boolean} params.ignoreIdleThreads - Don't show threads that are in known-idle places, such as waiting on a socket select or pulling from an empty task queue (default: true) * @param {String} params.type - The type to sample (default: cpu) - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String, String[], Boolean} params.nodeId - A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes */ api.nodes.prototype.hotThreads = ca({ @@ -4759,7 +4759,7 @@ api.nodes.prototype.hotThreads = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) * @param {Boolean} params.human - Whether to return time and byte values in human-readable format. - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String, String[], Boolean} params.nodeId - A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes * @param {String, String[], Boolean} params.metric - A comma-separated list of metrics you wish returned. Leave empty to return all. */ @@ -4837,7 +4837,7 @@ api.nodes.prototype.info = ca({ * Perform a [nodes.shutdown](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/cluster-nodes-shutdown.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.delay - Set the delay for the operation (default: 1s) + * @param {DurationString} params.delay - Set the delay for the operation (default: 1s) * @param {Boolean} params.exit - Exit the JVM as well (default: true) * @param {String, String[], Boolean} params.nodeId - A comma-separated list of node IDs or names to perform the operation on; use `_local` to perform the operation on the node you're connected to, leave empty to perform the operation on all nodes */ @@ -4877,7 +4877,7 @@ api.nodes.prototype.shutdown = ca({ * @param {Boolean} params.human - Whether to return time and byte values in human-readable format. * @param {String} [params.level=node] - Return indices stats aggregated at node, index or shard level * @param {String, String[], Boolean} params.types - A comma-separated list of document types for the `indexing` index metric - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String, String[], Boolean} params.metric - Limit the information returned to the specified metrics * @param {String, String[], Boolean} params.indexMetric - Limit the information returned for `indices` metric to the specific index metrics. Isn't used if `indices` (or `all`) metric isn't specified. * @param {String, String[], Boolean} params.nodeId - A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes @@ -5296,7 +5296,7 @@ api.putTemplate = ca({ * Perform a [scroll](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/search-request-scroll.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.scroll - Specify how long a consistent view of the index should be maintained for scrolled search + * @param {DurationString} params.scroll - Specify how long a consistent view of the index should be maintained for scrolled search * @param {String} params.scrollId - The scroll ID */ api.scroll = ca({ @@ -5346,7 +5346,7 @@ api.scroll = ca({ * @param {String} params.preference - Specify the node or shard the operation should be performed on (default: random) * @param {String} params.q - Query in the Lucene query string syntax * @param {String, String[], Boolean} params.routing - A comma-separated list of specific routing values - * @param {Date, Number} params.scroll - Specify how long a consistent view of the index should be maintained for scrolled search + * @param {DurationString} params.scroll - Specify how long a consistent view of the index should be maintained for scrolled search * @param {String} params.searchType - Search operation type * @param {Number} params.size - Number of hits to return (default: 10) * @param {String, String[], Boolean} params.sort - A comma-separated list of : pairs @@ -5358,7 +5358,7 @@ api.scroll = ca({ * @param {String} [params.suggestMode=missing] - Specify suggest mode * @param {Number} params.suggestSize - How many suggestions to return in response * @param {String} params.suggestText - The source text for which the suggestions should be returned - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {Boolean} params.trackScores - Whether to calculate and return scores even if they are not used for sorting * @param {Boolean} params.version - Specify whether to return document version as part of a hit * @param {Boolean} params.queryCache - Specify if query cache should be used for this request or not, defaults to index level setting @@ -5721,7 +5721,7 @@ api.searchShards = ca({ * @param {String} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both. * @param {String} params.preference - Specify the node or shard the operation should be performed on (default: random) * @param {String, String[], Boolean} params.routing - A comma-separated list of specific routing values - * @param {Date, Number} params.scroll - Specify how long a consistent view of the index should be maintained for scrolled search + * @param {DurationString} params.scroll - Specify how long a consistent view of the index should be maintained for scrolled search * @param {String} params.searchType - Search operation type * @param {String, String[], Boolean} params.index - A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices * @param {String, String[], Boolean} params.type - A comma-separated list of document types to search; leave empty to perform the operation on all types @@ -5802,7 +5802,7 @@ api.snapshot = namespace(); * Perform a [snapshot.create](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {Boolean} params.waitForCompletion - Should this request wait until the operation has completed before returning * @param {String} params.repository - A repository name * @param {String} params.snapshot - A snapshot name @@ -5837,8 +5837,8 @@ api.snapshot.prototype.create = ca({ * Perform a [snapshot.createRepository](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/modules-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 {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout * @param {Boolean} params.verify - Whether to verify the repository after creation * @param {String} params.repository - A repository name */ @@ -5871,7 +5871,7 @@ api.snapshot.prototype.createRepository = ca({ * Perform a [snapshot.delete](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {String} params.repository - A repository name * @param {String} params.snapshot - A snapshot name */ @@ -5900,8 +5900,8 @@ api.snapshot.prototype['delete'] = ca({ * Perform a [snapshot.deleteRepository](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/modules-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 {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String, String[], Boolean} params.repository - A comma-separated list of repository names */ api.snapshot.prototype.deleteRepository = ca({ @@ -5929,7 +5929,7 @@ api.snapshot.prototype.deleteRepository = ca({ * Perform a [snapshot.get](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {String} params.repository - A repository name * @param {String, String[], Boolean} params.snapshot - A comma-separated list of snapshot names */ @@ -5957,7 +5957,7 @@ api.snapshot.prototype.get = ca({ * Perform a [snapshot.getRepository](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false) * @param {String, String[], Boolean} params.repository - A comma-separated list of repository names */ @@ -5990,7 +5990,7 @@ api.snapshot.prototype.getRepository = ca({ * Perform a [snapshot.restore](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {Boolean} params.waitForCompletion - Should this request wait until the operation has completed before returning * @param {String} params.repository - A repository name * @param {String} params.snapshot - A snapshot name @@ -6025,7 +6025,7 @@ api.snapshot.prototype.restore = ca({ * Perform a [snapshot.status](http://www.elastic.co/guide/en/elasticsearch/reference/1.7/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {String} params.repository - A repository name * @param {String, String[], Boolean} params.snapshot - A comma-separated list of snapshot names */ @@ -6066,8 +6066,8 @@ api.snapshot.prototype.status = ca({ * Perform a [snapshot.verifyRepository](http://www.elastic.co/guide/en/elasticsearch/reference/1.7/modules-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 {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String} params.repository - A repository name */ api.snapshot.prototype.verifyRepository = ca({ @@ -6260,9 +6260,9 @@ api.termvector = ca({ * @param {String} params.script - The URL-encoded script definition (instead of using request body) * @param {String} params.scriptId - The id of a stored script * @param {Boolean} params.scriptedUpsert - True if the script referenced in script or script_id should be called to perform inserts - defaults to false - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.timestamp - Explicit timestamp for the document - * @param {Date, Number} params.ttl - Expiration time for the document + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.timestamp - Explicit timestamp for the document + * @param {DurationString} params.ttl - Expiration time for the document * @param {Number} params.version - Explicit version number for concurrency control * @param {String} params.versionType - Specific version type * @param {String} params.id - Document ID @@ -6364,9 +6364,9 @@ api.update = ca({ * @param {Boolean} params.refresh - Refresh the index after performing the operation * @param {String} [params.replication=sync] - Specific replication type * @param {String} params.routing - Specific routing value - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.timestamp - Explicit timestamp for the document - * @param {Date, Number} params.ttl - Expiration time for the document + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.timestamp - Explicit timestamp for the document + * @param {DurationString} params.ttl - Expiration time for the document * @param {Number} params.version - Explicit version number for concurrency control * @param {String} params.versionType - Specific version type * @param {String} params.id - Document ID diff --git a/src/lib/apis/2_0.js b/src/lib/apis/2_0.js index 31b66a629..feeb9b63f 100644 --- a/src/lib/apis/2_0.js +++ b/src/lib/apis/2_0.js @@ -20,7 +20,7 @@ api._namespaces = ['cat', 'cluster', 'indices', 'nodes', 'snapshot']; * @param {String} params.consistency - Explicit write consistency setting for the operation * @param {Boolean} params.refresh - Refresh the index after performing the operation * @param {String} params.routing - Specific routing value - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String} params.type - Default document type for items which don't provide one * @param {String, String[], Boolean} params.fields - Default comma-separated list of fields to return in the response for updates * @param {String} params.index - Default index for items which don't provide one @@ -87,7 +87,7 @@ api.cat = namespace(); * * @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 {DurationString} 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 @@ -135,7 +135,7 @@ api.cat.prototype.aliases = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.bytes - The unit in which to display byte values * @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 {DurationString} 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 @@ -191,7 +191,7 @@ api.cat.prototype.allocation = ca({ * * @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 {DurationString} 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 @@ -239,7 +239,7 @@ api.cat.prototype.count = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.bytes - The unit in which to display byte values * @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 {DurationString} 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 @@ -298,7 +298,7 @@ api.cat.prototype.fielddata = ca({ * * @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 {DurationString} 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.ts=true] - Set to false to disable timestamping @@ -358,7 +358,7 @@ api.cat.prototype.help = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.bytes - The unit in which to display byte values * @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 {DurationString} 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.pri - Set to true to return stats only for primary shards @@ -419,7 +419,7 @@ api.cat.prototype.indices = ca({ * * @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 {DurationString} 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 @@ -455,7 +455,7 @@ api.cat.prototype.master = ca({ * * @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 {DurationString} 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 @@ -491,7 +491,7 @@ api.cat.prototype.nodeattrs = ca({ * * @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 {DurationString} 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 @@ -527,7 +527,7 @@ api.cat.prototype.nodes = ca({ * * @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 {DurationString} 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 @@ -563,7 +563,7 @@ api.cat.prototype.pendingTasks = ca({ * * @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 {DurationString} 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 @@ -599,7 +599,7 @@ api.cat.prototype.plugins = ca({ * * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.bytes - The unit in which to display byte values - * @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} 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 @@ -690,7 +690,7 @@ api.cat.prototype.segments = ca({ * * @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 {DurationString} 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 @@ -737,7 +737,7 @@ api.cat.prototype.shards = ca({ * * @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 {DurationString} 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 @@ -804,8 +804,8 @@ api.cluster = namespace(); * * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) - * @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout */ api.cluster.prototype.getSettings = ca({ params: { @@ -832,8 +832,8 @@ api.cluster.prototype.getSettings = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} [params.level=cluster] - Specify the level of detail for returned information * @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 {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout * @param {Number} params.waitForActiveShards - Wait until the specified number of shards is active * @param {String} params.waitForNodes - Wait until the specified number of nodes is available * @param {Number} params.waitForRelocatingShards - Wait until the specified number of relocating shards is finished @@ -904,7 +904,7 @@ api.cluster.prototype.health = ca({ * * @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 - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master */ api.cluster.prototype.pendingTasks = ca({ params: { @@ -926,8 +926,8 @@ api.cluster.prototype.pendingTasks = ca({ * * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) - * @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout */ api.cluster.prototype.putSettings = ca({ params: { @@ -956,8 +956,8 @@ api.cluster.prototype.putSettings = ca({ * @param {Boolean} params.dryRun - Simulate the operation only and return the resulting state * @param {Boolean} params.explain - Return an explanation of why the commands can or cannot be executed * @param {String, String[], Boolean} params.metric - Limit the information returned to the specified metrics. Defaults to all but metadata - * @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout */ api.cluster.prototype.reroute = ca({ params: { @@ -999,7 +999,7 @@ api.cluster.prototype.reroute = ca({ * * @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 - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) @@ -1092,7 +1092,7 @@ api.cluster.prototype.state = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) * @param {Boolean} params.human - Whether to return time and byte values in human-readable format. - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String, String[], Boolean} params.nodeId - A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes */ api.cluster.prototype.stats = ca({ @@ -1336,7 +1336,7 @@ api.countPercolate = ca({ * @param {String} params.parent - ID of parent document * @param {Boolean} params.refresh - Refresh the index after performing the operation * @param {String} params.routing - Specific routing value - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {Number} params.version - Explicit version number for concurrency control * @param {String} params.versionType - Specific version type * @param {String} params.id - The document ID @@ -1909,8 +1909,8 @@ api.getTemplate = ca({ * @param {String} params.parent - ID of the parent document * @param {Boolean} params.refresh - Refresh the index after performing the operation * @param {String} params.routing - Specific routing value - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.timestamp - Explicit timestamp for the document + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.timestamp - Explicit timestamp for the document * @param {Duration} params.ttl - Expiration time for the document * @param {Number} params.version - Explicit version number for concurrency control * @param {String} params.versionType - Specific version type @@ -2148,8 +2148,8 @@ api.indices.prototype.clearCache = ca({ * Perform a [indices.close](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-open-close.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) * @param {String} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both. @@ -2199,8 +2199,8 @@ api.indices.prototype.close = ca({ * Perform a [indices.create](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-create-index.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.updateAllTypes - Whether to update the mapping for all fields with the same name across all types or not * @param {String} params.index - The name of the index */ @@ -2233,8 +2233,8 @@ api.indices.prototype.create = ca({ * Perform a [indices.delete](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-delete-index.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String, String[], Boolean} params.index - A comma-separated list of indices to delete; use `_all` or `*` string to delete all indices */ api.indices.prototype['delete'] = ca({ @@ -2262,8 +2262,8 @@ api.indices.prototype['delete'] = ca({ * Perform a [indices.deleteAlias](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-aliases.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit timestamp for the document - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit timestamp for the document + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String, String[], Boolean} params.index - A comma-separated list of index names (supports wildcards); use `_all` for all indices * @param {String, String[], Boolean} params.name - A comma-separated list of aliases to delete (supports wildcards); use `_all` to delete all aliases for the specified indices. */ @@ -2295,8 +2295,8 @@ api.indices.prototype.deleteAlias = ca({ * Perform a [indices.deleteTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-templates.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String} params.name - The name of the template */ api.indices.prototype.deleteTemplate = ca({ @@ -2324,7 +2324,7 @@ api.indices.prototype.deleteTemplate = ca({ * Perform a [indices.deleteWarmer](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-warmers.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String, String[], Boolean} params.name - A comma-separated list of warmer names to delete (supports wildcards); use `_all` to delete all warmers in the specified indices. You must specify a name either in the uri or in the parameters. * @param {String, String[], Boolean} params.index - A comma-separated list of index names to delete warmers from (supports wildcards); use `_all` to perform the operation on all indices. */ @@ -2473,7 +2473,7 @@ api.indices.prototype.existsAlias = ca({ * Perform a [indices.existsTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-templates.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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false) * @param {String} params.name - The name of the template */ @@ -2800,7 +2800,7 @@ api.indices.prototype.getAlias = ca({ * Perform a [indices.getAliases](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-aliases.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false) * @param {String, String[], Boolean} params.index - A comma-separated list of index names to filter aliases * @param {String, String[], Boolean} params.name - A comma-separated list of alias names to filter @@ -3096,7 +3096,7 @@ api.indices.prototype.getSettings = ca({ * * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) - * @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false) * @param {String, String[], Boolean} params.name - The comma separated names of the index templates */ @@ -3269,8 +3269,8 @@ api.indices.prototype.getWarmer = ca({ * Perform a [indices.open](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-open-close.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) * @param {String} [params.expandWildcards=closed] - Whether to expand wildcard expression to concrete indices that are open, closed or both. @@ -3390,8 +3390,8 @@ api.indices.prototype.optimize = ca({ * Perform a [indices.putAlias](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-aliases.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit timestamp for the document - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit timestamp for the document + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String, String[], Boolean} params.index - A comma-separated list of index names the alias should point to (supports wildcards); use `_all` to perform the operation on all indices. * @param {String} params.name - The name of the alias to be created or updated */ @@ -3423,8 +3423,8 @@ api.indices.prototype.putAlias = ca({ * Perform a [indices.putMapping](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-put-mapping.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) * @param {String} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both. @@ -3494,7 +3494,7 @@ api.indices.prototype.putMapping = ca({ * Perform a [indices.putSettings](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-update-settings.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) * @param {String} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both. @@ -3554,8 +3554,8 @@ api.indices.prototype.putSettings = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {Number} params.order - The order for this template when merging multiple matching ones (higher numbers are merged later, overriding the lower numbers) * @param {Boolean} params.create - Whether the index template should only be added if new or can also replace an existing one - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) * @param {String} params.name - The name of the template */ @@ -3596,7 +3596,7 @@ api.indices.prototype.putTemplate = ca({ * Perform a [indices.putWarmer](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-warmers.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) in the search request to warm * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices in the search request to warm. (This includes `_all` string or when no indices have been specified) * @param {String} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both, in the search request to warm. @@ -4013,8 +4013,8 @@ api.indices.prototype.stats = ca({ * Perform a [indices.updateAliases](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-aliases.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Request timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Request timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master */ api.indices.prototype.updateAliases = ca({ params: { @@ -4509,12 +4509,12 @@ api.nodes = namespace(); * Perform a [nodes.hotThreads](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/cluster-nodes-hot-threads.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.interval - The interval for the second sampling of threads + * @param {DurationString} params.interval - The interval for the second sampling of threads * @param {Number} params.snapshots - Number of samples of thread stacktrace (default: 10) * @param {Number} params.threads - Specify the number of threads to provide information for (default: 3) * @param {Boolean} params.ignoreIdleThreads - Don't show threads that are in known-idle places, such as waiting on a socket select or pulling from an empty task queue (default: true) * @param {String} params.type - The type to sample (default: cpu) - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String, String[], Boolean} params.nodeId - A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes */ api.nodes.prototype.hotThreads = ca({ @@ -4565,7 +4565,7 @@ api.nodes.prototype.hotThreads = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) * @param {Boolean} params.human - Whether to return time and byte values in human-readable format. - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String, String[], Boolean} params.nodeId - A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes * @param {String, String[], Boolean} params.metric - A comma-separated list of metrics you wish returned. Leave empty to return all. */ @@ -4648,7 +4648,7 @@ api.nodes.prototype.info = ca({ * @param {Boolean} params.human - Whether to return time and byte values in human-readable format. * @param {String} [params.level=node] - Return indices stats aggregated at node, index or shard level * @param {String, String[], Boolean} params.types - A comma-separated list of document types for the `indexing` index metric - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String, String[], Boolean} params.metric - Limit the information returned to the specified metrics * @param {String, String[], Boolean} params.indexMetric - Limit the information returned for `indices` metric to the specific index metrics. Isn't used if `indices` (or `all`) metric isn't specified. * @param {String, String[], Boolean} params.nodeId - A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes @@ -5147,7 +5147,7 @@ api.scroll = ca({ * @param {String} [params.suggestMode=missing] - Specify suggest mode * @param {Number} params.suggestSize - How many suggestions to return in response * @param {Text} params.suggestText - The source text for which the suggestions should be returned - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {Boolean} params.trackScores - Whether to calculate and return scores even if they are not used for sorting * @param {Boolean} params.version - Specify whether to return document version as part of a hit * @param {Boolean} params.requestCache - Specify if request cache should be used for this request or not, defaults to index level setting @@ -5593,7 +5593,7 @@ api.snapshot = namespace(); * Perform a [snapshot.create](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {Boolean} params.waitForCompletion - Should this request wait until the operation has completed before returning * @param {String} params.repository - A repository name * @param {String} params.snapshot - A snapshot name @@ -5628,8 +5628,8 @@ api.snapshot.prototype.create = ca({ * Perform a [snapshot.createRepository](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/modules-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 {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout * @param {Boolean} params.verify - Whether to verify the repository after creation * @param {String} params.repository - A repository name */ @@ -5662,7 +5662,7 @@ api.snapshot.prototype.createRepository = ca({ * Perform a [snapshot.delete](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {String} params.repository - A repository name * @param {String} params.snapshot - A snapshot name */ @@ -5691,8 +5691,8 @@ api.snapshot.prototype['delete'] = ca({ * Perform a [snapshot.deleteRepository](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/modules-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 {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String, String[], Boolean} params.repository - A comma-separated list of repository names */ api.snapshot.prototype.deleteRepository = ca({ @@ -5720,7 +5720,7 @@ api.snapshot.prototype.deleteRepository = ca({ * Perform a [snapshot.get](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {String} params.repository - A repository name * @param {String, String[], Boolean} params.snapshot - A comma-separated list of snapshot names */ @@ -5748,7 +5748,7 @@ api.snapshot.prototype.get = ca({ * Perform a [snapshot.getRepository](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false) * @param {String, String[], Boolean} params.repository - A comma-separated list of repository names */ @@ -5781,7 +5781,7 @@ api.snapshot.prototype.getRepository = ca({ * Perform a [snapshot.restore](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {Boolean} params.waitForCompletion - Should this request wait until the operation has completed before returning * @param {String} params.repository - A repository name * @param {String} params.snapshot - A snapshot name @@ -5816,7 +5816,7 @@ api.snapshot.prototype.restore = ca({ * Perform a [snapshot.status](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {String} params.repository - A repository name * @param {String, String[], Boolean} params.snapshot - A comma-separated list of snapshot names */ @@ -5857,8 +5857,8 @@ api.snapshot.prototype.status = ca({ * Perform a [snapshot.verifyRepository](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/modules-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 {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String} params.repository - A repository name */ api.snapshot.prototype.verifyRepository = ca({ @@ -6071,8 +6071,8 @@ api.termvectors = ca({ * @param {Anything} params.script - The URL-encoded script definition (instead of using request body) * @param {Anything} params.scriptId - The id of a stored script * @param {Boolean} params.scriptedUpsert - True if the script referenced in script or script_id should be called to perform inserts - defaults to false - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.timestamp - Explicit timestamp for the document + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.timestamp - Explicit timestamp for the document * @param {Duration} params.ttl - Expiration time for the document * @param {Number} params.version - Explicit version number for concurrency control * @param {String} params.versionType - Specific version type @@ -6163,8 +6163,8 @@ api.update = ca({ * @param {String} params.parent - ID of the parent document * @param {Boolean} params.refresh - Refresh the index after performing the operation * @param {String} params.routing - Specific routing value - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.timestamp - Explicit timestamp for the document + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.timestamp - Explicit timestamp for the document * @param {Duration} params.ttl - Expiration time for the document * @param {Number} params.version - Explicit version number for concurrency control * @param {String} params.versionType - Specific version type diff --git a/src/lib/apis/2_1.js b/src/lib/apis/2_1.js index 70ff1e3ad..5af5ecfbf 100644 --- a/src/lib/apis/2_1.js +++ b/src/lib/apis/2_1.js @@ -20,7 +20,7 @@ api._namespaces = ['cat', 'cluster', 'indices', 'nodes', 'snapshot']; * @param {String} params.consistency - Explicit write consistency setting for the operation * @param {Boolean} params.refresh - Refresh the index after performing the operation * @param {String} params.routing - Specific routing value - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String} params.type - Default document type for items which don't provide one * @param {String, String[], Boolean} params.fields - Default comma-separated list of fields to return in the response for updates * @param {String} params.index - Default index for items which don't provide one @@ -87,7 +87,7 @@ api.cat = namespace(); * * @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 {DurationString} 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 @@ -135,7 +135,7 @@ api.cat.prototype.aliases = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.bytes - The unit in which to display byte values * @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 {DurationString} 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 @@ -191,7 +191,7 @@ api.cat.prototype.allocation = ca({ * * @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 {DurationString} 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 @@ -239,7 +239,7 @@ api.cat.prototype.count = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.bytes - The unit in which to display byte values * @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 {DurationString} 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 @@ -298,7 +298,7 @@ api.cat.prototype.fielddata = ca({ * * @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 {DurationString} 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.ts=true] - Set to false to disable timestamping @@ -358,7 +358,7 @@ api.cat.prototype.help = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.bytes - The unit in which to display byte values * @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 {DurationString} 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.pri - Set to true to return stats only for primary shards @@ -419,7 +419,7 @@ api.cat.prototype.indices = ca({ * * @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 {DurationString} 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 @@ -455,7 +455,7 @@ api.cat.prototype.master = ca({ * * @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 {DurationString} 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 @@ -491,7 +491,7 @@ api.cat.prototype.nodeattrs = ca({ * * @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 {DurationString} 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 @@ -527,7 +527,7 @@ api.cat.prototype.nodes = ca({ * * @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 {DurationString} 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 @@ -563,7 +563,7 @@ api.cat.prototype.pendingTasks = ca({ * * @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 {DurationString} 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 @@ -599,7 +599,7 @@ api.cat.prototype.plugins = ca({ * * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.bytes - The unit in which to display byte values - * @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} 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 @@ -652,7 +652,7 @@ api.cat.prototype.recovery = ca({ * * @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 {DurationString} 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 @@ -727,7 +727,7 @@ api.cat.prototype.segments = ca({ * * @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 {DurationString} 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 @@ -773,7 +773,7 @@ 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 {DurationString} 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 @@ -812,7 +812,7 @@ api.cat.prototype.snapshots = ca({ * * @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 {DurationString} 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 @@ -879,8 +879,8 @@ api.cluster = namespace(); * * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) - * @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout */ api.cluster.prototype.getSettings = ca({ params: { @@ -907,8 +907,8 @@ api.cluster.prototype.getSettings = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} [params.level=cluster] - Specify the level of detail for returned information * @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 {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout * @param {Number} params.waitForActiveShards - Wait until the specified number of shards is active * @param {String} params.waitForNodes - Wait until the specified number of nodes is available * @param {Number} params.waitForRelocatingShards - Wait until the specified number of relocating shards is finished @@ -979,7 +979,7 @@ api.cluster.prototype.health = ca({ * * @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 - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master */ api.cluster.prototype.pendingTasks = ca({ params: { @@ -1001,8 +1001,8 @@ api.cluster.prototype.pendingTasks = ca({ * * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) - * @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout */ api.cluster.prototype.putSettings = ca({ params: { @@ -1031,8 +1031,8 @@ api.cluster.prototype.putSettings = ca({ * @param {Boolean} params.dryRun - Simulate the operation only and return the resulting state * @param {Boolean} params.explain - Return an explanation of why the commands can or cannot be executed * @param {String, String[], Boolean} params.metric - Limit the information returned to the specified metrics. Defaults to all but metadata - * @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout */ api.cluster.prototype.reroute = ca({ params: { @@ -1074,7 +1074,7 @@ api.cluster.prototype.reroute = ca({ * * @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 - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) @@ -1167,7 +1167,7 @@ api.cluster.prototype.state = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) * @param {Boolean} params.human - Whether to return time and byte values in human-readable format. - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String, String[], Boolean} params.nodeId - A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes */ api.cluster.prototype.stats = ca({ @@ -1411,7 +1411,7 @@ api.countPercolate = ca({ * @param {String} params.parent - ID of parent document * @param {Boolean} params.refresh - Refresh the index after performing the operation * @param {String} params.routing - Specific routing value - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {Number} params.version - Explicit version number for concurrency control * @param {String} params.versionType - Specific version type * @param {String} params.id - The document ID @@ -1984,8 +1984,8 @@ api.getTemplate = ca({ * @param {String} params.parent - ID of the parent document * @param {Boolean} params.refresh - Refresh the index after performing the operation * @param {String} params.routing - Specific routing value - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.timestamp - Explicit timestamp for the document + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.timestamp - Explicit timestamp for the document * @param {Duration} params.ttl - Expiration time for the document * @param {Number} params.version - Explicit version number for concurrency control * @param {String} params.versionType - Specific version type @@ -2223,8 +2223,8 @@ api.indices.prototype.clearCache = ca({ * Perform a [indices.close](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-open-close.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) * @param {String} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both. @@ -2274,8 +2274,8 @@ api.indices.prototype.close = ca({ * Perform a [indices.create](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-create-index.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.updateAllTypes - Whether to update the mapping for all fields with the same name across all types or not * @param {String} params.index - The name of the index */ @@ -2308,8 +2308,8 @@ api.indices.prototype.create = ca({ * Perform a [indices.delete](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-delete-index.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String, String[], Boolean} params.index - A comma-separated list of indices to delete; use `_all` or `*` string to delete all indices */ api.indices.prototype['delete'] = ca({ @@ -2337,8 +2337,8 @@ api.indices.prototype['delete'] = ca({ * Perform a [indices.deleteAlias](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-aliases.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit timestamp for the document - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit timestamp for the document + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String, String[], Boolean} params.index - A comma-separated list of index names (supports wildcards); use `_all` for all indices * @param {String, String[], Boolean} params.name - A comma-separated list of aliases to delete (supports wildcards); use `_all` to delete all aliases for the specified indices. */ @@ -2370,8 +2370,8 @@ api.indices.prototype.deleteAlias = ca({ * Perform a [indices.deleteTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-templates.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String} params.name - The name of the template */ api.indices.prototype.deleteTemplate = ca({ @@ -2399,7 +2399,7 @@ api.indices.prototype.deleteTemplate = ca({ * Perform a [indices.deleteWarmer](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-warmers.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String, String[], Boolean} params.name - A comma-separated list of warmer names to delete (supports wildcards); use `_all` to delete all warmers in the specified indices. You must specify a name either in the uri or in the parameters. * @param {String, String[], Boolean} params.index - A comma-separated list of index names to delete warmers from (supports wildcards); use `_all` to perform the operation on all indices. */ @@ -2548,7 +2548,7 @@ api.indices.prototype.existsAlias = ca({ * Perform a [indices.existsTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-templates.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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false) * @param {String} params.name - The name of the template */ @@ -2945,7 +2945,7 @@ api.indices.prototype.getAlias = ca({ * Perform a [indices.getAliases](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-aliases.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false) * @param {String, String[], Boolean} params.index - A comma-separated list of index names to filter aliases * @param {String, String[], Boolean} params.name - A comma-separated list of alias names to filter @@ -3241,7 +3241,7 @@ api.indices.prototype.getSettings = ca({ * * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) - * @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false) * @param {String, String[], Boolean} params.name - The comma separated names of the index templates */ @@ -3414,8 +3414,8 @@ api.indices.prototype.getWarmer = ca({ * Perform a [indices.open](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-open-close.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) * @param {String} [params.expandWildcards=closed] - Whether to expand wildcard expression to concrete indices that are open, closed or both. @@ -3535,8 +3535,8 @@ api.indices.prototype.optimize = ca({ * Perform a [indices.putAlias](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-aliases.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit timestamp for the document - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit timestamp for the document + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String, String[], Boolean} params.index - A comma-separated list of index names the alias should point to (supports wildcards); use `_all` to perform the operation on all indices. * @param {String} params.name - The name of the alias to be created or updated */ @@ -3568,8 +3568,8 @@ api.indices.prototype.putAlias = ca({ * Perform a [indices.putMapping](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-put-mapping.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) * @param {String} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both. @@ -3639,7 +3639,7 @@ api.indices.prototype.putMapping = ca({ * Perform a [indices.putSettings](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-update-settings.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) * @param {String} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both. @@ -3699,8 +3699,8 @@ api.indices.prototype.putSettings = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {Number} params.order - The order for this template when merging multiple matching ones (higher numbers are merged later, overriding the lower numbers) * @param {Boolean} params.create - Whether the index template should only be added if new or can also replace an existing one - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) * @param {String} params.name - The name of the template */ @@ -3741,7 +3741,7 @@ api.indices.prototype.putTemplate = ca({ * Perform a [indices.putWarmer](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-warmers.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) in the search request to warm * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices in the search request to warm. (This includes `_all` string or when no indices have been specified) * @param {String} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both, in the search request to warm. @@ -4158,8 +4158,8 @@ api.indices.prototype.stats = ca({ * Perform a [indices.updateAliases](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-aliases.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Request timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Request timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master */ api.indices.prototype.updateAliases = ca({ params: { @@ -4654,12 +4654,12 @@ api.nodes = namespace(); * Perform a [nodes.hotThreads](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/cluster-nodes-hot-threads.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.interval - The interval for the second sampling of threads + * @param {DurationString} params.interval - The interval for the second sampling of threads * @param {Number} params.snapshots - Number of samples of thread stacktrace (default: 10) * @param {Number} params.threads - Specify the number of threads to provide information for (default: 3) * @param {Boolean} params.ignoreIdleThreads - Don't show threads that are in known-idle places, such as waiting on a socket select or pulling from an empty task queue (default: true) * @param {String} params.type - The type to sample (default: cpu) - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String, String[], Boolean} params.nodeId - A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes */ api.nodes.prototype.hotThreads = ca({ @@ -4710,7 +4710,7 @@ api.nodes.prototype.hotThreads = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) * @param {Boolean} params.human - Whether to return time and byte values in human-readable format. - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String, String[], Boolean} params.nodeId - A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes * @param {String, String[], Boolean} params.metric - A comma-separated list of metrics you wish returned. Leave empty to return all. */ @@ -4793,7 +4793,7 @@ api.nodes.prototype.info = ca({ * @param {Boolean} params.human - Whether to return time and byte values in human-readable format. * @param {String} [params.level=node] - Return indices stats aggregated at node, index or shard level * @param {String, String[], Boolean} params.types - A comma-separated list of document types for the `indexing` index metric - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String, String[], Boolean} params.metric - Limit the information returned to the specified metrics * @param {String, String[], Boolean} params.indexMetric - Limit the information returned for `indices` metric to the specific index metrics. Isn't used if `indices` (or `all`) metric isn't specified. * @param {String, String[], Boolean} params.nodeId - A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes @@ -5292,7 +5292,7 @@ api.scroll = ca({ * @param {String} [params.suggestMode=missing] - Specify suggest mode * @param {Number} params.suggestSize - How many suggestions to return in response * @param {Text} params.suggestText - The source text for which the suggestions should be returned - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {Boolean} params.trackScores - Whether to calculate and return scores even if they are not used for sorting * @param {Boolean} params.version - Specify whether to return document version as part of a hit * @param {Boolean} params.requestCache - Specify if request cache should be used for this request or not, defaults to index level setting @@ -5738,7 +5738,7 @@ api.snapshot = namespace(); * Perform a [snapshot.create](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {Boolean} params.waitForCompletion - Should this request wait until the operation has completed before returning * @param {String} params.repository - A repository name * @param {String} params.snapshot - A snapshot name @@ -5773,8 +5773,8 @@ api.snapshot.prototype.create = ca({ * Perform a [snapshot.createRepository](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/modules-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 {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout * @param {Boolean} params.verify - Whether to verify the repository after creation * @param {String} params.repository - A repository name */ @@ -5807,7 +5807,7 @@ api.snapshot.prototype.createRepository = ca({ * Perform a [snapshot.delete](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {String} params.repository - A repository name * @param {String} params.snapshot - A snapshot name */ @@ -5836,8 +5836,8 @@ api.snapshot.prototype['delete'] = ca({ * Perform a [snapshot.deleteRepository](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/modules-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 {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String, String[], Boolean} params.repository - A comma-separated list of repository names */ api.snapshot.prototype.deleteRepository = ca({ @@ -5865,7 +5865,7 @@ api.snapshot.prototype.deleteRepository = ca({ * Perform a [snapshot.get](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {String} params.repository - A repository name * @param {String, String[], Boolean} params.snapshot - A comma-separated list of snapshot names */ @@ -5893,7 +5893,7 @@ api.snapshot.prototype.get = ca({ * Perform a [snapshot.getRepository](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false) * @param {String, String[], Boolean} params.repository - A comma-separated list of repository names */ @@ -5926,7 +5926,7 @@ api.snapshot.prototype.getRepository = ca({ * Perform a [snapshot.restore](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {Boolean} params.waitForCompletion - Should this request wait until the operation has completed before returning * @param {String} params.repository - A repository name * @param {String} params.snapshot - A snapshot name @@ -5961,7 +5961,7 @@ api.snapshot.prototype.restore = ca({ * Perform a [snapshot.status](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {String} params.repository - A repository name * @param {String, String[], Boolean} params.snapshot - A comma-separated list of snapshot names */ @@ -6002,8 +6002,8 @@ api.snapshot.prototype.status = ca({ * Perform a [snapshot.verifyRepository](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/modules-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 {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String} params.repository - A repository name */ api.snapshot.prototype.verifyRepository = ca({ @@ -6216,8 +6216,8 @@ api.termvectors = ca({ * @param {Anything} params.script - The URL-encoded script definition (instead of using request body) * @param {Anything} params.scriptId - The id of a stored script * @param {Boolean} params.scriptedUpsert - True if the script referenced in script or script_id should be called to perform inserts - defaults to false - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.timestamp - Explicit timestamp for the document + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.timestamp - Explicit timestamp for the document * @param {Duration} params.ttl - Expiration time for the document * @param {Number} params.version - Explicit version number for concurrency control * @param {String} params.versionType - Specific version type @@ -6308,8 +6308,8 @@ api.update = ca({ * @param {String} params.parent - ID of the parent document * @param {Boolean} params.refresh - Refresh the index after performing the operation * @param {String} params.routing - Specific routing value - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.timestamp - Explicit timestamp for the document + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.timestamp - Explicit timestamp for the document * @param {Duration} params.ttl - Expiration time for the document * @param {Number} params.version - Explicit version number for concurrency control * @param {String} params.versionType - Specific version type diff --git a/src/lib/apis/2_2.js b/src/lib/apis/2_2.js index 4ae95e9b8..36910e47c 100644 --- a/src/lib/apis/2_2.js +++ b/src/lib/apis/2_2.js @@ -20,7 +20,7 @@ api._namespaces = ['cat', 'cluster', 'indices', 'nodes', 'snapshot']; * @param {String} params.consistency - Explicit write consistency setting for the operation * @param {Boolean} params.refresh - Refresh the index after performing the operation * @param {String} params.routing - Specific routing value - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String} params.type - Default document type for items which don't provide one * @param {String, String[], Boolean} params.fields - Default comma-separated list of fields to return in the response for updates * @param {String} params.index - Default index for items which don't provide one @@ -87,7 +87,7 @@ api.cat = namespace(); * * @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 {DurationString} 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 @@ -135,7 +135,7 @@ api.cat.prototype.aliases = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.bytes - The unit in which to display byte values * @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 {DurationString} 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 @@ -191,7 +191,7 @@ api.cat.prototype.allocation = ca({ * * @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 {DurationString} 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 @@ -239,7 +239,7 @@ api.cat.prototype.count = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.bytes - The unit in which to display byte values * @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 {DurationString} 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 @@ -298,7 +298,7 @@ api.cat.prototype.fielddata = ca({ * * @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 {DurationString} 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.ts=true] - Set to false to disable timestamping @@ -358,7 +358,7 @@ api.cat.prototype.help = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.bytes - The unit in which to display byte values * @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 {DurationString} 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.pri - Set to true to return stats only for primary shards @@ -419,7 +419,7 @@ api.cat.prototype.indices = ca({ * * @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 {DurationString} 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 @@ -455,7 +455,7 @@ api.cat.prototype.master = ca({ * * @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 {DurationString} 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 @@ -491,7 +491,7 @@ api.cat.prototype.nodeattrs = ca({ * * @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 {DurationString} 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 @@ -527,7 +527,7 @@ api.cat.prototype.nodes = ca({ * * @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 {DurationString} 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 @@ -563,7 +563,7 @@ api.cat.prototype.pendingTasks = ca({ * * @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 {DurationString} 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 @@ -599,7 +599,7 @@ api.cat.prototype.plugins = ca({ * * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.bytes - The unit in which to display byte values - * @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} 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 @@ -652,7 +652,7 @@ api.cat.prototype.recovery = ca({ * * @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 {DurationString} 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 @@ -727,7 +727,7 @@ api.cat.prototype.segments = ca({ * * @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 {DurationString} 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 @@ -774,7 +774,7 @@ api.cat.prototype.shards = ca({ * * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.ignoreUnavailable - Set to true to ignore unavailable snapshots - * @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} 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 @@ -818,7 +818,7 @@ api.cat.prototype.snapshots = ca({ * * @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 {DurationString} 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 @@ -885,8 +885,8 @@ api.cluster = namespace(); * * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) - * @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout */ api.cluster.prototype.getSettings = ca({ params: { @@ -913,8 +913,8 @@ api.cluster.prototype.getSettings = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} [params.level=cluster] - Specify the level of detail for returned information * @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 {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout * @param {Number} params.waitForActiveShards - Wait until the specified number of shards is active * @param {String} params.waitForNodes - Wait until the specified number of nodes is available * @param {Number} params.waitForRelocatingShards - Wait until the specified number of relocating shards is finished @@ -985,7 +985,7 @@ api.cluster.prototype.health = ca({ * * @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 - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master */ api.cluster.prototype.pendingTasks = ca({ params: { @@ -1007,8 +1007,8 @@ api.cluster.prototype.pendingTasks = ca({ * * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) - * @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout */ api.cluster.prototype.putSettings = ca({ params: { @@ -1037,8 +1037,8 @@ api.cluster.prototype.putSettings = ca({ * @param {Boolean} params.dryRun - Simulate the operation only and return the resulting state * @param {Boolean} params.explain - Return an explanation of why the commands can or cannot be executed * @param {String, String[], Boolean} params.metric - Limit the information returned to the specified metrics. Defaults to all but metadata - * @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout */ api.cluster.prototype.reroute = ca({ params: { @@ -1080,7 +1080,7 @@ api.cluster.prototype.reroute = ca({ * * @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 - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) @@ -1173,7 +1173,7 @@ api.cluster.prototype.state = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) * @param {Boolean} params.human - Whether to return time and byte values in human-readable format. - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String, String[], Boolean} params.nodeId - A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes */ api.cluster.prototype.stats = ca({ @@ -1417,7 +1417,7 @@ api.countPercolate = ca({ * @param {String} params.parent - ID of parent document * @param {Boolean} params.refresh - Refresh the index after performing the operation * @param {String} params.routing - Specific routing value - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {Number} params.version - Explicit version number for concurrency control * @param {String} params.versionType - Specific version type * @param {String} params.id - The document ID @@ -1990,8 +1990,8 @@ api.getTemplate = ca({ * @param {String} params.parent - ID of the parent document * @param {Boolean} params.refresh - Refresh the index after performing the operation * @param {String} params.routing - Specific routing value - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.timestamp - Explicit timestamp for the document + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.timestamp - Explicit timestamp for the document * @param {Duration} params.ttl - Expiration time for the document * @param {Number} params.version - Explicit version number for concurrency control * @param {String} params.versionType - Specific version type @@ -2237,8 +2237,8 @@ api.indices.prototype.clearCache = ca({ * Perform a [indices.close](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-open-close.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) * @param {String} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both. @@ -2288,8 +2288,8 @@ api.indices.prototype.close = ca({ * Perform a [indices.create](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-create-index.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.updateAllTypes - Whether to update the mapping for all fields with the same name across all types or not * @param {String} params.index - The name of the index */ @@ -2322,8 +2322,8 @@ api.indices.prototype.create = ca({ * Perform a [indices.delete](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-delete-index.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String, String[], Boolean} params.index - A comma-separated list of indices to delete; use `_all` or `*` string to delete all indices */ api.indices.prototype['delete'] = ca({ @@ -2351,8 +2351,8 @@ api.indices.prototype['delete'] = ca({ * Perform a [indices.deleteAlias](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit timestamp for the document - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit timestamp for the document + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String, String[], Boolean} params.index - A comma-separated list of index names (supports wildcards); use `_all` for all indices * @param {String, String[], Boolean} params.name - A comma-separated list of aliases to delete (supports wildcards); use `_all` to delete all aliases for the specified indices. */ @@ -2384,8 +2384,8 @@ api.indices.prototype.deleteAlias = ca({ * Perform a [indices.deleteTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String} params.name - The name of the template */ api.indices.prototype.deleteTemplate = ca({ @@ -2413,7 +2413,7 @@ api.indices.prototype.deleteTemplate = ca({ * Perform a [indices.deleteWarmer](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-warmers.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String, String[], Boolean} params.name - A comma-separated list of warmer names to delete (supports wildcards); use `_all` to delete all warmers in the specified indices. You must specify a name either in the uri or in the parameters. * @param {String, String[], Boolean} params.index - A comma-separated list of index names to delete warmers from (supports wildcards); use `_all` to perform the operation on all indices. */ @@ -2562,7 +2562,7 @@ api.indices.prototype.existsAlias = ca({ * Perform a [indices.existsTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false) * @param {String} params.name - The name of the template */ @@ -2959,7 +2959,7 @@ api.indices.prototype.getAlias = ca({ * Perform a [indices.getAliases](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false) * @param {String, String[], Boolean} params.index - A comma-separated list of index names to filter aliases * @param {String, String[], Boolean} params.name - A comma-separated list of alias names to filter @@ -3255,7 +3255,7 @@ api.indices.prototype.getSettings = ca({ * * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) - * @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false) * @param {String, String[], Boolean} params.name - The comma separated names of the index templates */ @@ -3428,8 +3428,8 @@ api.indices.prototype.getWarmer = ca({ * Perform a [indices.open](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-open-close.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) * @param {String} [params.expandWildcards=closed] - Whether to expand wildcard expression to concrete indices that are open, closed or both. @@ -3549,8 +3549,8 @@ api.indices.prototype.optimize = ca({ * Perform a [indices.putAlias](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit timestamp for the document - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit timestamp for the document + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String, String[], Boolean} params.index - A comma-separated list of index names the alias should point to (supports wildcards); use `_all` to perform the operation on all indices. * @param {String} params.name - The name of the alias to be created or updated */ @@ -3582,8 +3582,8 @@ api.indices.prototype.putAlias = ca({ * Perform a [indices.putMapping](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-put-mapping.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) * @param {String} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both. @@ -3653,7 +3653,7 @@ api.indices.prototype.putMapping = ca({ * Perform a [indices.putSettings](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-update-settings.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) * @param {String} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both. @@ -3713,8 +3713,8 @@ api.indices.prototype.putSettings = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {Number} params.order - The order for this template when merging multiple matching ones (higher numbers are merged later, overriding the lower numbers) * @param {Boolean} params.create - Whether the index template should only be added if new or can also replace an existing one - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) * @param {String} params.name - The name of the template */ @@ -3755,7 +3755,7 @@ api.indices.prototype.putTemplate = ca({ * Perform a [indices.putWarmer](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-warmers.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) in the search request to warm * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices in the search request to warm. (This includes `_all` string or when no indices have been specified) * @param {String} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both, in the search request to warm. @@ -4172,8 +4172,8 @@ api.indices.prototype.stats = ca({ * Perform a [indices.updateAliases](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Request timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Request timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master */ api.indices.prototype.updateAliases = ca({ params: { @@ -4668,12 +4668,12 @@ api.nodes = namespace(); * Perform a [nodes.hotThreads](http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-hot-threads.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.interval - The interval for the second sampling of threads + * @param {DurationString} params.interval - The interval for the second sampling of threads * @param {Number} params.snapshots - Number of samples of thread stacktrace (default: 10) * @param {Number} params.threads - Specify the number of threads to provide information for (default: 3) * @param {Boolean} params.ignoreIdleThreads - Don't show threads that are in known-idle places, such as waiting on a socket select or pulling from an empty task queue (default: true) * @param {String} params.type - The type to sample (default: cpu) - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String, String[], Boolean} params.nodeId - A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes */ api.nodes.prototype.hotThreads = ca({ @@ -4724,7 +4724,7 @@ api.nodes.prototype.hotThreads = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) * @param {Boolean} params.human - Whether to return time and byte values in human-readable format. - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String, String[], Boolean} params.nodeId - A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes * @param {String, String[], Boolean} params.metric - A comma-separated list of metrics you wish returned. Leave empty to return all. */ @@ -4807,7 +4807,7 @@ api.nodes.prototype.info = ca({ * @param {Boolean} params.human - Whether to return time and byte values in human-readable format. * @param {String} [params.level=node] - Return indices stats aggregated at node, index or shard level * @param {String, String[], Boolean} params.types - A comma-separated list of document types for the `indexing` index metric - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String, String[], Boolean} params.metric - Limit the information returned to the specified metrics * @param {String, String[], Boolean} params.indexMetric - Limit the information returned for `indices` metric to the specific index metrics. Isn't used if `indices` (or `all`) metric isn't specified. * @param {String, String[], Boolean} params.nodeId - A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes @@ -5306,7 +5306,7 @@ api.scroll = ca({ * @param {String} [params.suggestMode=missing] - Specify suggest mode * @param {Number} params.suggestSize - How many suggestions to return in response * @param {Text} params.suggestText - The source text for which the suggestions should be returned - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {Boolean} params.trackScores - Whether to calculate and return scores even if they are not used for sorting * @param {Boolean} params.version - Specify whether to return document version as part of a hit * @param {Boolean} params.requestCache - Specify if request cache should be used for this request or not, defaults to index level setting @@ -5752,7 +5752,7 @@ api.snapshot = namespace(); * Perform a [snapshot.create](http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {Boolean} params.waitForCompletion - Should this request wait until the operation has completed before returning * @param {String} params.repository - A repository name * @param {String} params.snapshot - A snapshot name @@ -5787,8 +5787,8 @@ api.snapshot.prototype.create = ca({ * Perform a [snapshot.createRepository](http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-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 {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout * @param {Boolean} params.verify - Whether to verify the repository after creation * @param {String} params.repository - A repository name */ @@ -5821,7 +5821,7 @@ api.snapshot.prototype.createRepository = ca({ * Perform a [snapshot.delete](http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {String} params.repository - A repository name * @param {String} params.snapshot - A snapshot name */ @@ -5850,8 +5850,8 @@ api.snapshot.prototype['delete'] = ca({ * Perform a [snapshot.deleteRepository](http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-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 {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String, String[], Boolean} params.repository - A comma-separated list of repository names */ api.snapshot.prototype.deleteRepository = ca({ @@ -5879,7 +5879,7 @@ api.snapshot.prototype.deleteRepository = ca({ * Perform a [snapshot.get](http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {String} params.repository - A repository name * @param {String, String[], Boolean} params.snapshot - A comma-separated list of snapshot names */ @@ -5907,7 +5907,7 @@ api.snapshot.prototype.get = ca({ * Perform a [snapshot.getRepository](http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false) * @param {String, String[], Boolean} params.repository - A comma-separated list of repository names */ @@ -5940,7 +5940,7 @@ api.snapshot.prototype.getRepository = ca({ * Perform a [snapshot.restore](http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {Boolean} params.waitForCompletion - Should this request wait until the operation has completed before returning * @param {String} params.repository - A repository name * @param {String} params.snapshot - A snapshot name @@ -5975,7 +5975,7 @@ api.snapshot.prototype.restore = ca({ * Perform a [snapshot.status](http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {String} params.repository - A repository name * @param {String, String[], Boolean} params.snapshot - A comma-separated list of snapshot names */ @@ -6016,8 +6016,8 @@ api.snapshot.prototype.status = ca({ * Perform a [snapshot.verifyRepository](http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-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 {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String} params.repository - A repository name */ api.snapshot.prototype.verifyRepository = ca({ @@ -6230,8 +6230,8 @@ api.termvectors = ca({ * @param {Anything} params.script - The URL-encoded script definition (instead of using request body) * @param {Anything} params.scriptId - The id of a stored script * @param {Boolean} params.scriptedUpsert - True if the script referenced in script or script_id should be called to perform inserts - defaults to false - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.timestamp - Explicit timestamp for the document + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.timestamp - Explicit timestamp for the document * @param {Duration} params.ttl - Expiration time for the document * @param {Number} params.version - Explicit version number for concurrency control * @param {String} params.versionType - Specific version type @@ -6322,8 +6322,8 @@ api.update = ca({ * @param {String} params.parent - ID of the parent document * @param {Boolean} params.refresh - Refresh the index after performing the operation * @param {String} params.routing - Specific routing value - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.timestamp - Explicit timestamp for the document + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.timestamp - Explicit timestamp for the document * @param {Duration} params.ttl - Expiration time for the document * @param {Number} params.version - Explicit version number for concurrency control * @param {String} params.versionType - Specific version type diff --git a/src/lib/apis/2_3.js b/src/lib/apis/2_3.js index f5d64123d..f0b647a12 100644 --- a/src/lib/apis/2_3.js +++ b/src/lib/apis/2_3.js @@ -20,7 +20,7 @@ api._namespaces = ['cat', 'cluster', 'indices', 'nodes', 'snapshot', 'tasks']; * @param {String} params.consistency - Explicit write consistency setting for the operation * @param {Boolean} params.refresh - Refresh the index after performing the operation * @param {String} params.routing - Specific routing value - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String} params.type - Default document type for items which don't provide one * @param {String, String[], Boolean} params.fields - Default comma-separated list of fields to return in the response for updates * @param {String} params.index - Default index for items which don't provide one @@ -87,7 +87,7 @@ api.cat = namespace(); * * @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 {DurationString} 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 @@ -135,7 +135,7 @@ api.cat.prototype.aliases = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.bytes - The unit in which to display byte values * @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 {DurationString} 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 @@ -191,7 +191,7 @@ api.cat.prototype.allocation = ca({ * * @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 {DurationString} 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 @@ -239,7 +239,7 @@ api.cat.prototype.count = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.bytes - The unit in which to display byte values * @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 {DurationString} 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 @@ -298,7 +298,7 @@ api.cat.prototype.fielddata = ca({ * * @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 {DurationString} 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.ts=true] - Set to false to disable timestamping @@ -358,7 +358,7 @@ api.cat.prototype.help = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.bytes - The unit in which to display byte values * @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 {DurationString} 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.pri - Set to true to return stats only for primary shards @@ -419,7 +419,7 @@ api.cat.prototype.indices = ca({ * * @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 {DurationString} 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 @@ -455,7 +455,7 @@ api.cat.prototype.master = ca({ * * @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 {DurationString} 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 @@ -491,7 +491,7 @@ api.cat.prototype.nodeattrs = ca({ * * @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 {DurationString} 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 @@ -527,7 +527,7 @@ api.cat.prototype.nodes = ca({ * * @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 {DurationString} 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 @@ -563,7 +563,7 @@ api.cat.prototype.pendingTasks = ca({ * * @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 {DurationString} 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 @@ -599,7 +599,7 @@ api.cat.prototype.plugins = ca({ * * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.bytes - The unit in which to display byte values - * @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} 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 @@ -652,7 +652,7 @@ api.cat.prototype.recovery = ca({ * * @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 {DurationString} 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 @@ -727,7 +727,7 @@ api.cat.prototype.segments = ca({ * * @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 {DurationString} 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 @@ -774,7 +774,7 @@ api.cat.prototype.shards = ca({ * * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.ignoreUnavailable - Set to true to ignore unavailable snapshots - * @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} 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 @@ -818,7 +818,7 @@ api.cat.prototype.snapshots = ca({ * * @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 {DurationString} 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 @@ -885,8 +885,8 @@ api.cluster = namespace(); * * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) - * @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout */ api.cluster.prototype.getSettings = ca({ params: { @@ -913,8 +913,8 @@ api.cluster.prototype.getSettings = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} [params.level=cluster] - Specify the level of detail for returned information * @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 {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout * @param {Number} params.waitForActiveShards - Wait until the specified number of shards is active * @param {String} params.waitForNodes - Wait until the specified number of nodes is available * @param {Number} params.waitForRelocatingShards - Wait until the specified number of relocating shards is finished @@ -985,7 +985,7 @@ api.cluster.prototype.health = ca({ * * @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 - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master */ api.cluster.prototype.pendingTasks = ca({ params: { @@ -1007,8 +1007,8 @@ api.cluster.prototype.pendingTasks = ca({ * * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) - * @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout */ api.cluster.prototype.putSettings = ca({ params: { @@ -1037,8 +1037,8 @@ api.cluster.prototype.putSettings = ca({ * @param {Boolean} params.dryRun - Simulate the operation only and return the resulting state * @param {Boolean} params.explain - Return an explanation of why the commands can or cannot be executed * @param {String, String[], Boolean} params.metric - Limit the information returned to the specified metrics. Defaults to all but metadata - * @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout */ api.cluster.prototype.reroute = ca({ params: { @@ -1080,7 +1080,7 @@ api.cluster.prototype.reroute = ca({ * * @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 - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) @@ -1173,7 +1173,7 @@ api.cluster.prototype.state = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) * @param {Boolean} params.human - Whether to return time and byte values in human-readable format. - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String, String[], Boolean} params.nodeId - A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes */ api.cluster.prototype.stats = ca({ @@ -1417,7 +1417,7 @@ api.countPercolate = ca({ * @param {String} params.parent - ID of parent document * @param {Boolean} params.refresh - Refresh the index after performing the operation * @param {String} params.routing - Specific routing value - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {Number} params.version - Explicit version number for concurrency control * @param {String} params.versionType - Specific version type * @param {String} params.id - The document ID @@ -1990,8 +1990,8 @@ api.getTemplate = ca({ * @param {String} params.parent - ID of the parent document * @param {Boolean} params.refresh - Refresh the index after performing the operation * @param {String} params.routing - Specific routing value - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.timestamp - Explicit timestamp for the document + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.timestamp - Explicit timestamp for the document * @param {Duration} params.ttl - Expiration time for the document * @param {Number} params.version - Explicit version number for concurrency control * @param {String} params.versionType - Specific version type @@ -2246,8 +2246,8 @@ api.indices.prototype.clearCache = ca({ * Perform a [indices.close](http://www.elastic.co/guide/en/elasticsearch/reference/2.3/indices-open-close.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) * @param {String} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both. @@ -2297,8 +2297,8 @@ api.indices.prototype.close = ca({ * Perform a [indices.create](http://www.elastic.co/guide/en/elasticsearch/reference/2.3/indices-create-index.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.updateAllTypes - Whether to update the mapping for all fields with the same name across all types or not * @param {String} params.index - The name of the index */ @@ -2331,8 +2331,8 @@ api.indices.prototype.create = ca({ * Perform a [indices.delete](http://www.elastic.co/guide/en/elasticsearch/reference/2.3/indices-delete-index.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String, String[], Boolean} params.index - A comma-separated list of indices to delete; use `_all` or `*` string to delete all indices */ api.indices.prototype['delete'] = ca({ @@ -2360,8 +2360,8 @@ api.indices.prototype['delete'] = ca({ * Perform a [indices.deleteAlias](http://www.elastic.co/guide/en/elasticsearch/reference/2.3/indices-aliases.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit timestamp for the document - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit timestamp for the document + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String, String[], Boolean} params.index - A comma-separated list of index names (supports wildcards); use `_all` for all indices * @param {String, String[], Boolean} params.name - A comma-separated list of aliases to delete (supports wildcards); use `_all` to delete all aliases for the specified indices. */ @@ -2393,8 +2393,8 @@ api.indices.prototype.deleteAlias = ca({ * Perform a [indices.deleteTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/2.3/indices-templates.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String} params.name - The name of the template */ api.indices.prototype.deleteTemplate = ca({ @@ -2422,7 +2422,7 @@ api.indices.prototype.deleteTemplate = ca({ * Perform a [indices.deleteWarmer](http://www.elastic.co/guide/en/elasticsearch/reference/2.3/indices-warmers.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String, String[], Boolean} params.name - A comma-separated list of warmer names to delete (supports wildcards); use `_all` to delete all warmers in the specified indices. You must specify a name either in the uri or in the parameters. * @param {String, String[], Boolean} params.index - A comma-separated list of index names to delete warmers from (supports wildcards); use `_all` to perform the operation on all indices. */ @@ -2571,7 +2571,7 @@ api.indices.prototype.existsAlias = ca({ * Perform a [indices.existsTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/2.3/indices-templates.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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false) * @param {String} params.name - The name of the template */ @@ -2968,7 +2968,7 @@ api.indices.prototype.getAlias = ca({ * Perform a [indices.getAliases](http://www.elastic.co/guide/en/elasticsearch/reference/2.3/indices-aliases.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false) * @param {String, String[], Boolean} params.index - A comma-separated list of index names to filter aliases * @param {String, String[], Boolean} params.name - A comma-separated list of alias names to filter @@ -3264,7 +3264,7 @@ api.indices.prototype.getSettings = ca({ * * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) - * @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false) * @param {String, String[], Boolean} params.name - The comma separated names of the index templates */ @@ -3437,8 +3437,8 @@ api.indices.prototype.getWarmer = ca({ * Perform a [indices.open](http://www.elastic.co/guide/en/elasticsearch/reference/2.3/indices-open-close.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) * @param {String} [params.expandWildcards=closed] - Whether to expand wildcard expression to concrete indices that are open, closed or both. @@ -3558,8 +3558,8 @@ api.indices.prototype.optimize = ca({ * Perform a [indices.putAlias](http://www.elastic.co/guide/en/elasticsearch/reference/2.3/indices-aliases.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit timestamp for the document - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit timestamp for the document + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String, String[], Boolean} params.index - A comma-separated list of index names the alias should point to (supports wildcards); use `_all` to perform the operation on all indices. * @param {String} params.name - The name of the alias to be created or updated */ @@ -3591,8 +3591,8 @@ api.indices.prototype.putAlias = ca({ * Perform a [indices.putMapping](http://www.elastic.co/guide/en/elasticsearch/reference/2.3/indices-put-mapping.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) * @param {String} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both. @@ -3662,7 +3662,7 @@ api.indices.prototype.putMapping = ca({ * Perform a [indices.putSettings](http://www.elastic.co/guide/en/elasticsearch/reference/2.3/indices-update-settings.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) * @param {String} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both. @@ -3722,8 +3722,8 @@ api.indices.prototype.putSettings = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {Number} params.order - The order for this template when merging multiple matching ones (higher numbers are merged later, overriding the lower numbers) * @param {Boolean} params.create - Whether the index template should only be added if new or can also replace an existing one - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) * @param {String} params.name - The name of the template */ @@ -3764,7 +3764,7 @@ api.indices.prototype.putTemplate = ca({ * Perform a [indices.putWarmer](http://www.elastic.co/guide/en/elasticsearch/reference/2.3/indices-warmers.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) in the search request to warm * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices in the search request to warm. (This includes `_all` string or when no indices have been specified) * @param {String} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both, in the search request to warm. @@ -4181,8 +4181,8 @@ api.indices.prototype.stats = ca({ * Perform a [indices.updateAliases](http://www.elastic.co/guide/en/elasticsearch/reference/2.3/indices-aliases.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Request timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Request timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master */ api.indices.prototype.updateAliases = ca({ params: { @@ -4677,12 +4677,12 @@ api.nodes = namespace(); * Perform a [nodes.hotThreads](http://www.elastic.co/guide/en/elasticsearch/reference/2.3/cluster-nodes-hot-threads.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.interval - The interval for the second sampling of threads + * @param {DurationString} params.interval - The interval for the second sampling of threads * @param {Number} params.snapshots - Number of samples of thread stacktrace (default: 10) * @param {Number} params.threads - Specify the number of threads to provide information for (default: 3) * @param {Boolean} params.ignoreIdleThreads - Don't show threads that are in known-idle places, such as waiting on a socket select or pulling from an empty task queue (default: true) * @param {String} params.type - The type to sample (default: cpu) - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String, String[], Boolean} params.nodeId - A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes */ api.nodes.prototype.hotThreads = ca({ @@ -4733,7 +4733,7 @@ api.nodes.prototype.hotThreads = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) * @param {Boolean} params.human - Whether to return time and byte values in human-readable format. - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String, String[], Boolean} params.nodeId - A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes * @param {String, String[], Boolean} params.metric - A comma-separated list of metrics you wish returned. Leave empty to return all. */ @@ -4816,7 +4816,7 @@ api.nodes.prototype.info = ca({ * @param {Boolean} params.human - Whether to return time and byte values in human-readable format. * @param {String} [params.level=node] - Return indices stats aggregated at node, index or shard level * @param {String, String[], Boolean} params.types - A comma-separated list of document types for the `indexing` index metric - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String, String[], Boolean} params.metric - Limit the information returned to the specified metrics * @param {String, String[], Boolean} params.indexMetric - Limit the information returned for `indices` metric to the specific index metrics. Isn't used if `indices` (or `all`) metric isn't specified. * @param {String, String[], Boolean} params.nodeId - A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes @@ -5230,7 +5230,7 @@ api.putTemplate = ca({ * * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.refresh - Should the effected indexes be refreshed? - * @param {Date, Number} [params.timeout=1m] - Time each individual bulk request should wait for shards that are unavailable. + * @param {DurationString} [params.timeout=1m] - Time each individual bulk request should wait for shards that are unavailable. * @param {String} params.consistency - Explicit write consistency setting for the operation * @param {Boolean} params.waitForCompletion - Should the request should block until the reindex is complete. */ @@ -5354,7 +5354,7 @@ api.scroll = ca({ * @param {String} [params.suggestMode=missing] - Specify suggest mode * @param {Number} params.suggestSize - How many suggestions to return in response * @param {Text} params.suggestText - The source text for which the suggestions should be returned - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {Boolean} params.trackScores - Whether to calculate and return scores even if they are not used for sorting * @param {Boolean} params.version - Specify whether to return document version as part of a hit * @param {Boolean} params.requestCache - Specify if request cache should be used for this request or not, defaults to index level setting @@ -5800,7 +5800,7 @@ api.snapshot = namespace(); * Perform a [snapshot.create](http://www.elastic.co/guide/en/elasticsearch/reference/2.3/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {Boolean} params.waitForCompletion - Should this request wait until the operation has completed before returning * @param {String} params.repository - A repository name * @param {String} params.snapshot - A snapshot name @@ -5835,8 +5835,8 @@ api.snapshot.prototype.create = ca({ * Perform a [snapshot.createRepository](http://www.elastic.co/guide/en/elasticsearch/reference/2.3/modules-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 {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout * @param {Boolean} params.verify - Whether to verify the repository after creation * @param {String} params.repository - A repository name */ @@ -5869,7 +5869,7 @@ api.snapshot.prototype.createRepository = ca({ * Perform a [snapshot.delete](http://www.elastic.co/guide/en/elasticsearch/reference/2.3/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {String} params.repository - A repository name * @param {String} params.snapshot - A snapshot name */ @@ -5898,8 +5898,8 @@ api.snapshot.prototype['delete'] = ca({ * Perform a [snapshot.deleteRepository](http://www.elastic.co/guide/en/elasticsearch/reference/2.3/modules-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 {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String, String[], Boolean} params.repository - A comma-separated list of repository names */ api.snapshot.prototype.deleteRepository = ca({ @@ -5927,7 +5927,7 @@ api.snapshot.prototype.deleteRepository = ca({ * Perform a [snapshot.get](http://www.elastic.co/guide/en/elasticsearch/reference/2.3/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {String} params.repository - A repository name * @param {String, String[], Boolean} params.snapshot - A comma-separated list of snapshot names */ @@ -5955,7 +5955,7 @@ api.snapshot.prototype.get = ca({ * Perform a [snapshot.getRepository](http://www.elastic.co/guide/en/elasticsearch/reference/2.3/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false) * @param {String, String[], Boolean} params.repository - A comma-separated list of repository names */ @@ -5988,7 +5988,7 @@ api.snapshot.prototype.getRepository = ca({ * Perform a [snapshot.restore](http://www.elastic.co/guide/en/elasticsearch/reference/2.3/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {Boolean} params.waitForCompletion - Should this request wait until the operation has completed before returning * @param {String} params.repository - A repository name * @param {String} params.snapshot - A snapshot name @@ -6023,7 +6023,7 @@ api.snapshot.prototype.restore = ca({ * Perform a [snapshot.status](http://www.elastic.co/guide/en/elasticsearch/reference/2.3/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {String} params.repository - A repository name * @param {String, String[], Boolean} params.snapshot - A comma-separated list of snapshot names */ @@ -6064,8 +6064,8 @@ api.snapshot.prototype.status = ca({ * Perform a [snapshot.verifyRepository](http://www.elastic.co/guide/en/elasticsearch/reference/2.3/modules-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 {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String} params.repository - A repository name */ api.snapshot.prototype.verifyRepository = ca({ @@ -6376,8 +6376,8 @@ api.termvectors = ca({ * @param {Anything} params.script - The URL-encoded script definition (instead of using request body) * @param {Anything} params.scriptId - The id of a stored script * @param {Boolean} params.scriptedUpsert - True if the script referenced in script or script_id should be called to perform inserts - defaults to false - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.timestamp - Explicit timestamp for the document + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.timestamp - Explicit timestamp for the document * @param {Duration} params.ttl - Expiration time for the document * @param {Number} params.version - Explicit version number for concurrency control * @param {String} params.versionType - Specific version type @@ -6483,7 +6483,7 @@ api.update = ca({ * @param {String, String[], Boolean} params.routing - A comma-separated list of specific routing values * @param {Duration} params.scroll - Specify how long a consistent view of the index should be maintained for scrolled search * @param {String} params.searchType - Search operation type - * @param {Date, Number} params.searchTimeout - Explicit timeout for each search request. Defaults to no timeout. + * @param {DurationString} params.searchTimeout - Explicit timeout for each search request. Defaults to no timeout. * @param {Number} params.size - Number of hits to return (default: 10) * @param {String, String[], Boolean} params.sort - A comma-separated list of : pairs * @param {String, String[], Boolean} params._source - True or false to return the _source field or not, or a list of fields to return @@ -6495,7 +6495,7 @@ api.update = ca({ * @param {String} [params.suggestMode=missing] - Specify suggest mode * @param {Number} params.suggestSize - How many suggestions to return in response * @param {Text} params.suggestText - The source text for which the suggestions should be returned - * @param {Date, Number} [params.timeout=1m] - Time each individual bulk request should wait for shards that are unavailable. + * @param {DurationString} [params.timeout=1m] - Time each individual bulk request should wait for shards that are unavailable. * @param {Boolean} params.trackScores - Whether to calculate and return scores even if they are not used for sorting * @param {Boolean} params.version - Specify whether to return document version as part of a hit * @param {Boolean} params.versionType - Should the document increment the version number (internal) on hit or not (reindex) @@ -6717,8 +6717,8 @@ api.updateByQuery = ca({ * @param {String} params.parent - ID of the parent document * @param {Boolean} params.refresh - Refresh the index after performing the operation * @param {String} params.routing - Specific routing value - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.timestamp - Explicit timestamp for the document + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.timestamp - Explicit timestamp for the document * @param {Duration} params.ttl - Expiration time for the document * @param {Number} params.version - Explicit version number for concurrency control * @param {String} params.versionType - Specific version type diff --git a/src/lib/apis/2_4.js b/src/lib/apis/2_4.js index 63261cf65..e65eb0569 100644 --- a/src/lib/apis/2_4.js +++ b/src/lib/apis/2_4.js @@ -20,7 +20,7 @@ api._namespaces = ['cat', 'cluster', 'indices', 'nodes', 'snapshot', 'tasks']; * @param {String} params.consistency - Explicit write consistency setting for the operation * @param {Boolean} params.refresh - Refresh the index after performing the operation * @param {String} params.routing - Specific routing value - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String} params.type - Default document type for items which don't provide one * @param {String, String[], Boolean} params.fields - Default comma-separated list of fields to return in the response for updates * @param {String} params.index - Default index for items which don't provide one @@ -87,7 +87,7 @@ api.cat = namespace(); * * @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 {DurationString} 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 @@ -135,7 +135,7 @@ api.cat.prototype.aliases = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.bytes - The unit in which to display byte values * @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 {DurationString} 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 @@ -191,7 +191,7 @@ api.cat.prototype.allocation = ca({ * * @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 {DurationString} 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 @@ -239,7 +239,7 @@ api.cat.prototype.count = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.bytes - The unit in which to display byte values * @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 {DurationString} 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 @@ -298,7 +298,7 @@ api.cat.prototype.fielddata = ca({ * * @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 {DurationString} 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.ts=true] - Set to false to disable timestamping @@ -358,7 +358,7 @@ api.cat.prototype.help = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.bytes - The unit in which to display byte values * @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 {DurationString} 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.pri - Set to true to return stats only for primary shards @@ -419,7 +419,7 @@ api.cat.prototype.indices = ca({ * * @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 {DurationString} 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 @@ -455,7 +455,7 @@ api.cat.prototype.master = ca({ * * @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 {DurationString} 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 @@ -491,7 +491,7 @@ api.cat.prototype.nodeattrs = ca({ * * @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 {DurationString} 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 @@ -527,7 +527,7 @@ api.cat.prototype.nodes = ca({ * * @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 {DurationString} 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 @@ -563,7 +563,7 @@ api.cat.prototype.pendingTasks = ca({ * * @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 {DurationString} 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 @@ -599,7 +599,7 @@ api.cat.prototype.plugins = ca({ * * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.bytes - The unit in which to display byte values - * @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} 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 @@ -652,7 +652,7 @@ api.cat.prototype.recovery = ca({ * * @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 {DurationString} 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 @@ -727,7 +727,7 @@ api.cat.prototype.segments = ca({ * * @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 {DurationString} 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 @@ -774,7 +774,7 @@ api.cat.prototype.shards = ca({ * * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.ignoreUnavailable - Set to true to ignore unavailable snapshots - * @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} 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 @@ -818,7 +818,7 @@ api.cat.prototype.snapshots = ca({ * * @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 {DurationString} 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 @@ -885,8 +885,8 @@ api.cluster = namespace(); * * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) - * @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout */ api.cluster.prototype.getSettings = ca({ params: { @@ -913,8 +913,8 @@ api.cluster.prototype.getSettings = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} [params.level=cluster] - Specify the level of detail for returned information * @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 {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout * @param {Number} params.waitForActiveShards - Wait until the specified number of shards is active * @param {String} params.waitForNodes - Wait until the specified number of nodes is available * @param {Number} params.waitForRelocatingShards - Wait until the specified number of relocating shards is finished @@ -985,7 +985,7 @@ api.cluster.prototype.health = ca({ * * @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 - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master */ api.cluster.prototype.pendingTasks = ca({ params: { @@ -1007,8 +1007,8 @@ api.cluster.prototype.pendingTasks = ca({ * * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) - * @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout */ api.cluster.prototype.putSettings = ca({ params: { @@ -1037,8 +1037,8 @@ api.cluster.prototype.putSettings = ca({ * @param {Boolean} params.dryRun - Simulate the operation only and return the resulting state * @param {Boolean} params.explain - Return an explanation of why the commands can or cannot be executed * @param {String, String[], Boolean} params.metric - Limit the information returned to the specified metrics. Defaults to all but metadata - * @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout */ api.cluster.prototype.reroute = ca({ params: { @@ -1080,7 +1080,7 @@ api.cluster.prototype.reroute = ca({ * * @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 - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) @@ -1173,7 +1173,7 @@ api.cluster.prototype.state = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) * @param {Boolean} params.human - Whether to return time and byte values in human-readable format. - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String, String[], Boolean} params.nodeId - A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes */ api.cluster.prototype.stats = ca({ @@ -1417,7 +1417,7 @@ api.countPercolate = ca({ * @param {String} params.parent - ID of parent document * @param {Boolean} params.refresh - Refresh the index after performing the operation * @param {String} params.routing - Specific routing value - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {Number} params.version - Explicit version number for concurrency control * @param {String} params.versionType - Specific version type * @param {String} params.id - The document ID @@ -1990,9 +1990,9 @@ api.getTemplate = ca({ * @param {String} params.parent - ID of the parent document * @param {Boolean} params.refresh - Refresh the affected shards after performing the operation * @param {String} params.routing - Specific routing value - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.timestamp - Explicit timestamp for the document - * @param {Date, Number} params.ttl - Expiration time for the document + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.timestamp - Explicit timestamp for the document + * @param {DurationString} params.ttl - Expiration time for the document * @param {Number} params.version - Explicit version number for concurrency control * @param {String} params.versionType - Specific version type * @param {String} params.id - Document ID @@ -2246,8 +2246,8 @@ api.indices.prototype.clearCache = ca({ * Perform a [indices.close](https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-open-close.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) * @param {String} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both. @@ -2297,8 +2297,8 @@ api.indices.prototype.close = ca({ * Perform a [indices.create](https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-create-index.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.updateAllTypes - Whether to update the mapping for all fields with the same name across all types or not * @param {String} params.index - The name of the index */ @@ -2331,8 +2331,8 @@ api.indices.prototype.create = ca({ * Perform a [indices.delete](https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-delete-index.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String, String[], Boolean} params.index - A comma-separated list of indices to delete; use `_all` or `*` string to delete all indices */ api.indices.prototype['delete'] = ca({ @@ -2360,8 +2360,8 @@ api.indices.prototype['delete'] = ca({ * Perform a [indices.deleteAlias](https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-aliases.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit timestamp for the document - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit timestamp for the document + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String, String[], Boolean} params.index - A comma-separated list of index names (supports wildcards); use `_all` for all indices * @param {String, String[], Boolean} params.name - A comma-separated list of aliases to delete (supports wildcards); use `_all` to delete all aliases for the specified indices. */ @@ -2393,8 +2393,8 @@ api.indices.prototype.deleteAlias = ca({ * Perform a [indices.deleteTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-templates.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String} params.name - The name of the template */ api.indices.prototype.deleteTemplate = ca({ @@ -2422,7 +2422,7 @@ api.indices.prototype.deleteTemplate = ca({ * Perform a [indices.deleteWarmer](https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-warmers.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String, String[], Boolean} params.name - A comma-separated list of warmer names to delete (supports wildcards); use `_all` to delete all warmers in the specified indices. You must specify a name either in the uri or in the parameters. * @param {String, String[], Boolean} params.index - A comma-separated list of index names to delete warmers from (supports wildcards); use `_all` to perform the operation on all indices. */ @@ -2571,7 +2571,7 @@ api.indices.prototype.existsAlias = ca({ * Perform a [indices.existsTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-templates.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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false) * @param {String} params.name - The name of the template */ @@ -2968,7 +2968,7 @@ api.indices.prototype.getAlias = ca({ * Perform a [indices.getAliases](https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-aliases.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false) * @param {String, String[], Boolean} params.index - A comma-separated list of index names to filter aliases * @param {String, String[], Boolean} params.name - A comma-separated list of alias names to filter @@ -3264,7 +3264,7 @@ api.indices.prototype.getSettings = ca({ * * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) - * @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false) * @param {String, String[], Boolean} params.name - The comma separated names of the index templates */ @@ -3437,8 +3437,8 @@ api.indices.prototype.getWarmer = ca({ * Perform a [indices.open](https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-open-close.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) * @param {String} [params.expandWildcards=closed] - Whether to expand wildcard expression to concrete indices that are open, closed or both. @@ -3558,8 +3558,8 @@ api.indices.prototype.optimize = ca({ * Perform a [indices.putAlias](https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-aliases.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit timestamp for the document - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit timestamp for the document + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String, String[], Boolean} params.index - A comma-separated list of index names the alias should point to (supports wildcards); use `_all` to perform the operation on all indices. * @param {String} params.name - The name of the alias to be created or updated */ @@ -3591,8 +3591,8 @@ api.indices.prototype.putAlias = ca({ * Perform a [indices.putMapping](https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-put-mapping.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) * @param {String} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both. @@ -3662,7 +3662,7 @@ api.indices.prototype.putMapping = ca({ * Perform a [indices.putSettings](https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-update-settings.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) * @param {String} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both. @@ -3722,8 +3722,8 @@ api.indices.prototype.putSettings = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {Number} params.order - The order for this template when merging multiple matching ones (higher numbers are merged later, overriding the lower numbers) * @param {Boolean} params.create - Whether the index template should only be added if new or can also replace an existing one - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) * @param {String} params.name - The name of the template */ @@ -3764,7 +3764,7 @@ api.indices.prototype.putTemplate = ca({ * Perform a [indices.putWarmer](https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-warmers.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) in the search request to warm * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices in the search request to warm. (This includes `_all` string or when no indices have been specified) * @param {String} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both, in the search request to warm. @@ -4181,8 +4181,8 @@ api.indices.prototype.stats = ca({ * Perform a [indices.updateAliases](https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-aliases.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Request timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Request timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master */ api.indices.prototype.updateAliases = ca({ params: { @@ -4681,12 +4681,12 @@ api.nodes = namespace(); * Perform a [nodes.hotThreads](https://www.elastic.co/guide/en/elasticsearch/reference/2.4/cluster-nodes-hot-threads.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.interval - The interval for the second sampling of threads + * @param {DurationString} params.interval - The interval for the second sampling of threads * @param {Number} params.snapshots - Number of samples of thread stacktrace (default: 10) * @param {Number} params.threads - Specify the number of threads to provide information for (default: 3) * @param {Boolean} params.ignoreIdleThreads - Don't show threads that are in known-idle places, such as waiting on a socket select or pulling from an empty task queue (default: true) * @param {String} params.type - The type to sample (default: cpu) - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String, String[], Boolean} params.nodeId - A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes */ api.nodes.prototype.hotThreads = ca({ @@ -4737,7 +4737,7 @@ api.nodes.prototype.hotThreads = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) * @param {Boolean} params.human - Whether to return time and byte values in human-readable format. - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String, String[], Boolean} params.nodeId - A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes * @param {String, String[], Boolean} params.metric - A comma-separated list of metrics you wish returned. Leave empty to return all. */ @@ -4820,7 +4820,7 @@ api.nodes.prototype.info = ca({ * @param {Boolean} params.human - Whether to return time and byte values in human-readable format. * @param {String} [params.level=node] - Return indices stats aggregated at node, index or shard level * @param {String, String[], Boolean} params.types - A comma-separated list of document types for the `indexing` index metric - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String, String[], Boolean} params.metric - Limit the information returned to the specified metrics * @param {String, String[], Boolean} params.indexMetric - Limit the information returned for `indices` metric to the specific index metrics. Isn't used if `indices` (or `all`) metric isn't specified. * @param {String, String[], Boolean} params.nodeId - A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes @@ -5234,7 +5234,7 @@ api.putTemplate = ca({ * * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.refresh - Should the effected indexes be refreshed? - * @param {Date, Number} [params.timeout=1m] - Time each individual bulk request should wait for shards that are unavailable. + * @param {DurationString} [params.timeout=1m] - Time each individual bulk request should wait for shards that are unavailable. * @param {String} params.consistency - Explicit write consistency setting for the operation * @param {Boolean} params.waitForCompletion - Should the request should block until the reindex is complete. * @param {Number} params.requestsPerSecond - The throttle for this request in sub-requests per second. 0 means set no throttle. @@ -5327,7 +5327,7 @@ api.renderSearchTemplate = ca({ * Perform a [scroll](https://www.elastic.co/guide/en/elasticsearch/reference/2.4/search-request-scroll.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.scroll - Specify how long a consistent view of the index should be maintained for scrolled search + * @param {DurationString} params.scroll - Specify how long a consistent view of the index should be maintained for scrolled search * @param {String} params.scrollId - The scroll ID */ api.scroll = ca({ @@ -5377,7 +5377,7 @@ api.scroll = ca({ * @param {String} params.preference - Specify the node or shard the operation should be performed on (default: random) * @param {String} params.q - Query in the Lucene query string syntax * @param {String, String[], Boolean} params.routing - A comma-separated list of specific routing values - * @param {Date, Number} params.scroll - Specify how long a consistent view of the index should be maintained for scrolled search + * @param {DurationString} params.scroll - Specify how long a consistent view of the index should be maintained for scrolled search * @param {String} params.searchType - Search operation type * @param {Number} params.size - Number of hits to return (default: 10) * @param {String, String[], Boolean} params.sort - A comma-separated list of : pairs @@ -5390,7 +5390,7 @@ api.scroll = ca({ * @param {String} [params.suggestMode=missing] - Specify suggest mode * @param {Number} params.suggestSize - How many suggestions to return in response * @param {String} params.suggestText - The source text for which the suggestions should be returned - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {Boolean} params.trackScores - Whether to calculate and return scores even if they are not used for sorting * @param {Boolean} params.version - Specify whether to return document version as part of a hit * @param {Boolean} params.requestCache - Specify if request cache should be used for this request or not, defaults to index level setting @@ -5755,7 +5755,7 @@ api.searchShards = ca({ * @param {String} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both. * @param {String} params.preference - Specify the node or shard the operation should be performed on (default: random) * @param {String, String[], Boolean} params.routing - A comma-separated list of specific routing values - * @param {Date, Number} params.scroll - Specify how long a consistent view of the index should be maintained for scrolled search + * @param {DurationString} params.scroll - Specify how long a consistent view of the index should be maintained for scrolled search * @param {String} params.searchType - Search operation type * @param {String, String[], Boolean} params.index - A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices * @param {String, String[], Boolean} params.type - A comma-separated list of document types to search; leave empty to perform the operation on all types @@ -5836,7 +5836,7 @@ api.snapshot = namespace(); * Perform a [snapshot.create](https://www.elastic.co/guide/en/elasticsearch/reference/2.4/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {Boolean} params.waitForCompletion - Should this request wait until the operation has completed before returning * @param {String} params.repository - A repository name * @param {String} params.snapshot - A snapshot name @@ -5871,8 +5871,8 @@ api.snapshot.prototype.create = ca({ * Perform a [snapshot.createRepository](https://www.elastic.co/guide/en/elasticsearch/reference/2.4/modules-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 {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout * @param {Boolean} params.verify - Whether to verify the repository after creation * @param {String} params.repository - A repository name */ @@ -5905,7 +5905,7 @@ api.snapshot.prototype.createRepository = ca({ * Perform a [snapshot.delete](https://www.elastic.co/guide/en/elasticsearch/reference/2.4/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {String} params.repository - A repository name * @param {String} params.snapshot - A snapshot name */ @@ -5934,8 +5934,8 @@ api.snapshot.prototype['delete'] = ca({ * Perform a [snapshot.deleteRepository](https://www.elastic.co/guide/en/elasticsearch/reference/2.4/modules-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 {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String, String[], Boolean} params.repository - A comma-separated list of repository names */ api.snapshot.prototype.deleteRepository = ca({ @@ -5963,7 +5963,7 @@ api.snapshot.prototype.deleteRepository = ca({ * Perform a [snapshot.get](https://www.elastic.co/guide/en/elasticsearch/reference/2.4/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {String} params.repository - A repository name * @param {String, String[], Boolean} params.snapshot - A comma-separated list of snapshot names */ @@ -5991,7 +5991,7 @@ api.snapshot.prototype.get = ca({ * Perform a [snapshot.getRepository](https://www.elastic.co/guide/en/elasticsearch/reference/2.4/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false) * @param {String, String[], Boolean} params.repository - A comma-separated list of repository names */ @@ -6024,7 +6024,7 @@ api.snapshot.prototype.getRepository = ca({ * Perform a [snapshot.restore](https://www.elastic.co/guide/en/elasticsearch/reference/2.4/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {Boolean} params.waitForCompletion - Should this request wait until the operation has completed before returning * @param {String} params.repository - A repository name * @param {String} params.snapshot - A snapshot name @@ -6059,7 +6059,7 @@ api.snapshot.prototype.restore = ca({ * Perform a [snapshot.status](https://www.elastic.co/guide/en/elasticsearch/reference/2.4/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {String} params.repository - A repository name * @param {String, String[], Boolean} params.snapshot - A comma-separated list of snapshot names */ @@ -6100,8 +6100,8 @@ api.snapshot.prototype.status = ca({ * Perform a [snapshot.verifyRepository](https://www.elastic.co/guide/en/elasticsearch/reference/2.4/modules-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 {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String} params.repository - A repository name */ api.snapshot.prototype.verifyRepository = ca({ @@ -6412,9 +6412,9 @@ api.termvectors = ca({ * @param {String} params.script - The URL-encoded script definition (instead of using request body) * @param {String} params.scriptId - The id of a stored script * @param {Boolean} params.scriptedUpsert - True if the script referenced in script or script_id should be called to perform inserts - defaults to false - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.timestamp - Explicit timestamp for the document - * @param {Date, Number} params.ttl - Expiration time for the document + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.timestamp - Explicit timestamp for the document + * @param {DurationString} params.ttl - Expiration time for the document * @param {Number} params.version - Explicit version number for concurrency control * @param {String} params.versionType - Specific version type * @param {String} params.id - Document ID @@ -6520,9 +6520,9 @@ api.update = ca({ * @param {String} params.preference - Specify the node or shard the operation should be performed on (default: random) * @param {String} params.q - Query in the Lucene query string syntax * @param {String, String[], Boolean} params.routing - A comma-separated list of specific routing values - * @param {Date, Number} params.scroll - Specify how long a consistent view of the index should be maintained for scrolled search + * @param {DurationString} params.scroll - Specify how long a consistent view of the index should be maintained for scrolled search * @param {String} params.searchType - Search operation type - * @param {Date, Number} params.searchTimeout - Explicit timeout for each search request. Defaults to no timeout. + * @param {DurationString} params.searchTimeout - Explicit timeout for each search request. Defaults to no timeout. * @param {Number} params.size - Number of hits to return (default: 10) * @param {String, String[], Boolean} params.sort - A comma-separated list of : pairs * @param {String, String[], Boolean} params._source - True or false to return the _source field or not, or a list of fields to return @@ -6534,7 +6534,7 @@ api.update = ca({ * @param {String} [params.suggestMode=missing] - Specify suggest mode * @param {Number} params.suggestSize - How many suggestions to return in response * @param {String} params.suggestText - The source text for which the suggestions should be returned - * @param {Date, Number} [params.timeout=1m] - Time each individual bulk request should wait for shards that are unavailable. + * @param {DurationString} [params.timeout=1m] - Time each individual bulk request should wait for shards that are unavailable. * @param {Boolean} params.trackScores - Whether to calculate and return scores even if they are not used for sorting * @param {Boolean} params.version - Specify whether to return document version as part of a hit * @param {Boolean} params.versionType - Should the document increment the version number (internal) on hit or not (reindex) @@ -6762,9 +6762,9 @@ api.updateByQuery = ca({ * @param {String} params.parent - ID of the parent document * @param {Boolean} params.refresh - Refresh the affected shards after performing the operation * @param {String} params.routing - Specific routing value - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.timestamp - Explicit timestamp for the document - * @param {Date, Number} params.ttl - Expiration time for the document + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.timestamp - Explicit timestamp for the document + * @param {DurationString} params.ttl - Expiration time for the document * @param {Number} params.version - Explicit version number for concurrency control * @param {String} params.versionType - Specific version type * @param {String} params.id - Document ID diff --git a/src/lib/apis/5_0.js b/src/lib/apis/5_0.js index 17d0b05fa..c9a9bb7d4 100644 --- a/src/lib/apis/5_0.js +++ b/src/lib/apis/5_0.js @@ -20,7 +20,7 @@ api._namespaces = ['cat', 'cluster', 'indices', 'ingest', 'nodes', 'snapshot', ' * @param {String} params.waitForActiveShards - Sets the number of shard copies that must be active before proceeding with the bulk operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1) * @param {String} params.refresh - If `true` then refresh the effected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes. * @param {String} params.routing - Specific routing value - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String} params.type - Default document type for items which don't provide one * @param {String, String[], Boolean} params.fields - Default comma-separated list of fields to return in the response for updates, can be overridden on each sub-request * @param {String, String[], Boolean} params._source - True or false to return the _source field or not, or default list of fields to return, can be overridden on each sub-request @@ -108,7 +108,7 @@ api.cat = namespace(); * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.format - a short version of the Accept header, e.g. json, yaml * @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 {DurationString} 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 @@ -160,7 +160,7 @@ api.cat.prototype.aliases = ca({ * @param {String} params.format - a short version of the Accept header, e.g. json, yaml * @param {String} params.bytes - The unit in which to display byte values * @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 {DurationString} 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 @@ -227,7 +227,7 @@ api.cat.prototype.allocation = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.format - a short version of the Accept header, e.g. json, yaml * @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 {DurationString} 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 @@ -279,7 +279,7 @@ api.cat.prototype.count = ca({ * @param {String} params.format - a short version of the Accept header, e.g. json, yaml * @param {String} params.bytes - The unit in which to display byte values * @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 {DurationString} 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 @@ -349,7 +349,7 @@ api.cat.prototype.fielddata = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.format - a short version of the Accept header, e.g. json, yaml * @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 {DurationString} 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.ts=true] - Set to false to disable timestamping @@ -413,7 +413,7 @@ api.cat.prototype.help = ca({ * @param {String} params.format - a short version of the Accept header, e.g. json, yaml * @param {String} params.bytes - The unit in which to display byte values * @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 {DurationString} 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 {String} params.health - A health status ("green", "yellow", or "red" to filter only indices matching the specified health status * @param {Boolean} params.help - Return help information @@ -488,7 +488,7 @@ api.cat.prototype.indices = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.format - a short version of the Accept header, e.g. json, yaml * @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 {DurationString} 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 @@ -528,7 +528,7 @@ api.cat.prototype.master = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.format - a short version of the Accept header, e.g. json, yaml * @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 {DurationString} 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 @@ -569,7 +569,7 @@ api.cat.prototype.nodeattrs = ca({ * @param {String} params.format - a short version of the Accept header, e.g. json, yaml * @param {Boolean} params.fullId - Return the full node ID instead of the shortened version (default: false) * @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 {DurationString} 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 @@ -613,7 +613,7 @@ api.cat.prototype.nodes = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.format - a short version of the Accept header, e.g. json, yaml * @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 {DurationString} 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 @@ -653,7 +653,7 @@ api.cat.prototype.pendingTasks = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.format - a short version of the Accept header, e.g. json, yaml * @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 {DurationString} 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 @@ -693,7 +693,7 @@ api.cat.prototype.plugins = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.format - a short version of the Accept header, e.g. json, yaml * @param {String} params.bytes - The unit in which to display byte values - * @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} 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 @@ -757,7 +757,7 @@ api.cat.prototype.recovery = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.format - a short version of the Accept header, e.g. json, yaml * @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 {DurationString} 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 @@ -840,7 +840,7 @@ api.cat.prototype.segments = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.format - a short version of the Accept header, e.g. json, yaml * @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 {DurationString} 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 @@ -891,7 +891,7 @@ api.cat.prototype.shards = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.format - a short version of the Accept header, e.g. json, yaml * @param {Boolean} params.ignoreUnavailable - Set to true to ignore unavailable snapshots - * @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} 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 @@ -999,7 +999,7 @@ api.cat.prototype.tasks = ca({ * @param {String} params.format - a short version of the Accept header, e.g. json, yaml * @param {String} params.size - The multiplier in which to display values * @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 {DurationString} 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 @@ -1109,8 +1109,8 @@ api.cluster.prototype.allocationExplain = ca({ * * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) - * @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout * @param {Boolean} params.includeDefaults - Whether to return all default clusters setting. */ api.cluster.prototype.getSettings = ca({ @@ -1143,8 +1143,8 @@ api.cluster.prototype.getSettings = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} [params.level=cluster] - Specify the level of detail for returned information * @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 {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String} params.waitForActiveShards - Wait until the specified number of shards is active * @param {String} params.waitForNodes - Wait until the specified number of nodes is available * @param {String} params.waitForEvents - Wait until all currently queued events with the given priority are processed @@ -1228,7 +1228,7 @@ api.cluster.prototype.health = ca({ * * @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 - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master */ api.cluster.prototype.pendingTasks = ca({ params: { @@ -1250,8 +1250,8 @@ api.cluster.prototype.pendingTasks = ca({ * * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) - * @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout */ api.cluster.prototype.putSettings = ca({ params: { @@ -1281,8 +1281,8 @@ api.cluster.prototype.putSettings = ca({ * @param {Boolean} params.explain - Return an explanation of why the commands can or cannot be executed * @param {Boolean} params.retryFailed - Retries allocation of shards that are blocked due to too many subsequent allocation failures * @param {String, String[], Boolean} params.metric - Limit the information returned to the specified metrics. Defaults to all but metadata - * @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout */ api.cluster.prototype.reroute = ca({ params: { @@ -1328,7 +1328,7 @@ api.cluster.prototype.reroute = ca({ * * @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 - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) @@ -1421,7 +1421,7 @@ api.cluster.prototype.state = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) * @param {Boolean} params.human - Whether to return time and byte values in human-readable format. - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String, String[], Boolean} params.nodeId - A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes */ api.cluster.prototype.stats = ca({ @@ -1665,9 +1665,9 @@ api.countPercolate = ca({ * @param {String} params.parent - ID of the parent document * @param {String} params.refresh - If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes. * @param {String} params.routing - Specific routing value - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.timestamp - Explicit timestamp for the document - * @param {Date, Number} params.ttl - Expiration time for the document + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.timestamp - Explicit timestamp for the document + * @param {DurationString} params.ttl - Expiration time for the document * @param {Number} params.version - Explicit version number for concurrency control * @param {String} params.versionType - Specific version type * @param {String} params.pipeline - The pipeline id to preprocess incoming documents with @@ -1748,7 +1748,7 @@ api.create = ca({ * @param {String} params.parent - ID of parent document * @param {String} params.refresh - If `true` then refresh the effected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes. * @param {String} params.routing - Specific routing value - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {Number} params.version - Explicit version number for concurrency control * @param {String} params.versionType - Specific version type * @param {String} params.id - The document ID @@ -1828,9 +1828,9 @@ api['delete'] = ca({ * @param {String} params.preference - Specify the node or shard the operation should be performed on (default: random) * @param {String} params.q - Query in the Lucene query string syntax * @param {String, String[], Boolean} params.routing - A comma-separated list of specific routing values - * @param {Date, Number} params.scroll - Specify how long a consistent view of the index should be maintained for scrolled search + * @param {DurationString} params.scroll - Specify how long a consistent view of the index should be maintained for scrolled search * @param {String} params.searchType - Search operation type - * @param {Date, Number} params.searchTimeout - Explicit timeout for each search request. Defaults to no timeout. + * @param {DurationString} params.searchTimeout - Explicit timeout for each search request. Defaults to no timeout. * @param {Number} params.size - Number of hits to return (default: 10) * @param {String, String[], Boolean} params.sort - A comma-separated list of : pairs * @param {String, String[], Boolean} params._source - True or false to return the _source field or not, or a list of fields to return @@ -1841,7 +1841,7 @@ api['delete'] = ca({ * @param {Boolean} params.version - Specify whether to return document version as part of a hit * @param {Boolean} params.requestCache - Specify if request cache should be used for this request or not, defaults to index level setting * @param {Boolean} params.refresh - Should the effected indexes be refreshed? - * @param {Date, Number} [params.timeout=1m] - Time each individual bulk request should wait for shards that are unavailable. + * @param {DurationString} [params.timeout=1m] - Time each individual bulk request should wait for shards that are unavailable. * @param {String} params.waitForActiveShards - Sets the number of shard copies that must be active before proceeding with the delete by query operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1) * @param {Number} params.scrollSize - Size on the scroll request powering the update_by_query * @param {Boolean} params.waitForCompletion - Should the request should block until the delete-by-query is complete. @@ -2460,9 +2460,9 @@ api.getTemplate = ca({ * @param {String} params.parent - ID of the parent document * @param {String} params.refresh - If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes. * @param {String} params.routing - Specific routing value - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.timestamp - Explicit timestamp for the document - * @param {Date, Number} params.ttl - Expiration time for the document + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.timestamp - Explicit timestamp for the document + * @param {DurationString} params.ttl - Expiration time for the document * @param {Number} params.version - Explicit version number for concurrency control * @param {String} params.versionType - Specific version type * @param {String} params.pipeline - The pipeline id to preprocess incoming documents with @@ -2713,8 +2713,8 @@ api.indices.prototype.clearCache = ca({ * Perform a [indices.close](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-open-close.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) * @param {String} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both. @@ -2765,8 +2765,8 @@ api.indices.prototype.close = ca({ * * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.waitForActiveShards - Set the number of active shards to wait for before the operation returns. - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.updateAllTypes - Whether to update the mapping for all fields with the same name across all types or not * @param {String} params.index - The name of the index */ @@ -2803,8 +2803,8 @@ api.indices.prototype.create = ca({ * Perform a [indices.delete](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-delete-index.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String, String[], Boolean} params.index - A comma-separated list of indices to delete; use `_all` or `*` string to delete all indices */ api.indices.prototype['delete'] = ca({ @@ -2832,8 +2832,8 @@ api.indices.prototype['delete'] = ca({ * Perform a [indices.deleteAlias](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-aliases.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit timestamp for the document - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit timestamp for the document + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String, String[], Boolean} params.index - A comma-separated list of index names (supports wildcards); use `_all` for all indices * @param {String, String[], Boolean} params.name - A comma-separated list of aliases to delete (supports wildcards); use `_all` to delete all aliases for the specified indices. */ @@ -2865,8 +2865,8 @@ api.indices.prototype.deleteAlias = ca({ * Perform a [indices.deleteTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-templates.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String} params.name - The name of the template */ api.indices.prototype.deleteTemplate = ca({ @@ -3011,7 +3011,7 @@ api.indices.prototype.existsAlias = ca({ * Perform a [indices.existsTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-templates.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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false) * @param {String} params.name - The name of the template */ @@ -3663,7 +3663,7 @@ api.indices.prototype.getSettings = ca({ * * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) - * @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false) * @param {String, String[], Boolean} params.name - The comma separated names of the index templates */ @@ -3751,8 +3751,8 @@ api.indices.prototype.getUpgrade = ca({ * Perform a [indices.open](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-open-close.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) * @param {String} [params.expandWildcards=closed] - Whether to expand wildcard expression to concrete indices that are open, closed or both. @@ -3802,8 +3802,8 @@ api.indices.prototype.open = ca({ * Perform a [indices.putAlias](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-aliases.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit timestamp for the document - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit timestamp for the document + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String, String[], Boolean} params.index - A comma-separated list of index names the alias should point to (supports wildcards); use `_all` to perform the operation on all indices. * @param {String} params.name - The name of the alias to be created or updated */ @@ -3835,8 +3835,8 @@ api.indices.prototype.putAlias = ca({ * Perform a [indices.putMapping](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-put-mapping.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) * @param {String} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both. @@ -3906,7 +3906,7 @@ api.indices.prototype.putMapping = ca({ * Perform a [indices.putSettings](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-update-settings.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.preserveExisting - Whether to update existing settings. If set to `true` existing settings on an index remain unchanged, the default is `false` * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) @@ -3971,8 +3971,8 @@ api.indices.prototype.putSettings = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {Number} params.order - The order for this template when merging multiple matching ones (higher numbers are merged later, overriding the lower numbers) * @param {Boolean} params.create - Whether the index template should only be added if new or can also replace an existing one - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) * @param {String} params.name - The name of the template */ @@ -4109,9 +4109,9 @@ api.indices.prototype.refresh = ca({ * Perform a [indices.rollover](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-rollover-index.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {Boolean} params.dryRun - If set to true the rollover action will only be validated but not actually performed even if a condition matches. The default is false - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String} params.waitForActiveShards - Set the number of active shards to wait for on the newly created rollover index before the operation returns. * @param {String} params.alias - The name of the alias to rollover * @param {String} params.newIndex - The name of the rollover index @@ -4282,8 +4282,8 @@ api.indices.prototype.shardStores = ca({ * Perform a [indices.shrink](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-shrink-index.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String} params.waitForActiveShards - Set the number of active shards to wait for on the shrunken index before the operation returns. * @param {String} params.index - The name of the source index to shrink * @param {String} params.target - The name of the target index to shrink into @@ -4439,8 +4439,8 @@ api.indices.prototype.stats = ca({ * Perform a [indices.updateAliases](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-aliases.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Request timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Request timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master */ api.indices.prototype.updateAliases = ca({ params: { @@ -4640,8 +4640,8 @@ api.ingest = namespace(); * Perform a [ingest.deletePipeline](https://www.elastic.co/guide/en/elasticsearch/plugins/5.x/ingest.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 {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String} params.id - Pipeline ID */ api.ingest.prototype.deletePipeline = ca({ @@ -4669,7 +4669,7 @@ api.ingest.prototype.deletePipeline = ca({ * Perform a [ingest.getPipeline](https://www.elastic.co/guide/en/elasticsearch/plugins/5.x/ingest.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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {String} params.id - Comma separated list of pipeline ids. Wildcards supported */ api.ingest.prototype.getPipeline = ca({ @@ -4698,8 +4698,8 @@ api.ingest.prototype.getPipeline = ca({ * Perform a [ingest.putPipeline](https://www.elastic.co/guide/en/elasticsearch/plugins/5.x/ingest.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 {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String} params.id - Pipeline ID */ api.ingest.prototype.putPipeline = ca({ @@ -5114,12 +5114,12 @@ api.nodes = namespace(); * Perform a [nodes.hotThreads](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-nodes-hot-threads.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.interval - The interval for the second sampling of threads + * @param {DurationString} params.interval - The interval for the second sampling of threads * @param {Number} params.snapshots - Number of samples of thread stacktrace (default: 10) * @param {Number} params.threads - Specify the number of threads to provide information for (default: 3) * @param {Boolean} params.ignoreIdleThreads - Don't show threads that are in known-idle places, such as waiting on a socket select or pulling from an empty task queue (default: true) * @param {String} params.type - The type to sample (default: cpu) - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String, String[], Boolean} params.nodeId - A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes */ api.nodes.prototype.hotThreads = ca({ @@ -5170,7 +5170,7 @@ api.nodes.prototype.hotThreads = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) * @param {Boolean} params.human - Whether to return time and byte values in human-readable format. - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String, String[], Boolean} params.nodeId - A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes * @param {String, String[], Boolean} params.metric - A comma-separated list of metrics you wish returned. Leave empty to return all. */ @@ -5255,7 +5255,7 @@ api.nodes.prototype.info = ca({ * @param {Boolean} params.human - Whether to return time and byte values in human-readable format. * @param {String} [params.level=node] - Return indices stats aggregated at index, node or shard level * @param {String, String[], Boolean} params.types - A comma-separated list of document types for the `indexing` index metric - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String, String[], Boolean} params.metric - Limit the information returned to the specified metrics * @param {String, String[], Boolean} params.indexMetric - Limit the information returned for `indices` metric to the specific index metrics. Isn't used if `indices` (or `all`) metric isn't specified. * @param {String, String[], Boolean} params.nodeId - A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes @@ -5619,7 +5619,7 @@ api.putTemplate = ca({ * * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.refresh - Should the effected indexes be refreshed? - * @param {Date, Number} [params.timeout=1m] - Time each individual bulk request should wait for shards that are unavailable. + * @param {DurationString} [params.timeout=1m] - Time each individual bulk request should wait for shards that are unavailable. * @param {String} params.waitForActiveShards - Sets the number of shard copies that must be active before proceeding with the reindex operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1) * @param {Boolean} params.waitForCompletion - Should the request should block until the reindex is complete. * @param {Number} params.requestsPerSecond - The throttle to set on this request in sub-requests per second. -1 means set no throttle as does "unlimited" which is the only non-float this accepts. @@ -5708,7 +5708,7 @@ api.renderSearchTemplate = ca({ * Perform a [scroll](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-request-scroll.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.scroll - Specify how long a consistent view of the index should be maintained for scrolled search + * @param {DurationString} params.scroll - Specify how long a consistent view of the index should be maintained for scrolled search * @param {String} params.scrollId - The scroll ID */ api.scroll = ca({ @@ -5759,7 +5759,7 @@ api.scroll = ca({ * @param {String} params.preference - Specify the node or shard the operation should be performed on (default: random) * @param {String} params.q - Query in the Lucene query string syntax * @param {String, String[], Boolean} params.routing - A comma-separated list of specific routing values - * @param {Date, Number} params.scroll - Specify how long a consistent view of the index should be maintained for scrolled search + * @param {DurationString} params.scroll - Specify how long a consistent view of the index should be maintained for scrolled search * @param {String} params.searchType - Search operation type * @param {Number} params.size - Number of hits to return (default: 10) * @param {String, String[], Boolean} params.sort - A comma-separated list of : pairs @@ -5772,7 +5772,7 @@ api.scroll = ca({ * @param {String} [params.suggestMode=missing] - Specify suggest mode * @param {Number} params.suggestSize - How many suggestions to return in response * @param {String} params.suggestText - The source text for which the suggestions should be returned - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {Boolean} params.trackScores - Whether to calculate and return scores even if they are not used for sorting * @param {Boolean} params.version - Specify whether to return document version as part of a hit * @param {Boolean} params.requestCache - Specify if request cache should be used for this request or not, defaults to index level setting @@ -6032,7 +6032,7 @@ api.searchShards = ca({ * @param {String} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both. * @param {String} params.preference - Specify the node or shard the operation should be performed on (default: random) * @param {String, String[], Boolean} params.routing - A comma-separated list of specific routing values - * @param {Date, Number} params.scroll - Specify how long a consistent view of the index should be maintained for scrolled search + * @param {DurationString} params.scroll - Specify how long a consistent view of the index should be maintained for scrolled search * @param {String} params.searchType - Search operation type * @param {String, String[], Boolean} params.index - A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices * @param {String, String[], Boolean} params.type - A comma-separated list of document types to search; leave empty to perform the operation on all types @@ -6111,7 +6111,7 @@ api.snapshot = namespace(); * Perform a [snapshot.create](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {Boolean} params.waitForCompletion - Should this request wait until the operation has completed before returning * @param {String} params.repository - A repository name * @param {String} params.snapshot - A snapshot name @@ -6146,8 +6146,8 @@ api.snapshot.prototype.create = ca({ * Perform a [snapshot.createRepository](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-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 {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout * @param {Boolean} params.verify - Whether to verify the repository after creation * @param {String} params.repository - A repository name */ @@ -6180,7 +6180,7 @@ api.snapshot.prototype.createRepository = ca({ * Perform a [snapshot.delete](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {String} params.repository - A repository name * @param {String} params.snapshot - A snapshot name */ @@ -6209,8 +6209,8 @@ api.snapshot.prototype['delete'] = ca({ * Perform a [snapshot.deleteRepository](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-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 {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String, String[], Boolean} params.repository - A comma-separated list of repository names */ api.snapshot.prototype.deleteRepository = ca({ @@ -6238,7 +6238,7 @@ api.snapshot.prototype.deleteRepository = ca({ * Perform a [snapshot.get](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {Boolean} params.ignoreUnavailable - Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown * @param {String} params.repository - A repository name * @param {String, String[], Boolean} params.snapshot - A comma-separated list of snapshot names @@ -6271,7 +6271,7 @@ api.snapshot.prototype.get = ca({ * Perform a [snapshot.getRepository](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false) * @param {String, String[], Boolean} params.repository - A comma-separated list of repository names */ @@ -6304,7 +6304,7 @@ api.snapshot.prototype.getRepository = ca({ * Perform a [snapshot.restore](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {Boolean} params.waitForCompletion - Should this request wait until the operation has completed before returning * @param {String} params.repository - A repository name * @param {String} params.snapshot - A snapshot name @@ -6339,7 +6339,7 @@ api.snapshot.prototype.restore = ca({ * Perform a [snapshot.status](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {Boolean} params.ignoreUnavailable - Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown * @param {String} params.repository - A repository name * @param {String, String[], Boolean} params.snapshot - A comma-separated list of snapshot names @@ -6385,8 +6385,8 @@ api.snapshot.prototype.status = ca({ * Perform a [snapshot.verifyRepository](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-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 {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String} params.repository - A repository name */ api.snapshot.prototype.verifyRepository = ca({ @@ -6714,9 +6714,9 @@ api.termvectors = ca({ * @param {String} params.refresh - If `true` then refresh the effected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes. * @param {Number} params.retryOnConflict - Specify how many times should the operation be retried when a conflict occurs (default: 0) * @param {String} params.routing - Specific routing value - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.timestamp - Explicit timestamp for the document - * @param {Date, Number} params.ttl - Expiration time for the document + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.timestamp - Explicit timestamp for the document + * @param {DurationString} params.ttl - Expiration time for the document * @param {Number} params.version - Explicit version number for concurrency control * @param {String} params.versionType - Specific version type * @param {String} params.id - Document ID @@ -6822,9 +6822,9 @@ api.update = ca({ * @param {String} params.preference - Specify the node or shard the operation should be performed on (default: random) * @param {String} params.q - Query in the Lucene query string syntax * @param {String, String[], Boolean} params.routing - A comma-separated list of specific routing values - * @param {Date, Number} params.scroll - Specify how long a consistent view of the index should be maintained for scrolled search + * @param {DurationString} params.scroll - Specify how long a consistent view of the index should be maintained for scrolled search * @param {String} params.searchType - Search operation type - * @param {Date, Number} params.searchTimeout - Explicit timeout for each search request. Defaults to no timeout. + * @param {DurationString} params.searchTimeout - Explicit timeout for each search request. Defaults to no timeout. * @param {Number} params.size - Number of hits to return (default: 10) * @param {String, String[], Boolean} params.sort - A comma-separated list of : pairs * @param {String, String[], Boolean} params._source - True or false to return the _source field or not, or a list of fields to return @@ -6836,7 +6836,7 @@ api.update = ca({ * @param {Boolean} params.versionType - Should the document increment the version number (internal) on hit or not (reindex) * @param {Boolean} params.requestCache - Specify if request cache should be used for this request or not, defaults to index level setting * @param {Boolean} params.refresh - Should the effected indexes be refreshed? - * @param {Date, Number} [params.timeout=1m] - Time each individual bulk request should wait for shards that are unavailable. + * @param {DurationString} [params.timeout=1m] - Time each individual bulk request should wait for shards that are unavailable. * @param {String} params.waitForActiveShards - Sets the number of shard copies that must be active before proceeding with the update by query operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1) * @param {Number} params.scrollSize - Size on the scroll request powering the update_by_query * @param {Boolean} params.waitForCompletion - Should the request should block until the update by query operation is complete. diff --git a/src/lib/apis/5_x.js b/src/lib/apis/5_x.js index 62ad76116..95b06a30e 100644 --- a/src/lib/apis/5_x.js +++ b/src/lib/apis/5_x.js @@ -20,7 +20,7 @@ api._namespaces = ['cat', 'cluster', 'indices', 'ingest', 'nodes', 'snapshot', ' * @param {String} params.waitForActiveShards - Sets the number of shard copies that must be active before proceeding with the bulk operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1) * @param {String} params.refresh - If `true` then refresh the effected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes. * @param {String} params.routing - Specific routing value - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String} params.type - Default document type for items which don't provide one * @param {String, String[], Boolean} params.fields - Default comma-separated list of fields to return in the response for updates, can be overridden on each sub-request * @param {String, String[], Boolean} params._source - True or false to return the _source field or not, or default list of fields to return, can be overridden on each sub-request @@ -108,7 +108,7 @@ api.cat = namespace(); * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.format - a short version of the Accept header, e.g. json, yaml * @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 {DurationString} 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 {String, String[], Boolean} params.s - Comma-separated list of column names or column aliases to sort by @@ -164,7 +164,7 @@ api.cat.prototype.aliases = ca({ * @param {String} params.format - a short version of the Accept header, e.g. json, yaml * @param {String} params.bytes - The unit in which to display byte values * @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 {DurationString} 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 {String, String[], Boolean} params.s - Comma-separated list of column names or column aliases to sort by @@ -235,7 +235,7 @@ api.cat.prototype.allocation = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.format - a short version of the Accept header, e.g. json, yaml * @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 {DurationString} 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 {String, String[], Boolean} params.s - Comma-separated list of column names or column aliases to sort by @@ -291,7 +291,7 @@ api.cat.prototype.count = ca({ * @param {String} params.format - a short version of the Accept header, e.g. json, yaml * @param {String} params.bytes - The unit in which to display byte values * @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 {DurationString} 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 {String, String[], Boolean} params.s - Comma-separated list of column names or column aliases to sort by @@ -365,7 +365,7 @@ api.cat.prototype.fielddata = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.format - a short version of the Accept header, e.g. json, yaml * @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 {DurationString} 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 {String, String[], Boolean} params.s - Comma-separated list of column names or column aliases to sort by @@ -437,7 +437,7 @@ api.cat.prototype.help = ca({ * @param {String} params.format - a short version of the Accept header, e.g. json, yaml * @param {String} params.bytes - The unit in which to display byte values * @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 {DurationString} 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 {String} params.health - A health status ("green", "yellow", or "red" to filter only indices matching the specified health status * @param {Boolean} params.help - Return help information @@ -516,7 +516,7 @@ api.cat.prototype.indices = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.format - a short version of the Accept header, e.g. json, yaml * @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 {DurationString} 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 {String, String[], Boolean} params.s - Comma-separated list of column names or column aliases to sort by @@ -560,7 +560,7 @@ api.cat.prototype.master = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.format - a short version of the Accept header, e.g. json, yaml * @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 {DurationString} 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 {String, String[], Boolean} params.s - Comma-separated list of column names or column aliases to sort by @@ -605,7 +605,7 @@ api.cat.prototype.nodeattrs = ca({ * @param {String} params.format - a short version of the Accept header, e.g. json, yaml * @param {Boolean} params.fullId - Return the full node ID instead of the shortened version (default: false) * @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 {DurationString} 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 {String, String[], Boolean} params.s - Comma-separated list of column names or column aliases to sort by @@ -653,7 +653,7 @@ api.cat.prototype.nodes = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.format - a short version of the Accept header, e.g. json, yaml * @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 {DurationString} 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 {String, String[], Boolean} params.s - Comma-separated list of column names or column aliases to sort by @@ -697,7 +697,7 @@ api.cat.prototype.pendingTasks = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.format - a short version of the Accept header, e.g. json, yaml * @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 {DurationString} 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 {String, String[], Boolean} params.s - Comma-separated list of column names or column aliases to sort by @@ -741,7 +741,7 @@ api.cat.prototype.plugins = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.format - a short version of the Accept header, e.g. json, yaml * @param {String} params.bytes - The unit in which to display byte values - * @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} 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 {String, String[], Boolean} params.s - Comma-separated list of column names or column aliases to sort by @@ -809,7 +809,7 @@ api.cat.prototype.recovery = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.format - a short version of the Accept header, e.g. json, yaml * @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 {DurationString} 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 {String, String[], Boolean} params.s - Comma-separated list of column names or column aliases to sort by @@ -900,7 +900,7 @@ api.cat.prototype.segments = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.format - a short version of the Accept header, e.g. json, yaml * @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 {DurationString} 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 {String, String[], Boolean} params.s - Comma-separated list of column names or column aliases to sort by @@ -955,7 +955,7 @@ api.cat.prototype.shards = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.format - a short version of the Accept header, e.g. json, yaml * @param {Boolean} params.ignoreUnavailable - Set to true to ignore unavailable snapshots - * @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} 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 {String, String[], Boolean} params.s - Comma-separated list of column names or column aliases to sort by @@ -1070,7 +1070,7 @@ api.cat.prototype.tasks = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.format - a short version of the Accept header, e.g. json, yaml * @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 {DurationString} 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 {String, String[], Boolean} params.s - Comma-separated list of column names or column aliases to sort by @@ -1126,7 +1126,7 @@ api.cat.prototype.templates = ca({ * @param {String} params.format - a short version of the Accept header, e.g. json, yaml * @param {String} params.size - The multiplier in which to display values * @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 {DurationString} 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 {String, String[], Boolean} params.s - Comma-separated list of column names or column aliases to sort by @@ -1240,8 +1240,8 @@ api.cluster.prototype.allocationExplain = ca({ * * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) - * @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout * @param {Boolean} params.includeDefaults - Whether to return all default clusters setting. */ api.cluster.prototype.getSettings = ca({ @@ -1274,8 +1274,8 @@ api.cluster.prototype.getSettings = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} [params.level=cluster] - Specify the level of detail for returned information * @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 {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String} params.waitForActiveShards - Wait until the specified number of shards is active * @param {String} params.waitForNodes - Wait until the specified number of nodes is available * @param {String} params.waitForEvents - Wait until all currently queued events with the given priority are processed @@ -1359,7 +1359,7 @@ api.cluster.prototype.health = ca({ * * @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 - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master */ api.cluster.prototype.pendingTasks = ca({ params: { @@ -1381,8 +1381,8 @@ api.cluster.prototype.pendingTasks = ca({ * * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) - * @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout */ api.cluster.prototype.putSettings = ca({ params: { @@ -1412,8 +1412,8 @@ api.cluster.prototype.putSettings = ca({ * @param {Boolean} params.explain - Return an explanation of why the commands can or cannot be executed * @param {Boolean} params.retryFailed - Retries allocation of shards that are blocked due to too many subsequent allocation failures * @param {String, String[], Boolean} params.metric - Limit the information returned to the specified metrics. Defaults to all but metadata - * @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout */ api.cluster.prototype.reroute = ca({ params: { @@ -1459,7 +1459,7 @@ api.cluster.prototype.reroute = ca({ * * @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 - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) @@ -1552,7 +1552,7 @@ api.cluster.prototype.state = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) * @param {Boolean} params.human - Whether to return time and byte values in human-readable format. - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String, String[], Boolean} params.nodeId - A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes */ api.cluster.prototype.stats = ca({ @@ -1791,9 +1791,9 @@ api.countPercolate = ca({ * @param {String} params.parent - ID of the parent document * @param {String} params.refresh - If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes. * @param {String} params.routing - Specific routing value - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.timestamp - Explicit timestamp for the document - * @param {Date, Number} params.ttl - Expiration time for the document + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.timestamp - Explicit timestamp for the document + * @param {DurationString} params.ttl - Expiration time for the document * @param {Number} params.version - Explicit version number for concurrency control * @param {String} params.versionType - Specific version type * @param {String} params.pipeline - The pipeline id to preprocess incoming documents with @@ -1874,7 +1874,7 @@ api.create = ca({ * @param {String} params.parent - ID of parent document * @param {String} params.refresh - If `true` then refresh the effected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes. * @param {String} params.routing - Specific routing value - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {Number} params.version - Explicit version number for concurrency control * @param {String} params.versionType - Specific version type * @param {String} params.id - The document ID @@ -1953,9 +1953,9 @@ api['delete'] = ca({ * @param {String} params.preference - Specify the node or shard the operation should be performed on (default: random) * @param {String} params.q - Query in the Lucene query string syntax * @param {String, String[], Boolean} params.routing - A comma-separated list of specific routing values - * @param {Date, Number} params.scroll - Specify how long a consistent view of the index should be maintained for scrolled search + * @param {DurationString} params.scroll - Specify how long a consistent view of the index should be maintained for scrolled search * @param {String} params.searchType - Search operation type - * @param {Date, Number} params.searchTimeout - Explicit timeout for each search request. Defaults to no timeout. + * @param {DurationString} params.searchTimeout - Explicit timeout for each search request. Defaults to no timeout. * @param {Number} params.size - Number of hits to return (default: 10) * @param {String, String[], Boolean} params.sort - A comma-separated list of : pairs * @param {String, String[], Boolean} params._source - True or false to return the _source field or not, or a list of fields to return @@ -1966,7 +1966,7 @@ api['delete'] = ca({ * @param {Boolean} params.version - Specify whether to return document version as part of a hit * @param {Boolean} params.requestCache - Specify if request cache should be used for this request or not, defaults to index level setting * @param {Boolean} params.refresh - Should the effected indexes be refreshed? - * @param {Date, Number} [params.timeout=1m] - Time each individual bulk request should wait for shards that are unavailable. + * @param {DurationString} [params.timeout=1m] - Time each individual bulk request should wait for shards that are unavailable. * @param {String} params.waitForActiveShards - Sets the number of shard copies that must be active before proceeding with the delete by query operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1) * @param {Number} params.scrollSize - Size on the scroll request powering the update_by_query * @param {Boolean} params.waitForCompletion - Should the request should block until the delete-by-query is complete. @@ -2581,9 +2581,9 @@ api.getTemplate = ca({ * @param {String} params.parent - ID of the parent document * @param {String} params.refresh - If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes. * @param {String} params.routing - Specific routing value - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.timestamp - Explicit timestamp for the document - * @param {Date, Number} params.ttl - Expiration time for the document + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.timestamp - Explicit timestamp for the document + * @param {DurationString} params.ttl - Expiration time for the document * @param {Number} params.version - Explicit version number for concurrency control * @param {String} params.versionType - Specific version type * @param {String} params.pipeline - The pipeline id to preprocess incoming documents with @@ -2834,8 +2834,8 @@ api.indices.prototype.clearCache = ca({ * Perform a [indices.close](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-open-close.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) * @param {String} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both. @@ -2886,8 +2886,8 @@ api.indices.prototype.close = ca({ * * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.waitForActiveShards - Set the number of active shards to wait for before the operation returns. - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.updateAllTypes - Whether to update the mapping for all fields with the same name across all types or not * @param {String} params.index - The name of the index */ @@ -2924,8 +2924,8 @@ api.indices.prototype.create = ca({ * Perform a [indices.delete](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-delete-index.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String, String[], Boolean} params.index - A comma-separated list of indices to delete; use `_all` or `*` string to delete all indices */ api.indices.prototype['delete'] = ca({ @@ -2953,8 +2953,8 @@ api.indices.prototype['delete'] = ca({ * Perform a [indices.deleteAlias](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-aliases.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit timestamp for the document - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit timestamp for the document + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String, String[], Boolean} params.index - A comma-separated list of index names (supports wildcards); use `_all` for all indices * @param {String, String[], Boolean} params.name - A comma-separated list of aliases to delete (supports wildcards); use `_all` to delete all aliases for the specified indices. */ @@ -2986,8 +2986,8 @@ api.indices.prototype.deleteAlias = ca({ * Perform a [indices.deleteTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-templates.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String} params.name - The name of the template */ api.indices.prototype.deleteTemplate = ca({ @@ -3132,7 +3132,7 @@ api.indices.prototype.existsAlias = ca({ * Perform a [indices.existsTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-templates.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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false) * @param {String} params.name - The name of the template */ @@ -3784,7 +3784,7 @@ api.indices.prototype.getSettings = ca({ * * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) - * @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false) * @param {String, String[], Boolean} params.name - The comma separated names of the index templates */ @@ -3872,8 +3872,8 @@ api.indices.prototype.getUpgrade = ca({ * Perform a [indices.open](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-open-close.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) * @param {String} [params.expandWildcards=closed] - Whether to expand wildcard expression to concrete indices that are open, closed or both. @@ -3923,8 +3923,8 @@ api.indices.prototype.open = ca({ * Perform a [indices.putAlias](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-aliases.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit timestamp for the document - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit timestamp for the document + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String, String[], Boolean} params.index - A comma-separated list of index names the alias should point to (supports wildcards); use `_all` to perform the operation on all indices. * @param {String} params.name - The name of the alias to be created or updated */ @@ -3956,8 +3956,8 @@ api.indices.prototype.putAlias = ca({ * Perform a [indices.putMapping](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-put-mapping.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) * @param {String} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both. @@ -4027,7 +4027,7 @@ api.indices.prototype.putMapping = ca({ * Perform a [indices.putSettings](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-update-settings.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.preserveExisting - Whether to update existing settings. If set to `true` existing settings on an index remain unchanged, the default is `false` * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) @@ -4092,8 +4092,8 @@ api.indices.prototype.putSettings = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {Number} params.order - The order for this template when merging multiple matching ones (higher numbers are merged later, overriding the lower numbers) * @param {Boolean} params.create - Whether the index template should only be added if new or can also replace an existing one - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) * @param {String} params.name - The name of the template */ @@ -4230,9 +4230,9 @@ api.indices.prototype.refresh = ca({ * Perform a [indices.rollover](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-rollover-index.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {Boolean} params.dryRun - If set to true the rollover action will only be validated but not actually performed even if a condition matches. The default is false - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String} params.waitForActiveShards - Set the number of active shards to wait for on the newly created rollover index before the operation returns. * @param {String} params.alias - The name of the alias to rollover * @param {String} params.newIndex - The name of the rollover index @@ -4403,8 +4403,8 @@ api.indices.prototype.shardStores = ca({ * Perform a [indices.shrink](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-shrink-index.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String} params.waitForActiveShards - Set the number of active shards to wait for on the shrunken index before the operation returns. * @param {String} params.index - The name of the source index to shrink * @param {String} params.target - The name of the target index to shrink into @@ -4560,8 +4560,8 @@ api.indices.prototype.stats = ca({ * Perform a [indices.updateAliases](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-aliases.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Request timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Request timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master */ api.indices.prototype.updateAliases = ca({ params: { @@ -4756,8 +4756,8 @@ api.ingest = namespace(); * Perform a [ingest.deletePipeline](https://www.elastic.co/guide/en/elasticsearch/plugins/5.x/ingest.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 {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String} params.id - Pipeline ID */ api.ingest.prototype.deletePipeline = ca({ @@ -4785,7 +4785,7 @@ api.ingest.prototype.deletePipeline = ca({ * Perform a [ingest.getPipeline](https://www.elastic.co/guide/en/elasticsearch/plugins/5.x/ingest.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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {String} params.id - Comma separated list of pipeline ids. Wildcards supported */ api.ingest.prototype.getPipeline = ca({ @@ -4814,8 +4814,8 @@ api.ingest.prototype.getPipeline = ca({ * Perform a [ingest.putPipeline](https://www.elastic.co/guide/en/elasticsearch/plugins/5.x/ingest.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 {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String} params.id - Pipeline ID */ api.ingest.prototype.putPipeline = ca({ @@ -5230,12 +5230,12 @@ api.nodes = namespace(); * Perform a [nodes.hotThreads](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-nodes-hot-threads.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.interval - The interval for the second sampling of threads + * @param {DurationString} params.interval - The interval for the second sampling of threads * @param {Number} params.snapshots - Number of samples of thread stacktrace (default: 10) * @param {Number} params.threads - Specify the number of threads to provide information for (default: 3) * @param {Boolean} params.ignoreIdleThreads - Don't show threads that are in known-idle places, such as waiting on a socket select or pulling from an empty task queue (default: true) * @param {String} params.type - The type to sample (default: cpu) - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String, String[], Boolean} params.nodeId - A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes */ api.nodes.prototype.hotThreads = ca({ @@ -5286,7 +5286,7 @@ api.nodes.prototype.hotThreads = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) * @param {Boolean} params.human - Whether to return time and byte values in human-readable format. - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String, String[], Boolean} params.nodeId - A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes * @param {String, String[], Boolean} params.metric - A comma-separated list of metrics you wish returned. Leave empty to return all. */ @@ -5371,7 +5371,7 @@ api.nodes.prototype.info = ca({ * @param {Boolean} params.human - Whether to return time and byte values in human-readable format. * @param {String} [params.level=node] - Return indices stats aggregated at index, node or shard level * @param {String, String[], Boolean} params.types - A comma-separated list of document types for the `indexing` index metric - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String, String[], Boolean} params.metric - Limit the information returned to the specified metrics * @param {String, String[], Boolean} params.indexMetric - Limit the information returned for `indices` metric to the specific index metrics. Isn't used if `indices` (or `all`) metric isn't specified. * @param {String, String[], Boolean} params.nodeId - A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes @@ -5735,7 +5735,7 @@ api.putTemplate = ca({ * * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.refresh - Should the effected indexes be refreshed? - * @param {Date, Number} [params.timeout=1m] - Time each individual bulk request should wait for shards that are unavailable. + * @param {DurationString} [params.timeout=1m] - Time each individual bulk request should wait for shards that are unavailable. * @param {String} params.waitForActiveShards - Sets the number of shard copies that must be active before proceeding with the reindex operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1) * @param {Boolean} params.waitForCompletion - Should the request should block until the reindex is complete. * @param {Number} params.requestsPerSecond - The throttle to set on this request in sub-requests per second. -1 means no throttle. @@ -5829,7 +5829,7 @@ api.renderSearchTemplate = ca({ * Perform a [scroll](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-request-scroll.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.scroll - Specify how long a consistent view of the index should be maintained for scrolled search + * @param {DurationString} params.scroll - Specify how long a consistent view of the index should be maintained for scrolled search * @param {String} params.scrollId - The scroll ID */ api.scroll = ca({ @@ -5879,7 +5879,7 @@ api.scroll = ca({ * @param {String} params.preference - Specify the node or shard the operation should be performed on (default: random) * @param {String} params.q - Query in the Lucene query string syntax * @param {String, String[], Boolean} params.routing - A comma-separated list of specific routing values - * @param {Date, Number} params.scroll - Specify how long a consistent view of the index should be maintained for scrolled search + * @param {DurationString} params.scroll - Specify how long a consistent view of the index should be maintained for scrolled search * @param {String} params.searchType - Search operation type * @param {Number} params.size - Number of hits to return (default: 10) * @param {String, String[], Boolean} params.sort - A comma-separated list of : pairs @@ -5892,7 +5892,7 @@ api.scroll = ca({ * @param {String} [params.suggestMode=missing] - Specify suggest mode * @param {Number} params.suggestSize - How many suggestions to return in response * @param {String} params.suggestText - The source text for which the suggestions should be returned - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {Boolean} params.trackScores - Whether to calculate and return scores even if they are not used for sorting * @param {Boolean} params.version - Specify whether to return document version as part of a hit * @param {Boolean} params.requestCache - Specify if request cache should be used for this request or not, defaults to index level setting @@ -6148,7 +6148,7 @@ api.searchShards = ca({ * @param {String} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both. * @param {String} params.preference - Specify the node or shard the operation should be performed on (default: random) * @param {String, String[], Boolean} params.routing - A comma-separated list of specific routing values - * @param {Date, Number} params.scroll - Specify how long a consistent view of the index should be maintained for scrolled search + * @param {DurationString} params.scroll - Specify how long a consistent view of the index should be maintained for scrolled search * @param {String} params.searchType - Search operation type * @param {Boolean} params.explain - Specify whether to return detailed information about score computation as part of a hit * @param {Boolean} params.profile - Specify whether to profile the query execution @@ -6235,7 +6235,7 @@ api.snapshot = namespace(); * Perform a [snapshot.create](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {Boolean} params.waitForCompletion - Should this request wait until the operation has completed before returning * @param {String} params.repository - A repository name * @param {String} params.snapshot - A snapshot name @@ -6270,8 +6270,8 @@ api.snapshot.prototype.create = ca({ * Perform a [snapshot.createRepository](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-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 {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout * @param {Boolean} params.verify - Whether to verify the repository after creation * @param {String} params.repository - A repository name */ @@ -6304,7 +6304,7 @@ api.snapshot.prototype.createRepository = ca({ * Perform a [snapshot.delete](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {String} params.repository - A repository name * @param {String} params.snapshot - A snapshot name */ @@ -6333,8 +6333,8 @@ api.snapshot.prototype['delete'] = ca({ * Perform a [snapshot.deleteRepository](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-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 {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String, String[], Boolean} params.repository - A comma-separated list of repository names */ api.snapshot.prototype.deleteRepository = ca({ @@ -6362,7 +6362,7 @@ api.snapshot.prototype.deleteRepository = ca({ * Perform a [snapshot.get](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {Boolean} params.ignoreUnavailable - Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown * @param {String} params.repository - A repository name * @param {String, String[], Boolean} params.snapshot - A comma-separated list of snapshot names @@ -6395,7 +6395,7 @@ api.snapshot.prototype.get = ca({ * Perform a [snapshot.getRepository](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false) * @param {String, String[], Boolean} params.repository - A comma-separated list of repository names */ @@ -6428,7 +6428,7 @@ api.snapshot.prototype.getRepository = ca({ * Perform a [snapshot.restore](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {Boolean} params.waitForCompletion - Should this request wait until the operation has completed before returning * @param {String} params.repository - A repository name * @param {String} params.snapshot - A snapshot name @@ -6463,7 +6463,7 @@ api.snapshot.prototype.restore = ca({ * Perform a [snapshot.status](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {Boolean} params.ignoreUnavailable - Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown * @param {String} params.repository - A repository name * @param {String, String[], Boolean} params.snapshot - A comma-separated list of snapshot names @@ -6509,8 +6509,8 @@ api.snapshot.prototype.status = ca({ * Perform a [snapshot.verifyRepository](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-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 {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String} params.repository - A repository name */ api.snapshot.prototype.verifyRepository = ca({ @@ -6838,9 +6838,9 @@ api.termvectors = ca({ * @param {String} params.refresh - If `true` then refresh the effected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes. * @param {Number} params.retryOnConflict - Specify how many times should the operation be retried when a conflict occurs (default: 0) * @param {String} params.routing - Specific routing value - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.timestamp - Explicit timestamp for the document - * @param {Date, Number} params.ttl - Expiration time for the document + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.timestamp - Explicit timestamp for the document + * @param {DurationString} params.ttl - Expiration time for the document * @param {Number} params.version - Explicit version number for concurrency control * @param {String} params.versionType - Specific version type * @param {String} params.id - Document ID @@ -6945,9 +6945,9 @@ api.update = ca({ * @param {String} params.preference - Specify the node or shard the operation should be performed on (default: random) * @param {String} params.q - Query in the Lucene query string syntax * @param {String, String[], Boolean} params.routing - A comma-separated list of specific routing values - * @param {Date, Number} params.scroll - Specify how long a consistent view of the index should be maintained for scrolled search + * @param {DurationString} params.scroll - Specify how long a consistent view of the index should be maintained for scrolled search * @param {String} params.searchType - Search operation type - * @param {Date, Number} params.searchTimeout - Explicit timeout for each search request. Defaults to no timeout. + * @param {DurationString} params.searchTimeout - Explicit timeout for each search request. Defaults to no timeout. * @param {Number} params.size - Number of hits to return (default: 10) * @param {String, String[], Boolean} params.sort - A comma-separated list of : pairs * @param {String, String[], Boolean} params._source - True or false to return the _source field or not, or a list of fields to return @@ -6959,7 +6959,7 @@ api.update = ca({ * @param {Boolean} params.versionType - Should the document increment the version number (internal) on hit or not (reindex) * @param {Boolean} params.requestCache - Specify if request cache should be used for this request or not, defaults to index level setting * @param {Boolean} params.refresh - Should the effected indexes be refreshed? - * @param {Date, Number} [params.timeout=1m] - Time each individual bulk request should wait for shards that are unavailable. + * @param {DurationString} [params.timeout=1m] - Time each individual bulk request should wait for shards that are unavailable. * @param {String} params.waitForActiveShards - Sets the number of shard copies that must be active before proceeding with the update by query operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1) * @param {Number} params.scrollSize - Size on the scroll request powering the update_by_query * @param {Boolean} params.waitForCompletion - Should the request should block until the update by query operation is complete. diff --git a/src/lib/apis/master.js b/src/lib/apis/master.js index 3930bd46e..d6b1b54c3 100644 --- a/src/lib/apis/master.js +++ b/src/lib/apis/master.js @@ -20,7 +20,7 @@ api._namespaces = ['cat', 'cluster', 'indices', 'ingest', 'nodes', 'snapshot', ' * @param {String} params.waitForActiveShards - Sets the number of shard copies that must be active before proceeding with the bulk operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1) * @param {String} params.refresh - If `true` then refresh the effected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes. * @param {String} params.routing - Specific routing value - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String} params.type - Default document type for items which don't provide one * @param {String, String[], Boolean} params.fields - Default comma-separated list of fields to return in the response for updates, can be overridden on each sub-request * @param {String, String[], Boolean} params._source - True or false to return the _source field or not, or default list of fields to return, can be overridden on each sub-request @@ -108,7 +108,7 @@ api.cat = namespace(); * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.format - a short version of the Accept header, e.g. json, yaml * @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 {DurationString} 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 {String, String[], Boolean} params.s - Comma-separated list of column names or column aliases to sort by @@ -164,7 +164,7 @@ api.cat.prototype.aliases = ca({ * @param {String} params.format - a short version of the Accept header, e.g. json, yaml * @param {String} params.bytes - The unit in which to display byte values * @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 {DurationString} 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 {String, String[], Boolean} params.s - Comma-separated list of column names or column aliases to sort by @@ -235,7 +235,7 @@ api.cat.prototype.allocation = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.format - a short version of the Accept header, e.g. json, yaml * @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 {DurationString} 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 {String, String[], Boolean} params.s - Comma-separated list of column names or column aliases to sort by @@ -291,7 +291,7 @@ api.cat.prototype.count = ca({ * @param {String} params.format - a short version of the Accept header, e.g. json, yaml * @param {String} params.bytes - The unit in which to display byte values * @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 {DurationString} 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 {String, String[], Boolean} params.s - Comma-separated list of column names or column aliases to sort by @@ -365,7 +365,7 @@ api.cat.prototype.fielddata = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.format - a short version of the Accept header, e.g. json, yaml * @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 {DurationString} 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 {String, String[], Boolean} params.s - Comma-separated list of column names or column aliases to sort by @@ -437,7 +437,7 @@ api.cat.prototype.help = ca({ * @param {String} params.format - a short version of the Accept header, e.g. json, yaml * @param {String} params.bytes - The unit in which to display byte values * @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 {DurationString} 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 {String} params.health - A health status ("green", "yellow", or "red" to filter only indices matching the specified health status * @param {Boolean} params.help - Return help information @@ -516,7 +516,7 @@ api.cat.prototype.indices = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.format - a short version of the Accept header, e.g. json, yaml * @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 {DurationString} 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 {String, String[], Boolean} params.s - Comma-separated list of column names or column aliases to sort by @@ -560,7 +560,7 @@ api.cat.prototype.master = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.format - a short version of the Accept header, e.g. json, yaml * @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 {DurationString} 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 {String, String[], Boolean} params.s - Comma-separated list of column names or column aliases to sort by @@ -605,7 +605,7 @@ api.cat.prototype.nodeattrs = ca({ * @param {String} params.format - a short version of the Accept header, e.g. json, yaml * @param {Boolean} params.fullId - Return the full node ID instead of the shortened version (default: false) * @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 {DurationString} 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 {String, String[], Boolean} params.s - Comma-separated list of column names or column aliases to sort by @@ -653,7 +653,7 @@ api.cat.prototype.nodes = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.format - a short version of the Accept header, e.g. json, yaml * @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 {DurationString} 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 {String, String[], Boolean} params.s - Comma-separated list of column names or column aliases to sort by @@ -697,7 +697,7 @@ api.cat.prototype.pendingTasks = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.format - a short version of the Accept header, e.g. json, yaml * @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 {DurationString} 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 {String, String[], Boolean} params.s - Comma-separated list of column names or column aliases to sort by @@ -741,7 +741,7 @@ api.cat.prototype.plugins = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.format - a short version of the Accept header, e.g. json, yaml * @param {String} params.bytes - The unit in which to display byte values - * @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} 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 {String, String[], Boolean} params.s - Comma-separated list of column names or column aliases to sort by @@ -809,7 +809,7 @@ api.cat.prototype.recovery = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.format - a short version of the Accept header, e.g. json, yaml * @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 {DurationString} 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 {String, String[], Boolean} params.s - Comma-separated list of column names or column aliases to sort by @@ -900,7 +900,7 @@ api.cat.prototype.segments = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.format - a short version of the Accept header, e.g. json, yaml * @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 {DurationString} 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 {String, String[], Boolean} params.s - Comma-separated list of column names or column aliases to sort by @@ -955,7 +955,7 @@ api.cat.prototype.shards = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.format - a short version of the Accept header, e.g. json, yaml * @param {Boolean} params.ignoreUnavailable - Set to true to ignore unavailable snapshots - * @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} 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 {String, String[], Boolean} params.s - Comma-separated list of column names or column aliases to sort by @@ -1070,7 +1070,7 @@ api.cat.prototype.tasks = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.format - a short version of the Accept header, e.g. json, yaml * @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 {DurationString} 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 {String, String[], Boolean} params.s - Comma-separated list of column names or column aliases to sort by @@ -1126,7 +1126,7 @@ api.cat.prototype.templates = ca({ * @param {String} params.format - a short version of the Accept header, e.g. json, yaml * @param {String} params.size - The multiplier in which to display values * @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 {DurationString} 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 {String, String[], Boolean} params.s - Comma-separated list of column names or column aliases to sort by @@ -1240,8 +1240,8 @@ api.cluster.prototype.allocationExplain = ca({ * * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) - * @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout * @param {Boolean} params.includeDefaults - Whether to return all default clusters setting. */ api.cluster.prototype.getSettings = ca({ @@ -1274,8 +1274,8 @@ api.cluster.prototype.getSettings = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {String} [params.level=cluster] - Specify the level of detail for returned information * @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 {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String} params.waitForActiveShards - Wait until the specified number of shards is active * @param {String} params.waitForNodes - Wait until the specified number of nodes is available * @param {String} params.waitForEvents - Wait until all currently queued events with the given priority are processed @@ -1359,7 +1359,7 @@ api.cluster.prototype.health = ca({ * * @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 - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master */ api.cluster.prototype.pendingTasks = ca({ params: { @@ -1381,8 +1381,8 @@ api.cluster.prototype.pendingTasks = ca({ * * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) - * @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout */ api.cluster.prototype.putSettings = ca({ params: { @@ -1412,8 +1412,8 @@ api.cluster.prototype.putSettings = ca({ * @param {Boolean} params.explain - Return an explanation of why the commands can or cannot be executed * @param {Boolean} params.retryFailed - Retries allocation of shards that are blocked due to too many subsequent allocation failures * @param {String, String[], Boolean} params.metric - Limit the information returned to the specified metrics. Defaults to all but metadata - * @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout */ api.cluster.prototype.reroute = ca({ params: { @@ -1459,7 +1459,7 @@ api.cluster.prototype.reroute = ca({ * * @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 - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) @@ -1552,7 +1552,7 @@ api.cluster.prototype.state = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) * @param {Boolean} params.human - Whether to return time and byte values in human-readable format. - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String, String[], Boolean} params.nodeId - A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes */ api.cluster.prototype.stats = ca({ @@ -1791,9 +1791,9 @@ api.countPercolate = ca({ * @param {String} params.parent - ID of the parent document * @param {String} params.refresh - If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes. * @param {String} params.routing - Specific routing value - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.timestamp - Explicit timestamp for the document - * @param {Date, Number} params.ttl - Expiration time for the document + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.timestamp - Explicit timestamp for the document + * @param {DurationString} params.ttl - Expiration time for the document * @param {Number} params.version - Explicit version number for concurrency control * @param {String} params.versionType - Specific version type * @param {String} params.pipeline - The pipeline id to preprocess incoming documents with @@ -1874,7 +1874,7 @@ api.create = ca({ * @param {String} params.parent - ID of parent document * @param {String} params.refresh - If `true` then refresh the effected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes. * @param {String} params.routing - Specific routing value - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {Number} params.version - Explicit version number for concurrency control * @param {String} params.versionType - Specific version type * @param {String} params.id - The document ID @@ -1953,9 +1953,9 @@ api['delete'] = ca({ * @param {String} params.preference - Specify the node or shard the operation should be performed on (default: random) * @param {String} params.q - Query in the Lucene query string syntax * @param {String, String[], Boolean} params.routing - A comma-separated list of specific routing values - * @param {Date, Number} params.scroll - Specify how long a consistent view of the index should be maintained for scrolled search + * @param {DurationString} params.scroll - Specify how long a consistent view of the index should be maintained for scrolled search * @param {String} params.searchType - Search operation type - * @param {Date, Number} params.searchTimeout - Explicit timeout for each search request. Defaults to no timeout. + * @param {DurationString} params.searchTimeout - Explicit timeout for each search request. Defaults to no timeout. * @param {Number} params.size - Number of hits to return (default: 10) * @param {String, String[], Boolean} params.sort - A comma-separated list of : pairs * @param {String, String[], Boolean} params._source - True or false to return the _source field or not, or a list of fields to return @@ -1966,7 +1966,7 @@ api['delete'] = ca({ * @param {Boolean} params.version - Specify whether to return document version as part of a hit * @param {Boolean} params.requestCache - Specify if request cache should be used for this request or not, defaults to index level setting * @param {Boolean} params.refresh - Should the effected indexes be refreshed? - * @param {Date, Number} [params.timeout=1m] - Time each individual bulk request should wait for shards that are unavailable. + * @param {DurationString} [params.timeout=1m] - Time each individual bulk request should wait for shards that are unavailable. * @param {String} params.waitForActiveShards - Sets the number of shard copies that must be active before proceeding with the delete by query operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1) * @param {Number} params.scrollSize - Size on the scroll request powering the update_by_query * @param {Boolean} params.waitForCompletion - Should the request should block until the delete-by-query is complete. @@ -2581,9 +2581,9 @@ api.getTemplate = ca({ * @param {String} params.parent - ID of the parent document * @param {String} params.refresh - If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes. * @param {String} params.routing - Specific routing value - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.timestamp - Explicit timestamp for the document - * @param {Date, Number} params.ttl - Expiration time for the document + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.timestamp - Explicit timestamp for the document + * @param {DurationString} params.ttl - Expiration time for the document * @param {Number} params.version - Explicit version number for concurrency control * @param {String} params.versionType - Specific version type * @param {String} params.pipeline - The pipeline id to preprocess incoming documents with @@ -2801,8 +2801,8 @@ api.indices.prototype.clearCache = ca({ * Perform a [indices.close](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-open-close.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) * @param {String} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both. @@ -2853,8 +2853,8 @@ api.indices.prototype.close = ca({ * * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.waitForActiveShards - Set the number of active shards to wait for before the operation returns. - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.updateAllTypes - Whether to update the mapping for all fields with the same name across all types or not * @param {String} params.index - The name of the index */ @@ -2891,8 +2891,8 @@ api.indices.prototype.create = ca({ * Perform a [indices.delete](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-delete-index.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String, String[], Boolean} params.index - A comma-separated list of indices to delete; use `_all` or `*` string to delete all indices */ api.indices.prototype['delete'] = ca({ @@ -2920,8 +2920,8 @@ api.indices.prototype['delete'] = ca({ * Perform a [indices.deleteAlias](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit timestamp for the document - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit timestamp for the document + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String, String[], Boolean} params.index - A comma-separated list of index names (supports wildcards); use `_all` for all indices * @param {String, String[], Boolean} params.name - A comma-separated list of aliases to delete (supports wildcards); use `_all` to delete all aliases for the specified indices. */ @@ -2953,8 +2953,8 @@ api.indices.prototype.deleteAlias = ca({ * Perform a [indices.deleteTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String} params.name - The name of the template */ api.indices.prototype.deleteTemplate = ca({ @@ -3089,7 +3089,7 @@ api.indices.prototype.existsAlias = ca({ * Perform a [indices.existsTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false) * @param {String} params.name - The name of the template */ @@ -3741,7 +3741,7 @@ api.indices.prototype.getSettings = ca({ * * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) - * @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false) * @param {String, String[], Boolean} params.name - The comma separated names of the index templates */ @@ -3829,8 +3829,8 @@ api.indices.prototype.getUpgrade = ca({ * Perform a [indices.open](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-open-close.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) * @param {String} [params.expandWildcards=closed] - Whether to expand wildcard expression to concrete indices that are open, closed or both. @@ -3880,8 +3880,8 @@ api.indices.prototype.open = ca({ * Perform a [indices.putAlias](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit timestamp for the document - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit timestamp for the document + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String, String[], Boolean} params.index - A comma-separated list of index names the alias should point to (supports wildcards); use `_all` to perform the operation on all indices. * @param {String} params.name - The name of the alias to be created or updated */ @@ -3913,8 +3913,8 @@ api.indices.prototype.putAlias = ca({ * Perform a [indices.putMapping](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-put-mapping.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) * @param {String} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both. @@ -3984,7 +3984,7 @@ api.indices.prototype.putMapping = ca({ * Perform a [indices.putSettings](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-update-settings.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.preserveExisting - Whether to update existing settings. If set to `true` existing settings on an index remain unchanged, the default is `false` * @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) * @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) @@ -4049,8 +4049,8 @@ api.indices.prototype.putSettings = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {Number} params.order - The order for this template when merging multiple matching ones (higher numbers are merged later, overriding the lower numbers) * @param {Boolean} params.create - Whether the index template should only be added if new or can also replace an existing one - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) * @param {String} params.name - The name of the template */ @@ -4187,9 +4187,9 @@ api.indices.prototype.refresh = ca({ * Perform a [indices.rollover](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-rollover-index.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {Boolean} params.dryRun - If set to true the rollover action will only be validated but not actually performed even if a condition matches. The default is false - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String} params.waitForActiveShards - Set the number of active shards to wait for on the newly created rollover index before the operation returns. * @param {String} params.alias - The name of the alias to rollover * @param {String} params.newIndex - The name of the rollover index @@ -4360,8 +4360,8 @@ api.indices.prototype.shardStores = ca({ * Perform a [indices.shrink](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-shrink-index.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master * @param {String} params.waitForActiveShards - Set the number of active shards to wait for on the shrunken index before the operation returns. * @param {String} params.index - The name of the source index to shrink * @param {String} params.target - The name of the target index to shrink into @@ -4517,8 +4517,8 @@ api.indices.prototype.stats = ca({ * Perform a [indices.updateAliases](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.timeout - Request timeout - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master + * @param {DurationString} params.timeout - Request timeout + * @param {DurationString} params.masterTimeout - Specify timeout for connection to master */ api.indices.prototype.updateAliases = ca({ params: { @@ -4713,8 +4713,8 @@ api.ingest = namespace(); * Perform a [ingest.deletePipeline](https://www.elastic.co/guide/en/elasticsearch/plugins/master/ingest.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 {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String} params.id - Pipeline ID */ api.ingest.prototype.deletePipeline = ca({ @@ -4742,7 +4742,7 @@ api.ingest.prototype.deletePipeline = ca({ * Perform a [ingest.getPipeline](https://www.elastic.co/guide/en/elasticsearch/plugins/master/ingest.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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {String} params.id - Comma separated list of pipeline ids. Wildcards supported */ api.ingest.prototype.getPipeline = ca({ @@ -4771,8 +4771,8 @@ api.ingest.prototype.getPipeline = ca({ * Perform a [ingest.putPipeline](https://www.elastic.co/guide/en/elasticsearch/plugins/master/ingest.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 {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String} params.id - Pipeline ID */ api.ingest.prototype.putPipeline = ca({ @@ -5187,12 +5187,12 @@ api.nodes = namespace(); * Perform a [nodes.hotThreads](http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-hot-threads.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.interval - The interval for the second sampling of threads + * @param {DurationString} params.interval - The interval for the second sampling of threads * @param {Number} params.snapshots - Number of samples of thread stacktrace (default: 10) * @param {Number} params.threads - Specify the number of threads to provide information for (default: 3) * @param {Boolean} params.ignoreIdleThreads - Don't show threads that are in known-idle places, such as waiting on a socket select or pulling from an empty task queue (default: true) * @param {String} params.type - The type to sample (default: cpu) - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String, String[], Boolean} params.nodeId - A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes */ api.nodes.prototype.hotThreads = ca({ @@ -5243,7 +5243,7 @@ api.nodes.prototype.hotThreads = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) * @param {Boolean} params.human - Whether to return time and byte values in human-readable format. - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String, String[], Boolean} params.nodeId - A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes * @param {String, String[], Boolean} params.metric - A comma-separated list of metrics you wish returned. Leave empty to return all. */ @@ -5328,7 +5328,7 @@ api.nodes.prototype.info = ca({ * @param {Boolean} params.human - Whether to return time and byte values in human-readable format. * @param {String} [params.level=node] - Return indices stats aggregated at index, node or shard level * @param {String, String[], Boolean} params.types - A comma-separated list of document types for the `indexing` index metric - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String, String[], Boolean} params.metric - Limit the information returned to the specified metrics * @param {String, String[], Boolean} params.indexMetric - Limit the information returned for `indices` metric to the specific index metrics. Isn't used if `indices` (or `all`) metric isn't specified. * @param {String, String[], Boolean} params.nodeId - A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes @@ -5692,7 +5692,7 @@ api.putTemplate = ca({ * * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.refresh - Should the effected indexes be refreshed? - * @param {Date, Number} [params.timeout=1m] - Time each individual bulk request should wait for shards that are unavailable. + * @param {DurationString} [params.timeout=1m] - Time each individual bulk request should wait for shards that are unavailable. * @param {String} params.waitForActiveShards - Sets the number of shard copies that must be active before proceeding with the reindex operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1) * @param {Boolean} params.waitForCompletion - Should the request should block until the reindex is complete. * @param {Number} params.requestsPerSecond - The throttle to set on this request in sub-requests per second. -1 means no throttle. @@ -5786,7 +5786,7 @@ api.renderSearchTemplate = ca({ * Perform a [scroll](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-request-scroll.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.scroll - Specify how long a consistent view of the index should be maintained for scrolled search + * @param {DurationString} params.scroll - Specify how long a consistent view of the index should be maintained for scrolled search * @param {String} params.scrollId - The scroll ID */ api.scroll = ca({ @@ -5836,7 +5836,7 @@ api.scroll = ca({ * @param {String} params.preference - Specify the node or shard the operation should be performed on (default: random) * @param {String} params.q - Query in the Lucene query string syntax * @param {String, String[], Boolean} params.routing - A comma-separated list of specific routing values - * @param {Date, Number} params.scroll - Specify how long a consistent view of the index should be maintained for scrolled search + * @param {DurationString} params.scroll - Specify how long a consistent view of the index should be maintained for scrolled search * @param {String} params.searchType - Search operation type * @param {Number} params.size - Number of hits to return (default: 10) * @param {String, String[], Boolean} params.sort - A comma-separated list of : pairs @@ -5849,7 +5849,7 @@ api.scroll = ca({ * @param {String} [params.suggestMode=missing] - Specify suggest mode * @param {Number} params.suggestSize - How many suggestions to return in response * @param {String} params.suggestText - The source text for which the suggestions should be returned - * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.timeout - Explicit operation timeout * @param {Boolean} params.trackScores - Whether to calculate and return scores even if they are not used for sorting * @param {Boolean} params.version - Specify whether to return document version as part of a hit * @param {Boolean} params.requestCache - Specify if request cache should be used for this request or not, defaults to index level setting @@ -6105,7 +6105,7 @@ api.searchShards = ca({ * @param {String} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both. * @param {String} params.preference - Specify the node or shard the operation should be performed on (default: random) * @param {String, String[], Boolean} params.routing - A comma-separated list of specific routing values - * @param {Date, Number} params.scroll - Specify how long a consistent view of the index should be maintained for scrolled search + * @param {DurationString} params.scroll - Specify how long a consistent view of the index should be maintained for scrolled search * @param {String} params.searchType - Search operation type * @param {Boolean} params.explain - Specify whether to return detailed information about score computation as part of a hit * @param {Boolean} params.profile - Specify whether to profile the query execution @@ -6192,7 +6192,7 @@ api.snapshot = namespace(); * Perform a [snapshot.create](http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {Boolean} params.waitForCompletion - Should this request wait until the operation has completed before returning * @param {String} params.repository - A repository name * @param {String} params.snapshot - A snapshot name @@ -6227,8 +6227,8 @@ api.snapshot.prototype.create = ca({ * Perform a [snapshot.createRepository](http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-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 {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout * @param {Boolean} params.verify - Whether to verify the repository after creation * @param {String} params.repository - A repository name */ @@ -6261,7 +6261,7 @@ api.snapshot.prototype.createRepository = ca({ * Perform a [snapshot.delete](http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {String} params.repository - A repository name * @param {String} params.snapshot - A snapshot name */ @@ -6290,8 +6290,8 @@ api.snapshot.prototype['delete'] = ca({ * Perform a [snapshot.deleteRepository](http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-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 {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String, String[], Boolean} params.repository - A comma-separated list of repository names */ api.snapshot.prototype.deleteRepository = ca({ @@ -6319,7 +6319,7 @@ api.snapshot.prototype.deleteRepository = ca({ * Perform a [snapshot.get](http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {Boolean} params.ignoreUnavailable - Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown * @param {String} params.repository - A repository name * @param {String, String[], Boolean} params.snapshot - A comma-separated list of snapshot names @@ -6352,7 +6352,7 @@ api.snapshot.prototype.get = ca({ * Perform a [snapshot.getRepository](http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false) * @param {String, String[], Boolean} params.repository - A comma-separated list of repository names */ @@ -6385,7 +6385,7 @@ api.snapshot.prototype.getRepository = ca({ * Perform a [snapshot.restore](http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {Boolean} params.waitForCompletion - Should this request wait until the operation has completed before returning * @param {String} params.repository - A repository name * @param {String} params.snapshot - A snapshot name @@ -6420,7 +6420,7 @@ api.snapshot.prototype.restore = ca({ * Perform a [snapshot.status](http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-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 {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node * @param {Boolean} params.ignoreUnavailable - Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown * @param {String} params.repository - A repository name * @param {String, String[], Boolean} params.snapshot - A comma-separated list of snapshot names @@ -6466,8 +6466,8 @@ api.snapshot.prototype.status = ca({ * Perform a [snapshot.verifyRepository](http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-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 {Date, Number} params.timeout - Explicit operation timeout + * @param {DurationString} params.masterTimeout - Explicit operation timeout for connection to master node + * @param {DurationString} params.timeout - Explicit operation timeout * @param {String} params.repository - A repository name */ api.snapshot.prototype.verifyRepository = ca({ @@ -6795,9 +6795,9 @@ api.termvectors = ca({ * @param {String} params.refresh - If `true` then refresh the effected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes. * @param {Number} params.retryOnConflict - Specify how many times should the operation be retried when a conflict occurs (default: 0) * @param {String} params.routing - Specific routing value - * @param {Date, Number} params.timeout - Explicit operation timeout - * @param {Date, Number} params.timestamp - Explicit timestamp for the document - * @param {Date, Number} params.ttl - Expiration time for the document + * @param {DurationString} params.timeout - Explicit operation timeout + * @param {DurationString} params.timestamp - Explicit timestamp for the document + * @param {DurationString} params.ttl - Expiration time for the document * @param {Number} params.version - Explicit version number for concurrency control * @param {String} params.versionType - Specific version type * @param {String} params.id - Document ID @@ -6902,9 +6902,9 @@ api.update = ca({ * @param {String} params.preference - Specify the node or shard the operation should be performed on (default: random) * @param {String} params.q - Query in the Lucene query string syntax * @param {String, String[], Boolean} params.routing - A comma-separated list of specific routing values - * @param {Date, Number} params.scroll - Specify how long a consistent view of the index should be maintained for scrolled search + * @param {DurationString} params.scroll - Specify how long a consistent view of the index should be maintained for scrolled search * @param {String} params.searchType - Search operation type - * @param {Date, Number} params.searchTimeout - Explicit timeout for each search request. Defaults to no timeout. + * @param {DurationString} params.searchTimeout - Explicit timeout for each search request. Defaults to no timeout. * @param {Number} params.size - Number of hits to return (default: 10) * @param {String, String[], Boolean} params.sort - A comma-separated list of : pairs * @param {String, String[], Boolean} params._source - True or false to return the _source field or not, or a list of fields to return @@ -6916,7 +6916,7 @@ api.update = ca({ * @param {Boolean} params.versionType - Should the document increment the version number (internal) on hit or not (reindex) * @param {Boolean} params.requestCache - Specify if request cache should be used for this request or not, defaults to index level setting * @param {Boolean} params.refresh - Should the effected indexes be refreshed? - * @param {Date, Number} [params.timeout=1m] - Time each individual bulk request should wait for shards that are unavailable. + * @param {DurationString} [params.timeout=1m] - Time each individual bulk request should wait for shards that are unavailable. * @param {String} params.waitForActiveShards - Sets the number of shard copies that must be active before proceeding with the update by query operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1) * @param {Number} params.scrollSize - Size on the scroll request powering the update_by_query * @param {Boolean} params.waitForCompletion - Should the request should block until the update by query operation is complete.