[docs] [api] updated to match spec
This commit is contained in:
Spencer Alger
@ -24,7 +24,7 @@ api.abortBenchmark = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [bulk](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-bulk.html) request
|
||||
* Perform a [bulk](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/docs-bulk.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} params.consistency - Explicit write consistency setting for the operation
|
||||
@ -147,7 +147,7 @@ api.cat.prototype.aliases = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.allocation](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cat-allocation.html) request
|
||||
* Perform a [cat.allocation](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/cat-allocation.html) request
|
||||
*
|
||||
* @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
|
||||
@ -204,7 +204,7 @@ api.cat.prototype.allocation = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.count](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cat-count.html) request
|
||||
* Perform a [cat.count](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/cat-count.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false)
|
||||
@ -311,7 +311,7 @@ api.cat.prototype.fielddata = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.health](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cat-health.html) request
|
||||
* Perform a [cat.health](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/cat-health.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false)
|
||||
@ -352,7 +352,7 @@ api.cat.prototype.health = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.help](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cat.html) request
|
||||
* Perform a [cat.help](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/cat.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.help - Return help information
|
||||
@ -370,7 +370,7 @@ api.cat.prototype.help = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.indices](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cat-indices.html) request
|
||||
* Perform a [cat.indices](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/cat-indices.html) request
|
||||
*
|
||||
* @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
|
||||
@ -432,7 +432,7 @@ api.cat.prototype.indices = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.master](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cat-master.html) request
|
||||
* Perform a [cat.master](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/cat-master.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false)
|
||||
@ -468,7 +468,7 @@ api.cat.prototype.master = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.nodes](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cat-nodes.html) request
|
||||
* Perform a [cat.nodes](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/cat-nodes.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false)
|
||||
@ -504,7 +504,7 @@ api.cat.prototype.nodes = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.pendingTasks](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cat-pending-tasks.html) request
|
||||
* Perform a [cat.pendingTasks](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/cat-pending-tasks.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false)
|
||||
@ -576,7 +576,7 @@ api.cat.prototype.plugins = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.recovery](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cat-recovery.html) request
|
||||
* Perform a [cat.recovery](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/cat-recovery.html) request
|
||||
*
|
||||
* @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
|
||||
@ -629,7 +629,7 @@ api.cat.prototype.recovery = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.shards](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cat-shards.html) request
|
||||
* Perform a [cat.shards](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/cat-shards.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false)
|
||||
@ -718,7 +718,7 @@ api.cat.prototype.threadPool = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [clearScroll](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-request-scroll.html) request
|
||||
* Perform a [clearScroll](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/search-request-scroll.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String, String[], Boolean} params.scrollId - A comma-separated list of scroll IDs to clear
|
||||
@ -745,7 +745,7 @@ api.cluster = function ClusterNS(transport) {
|
||||
};
|
||||
|
||||
/**
|
||||
* Perform a [cluster.getSettings](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cluster-update-settings.html) request
|
||||
* Perform a [cluster.getSettings](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/cluster-update-settings.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.flatSettings - Return settings in flat format (default: false)
|
||||
@ -772,7 +772,7 @@ api.cluster.prototype.getSettings = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cluster.health](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cluster-health.html) request
|
||||
* Perform a [cluster.health](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/cluster-health.html) request
|
||||
*
|
||||
* @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
|
||||
@ -845,7 +845,7 @@ api.cluster.prototype.health = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cluster.pendingTasks](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cluster-pending.html) request
|
||||
* Perform a [cluster.pendingTasks](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/cluster-pending.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false)
|
||||
@ -867,7 +867,7 @@ api.cluster.prototype.pendingTasks = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cluster.putSettings](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cluster-update-settings.html) request
|
||||
* Perform a [cluster.putSettings](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/cluster-update-settings.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.flatSettings - Return settings in flat format (default: false)
|
||||
@ -886,7 +886,7 @@ api.cluster.prototype.putSettings = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cluster.reroute](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cluster-reroute.html) request
|
||||
* Perform a [cluster.reroute](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/cluster-reroute.html) request
|
||||
*
|
||||
* @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
|
||||
@ -923,7 +923,7 @@ api.cluster.prototype.reroute = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cluster.state](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cluster-state.html) request
|
||||
* Perform a [cluster.state](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/cluster-state.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false)
|
||||
@ -991,7 +991,7 @@ api.cluster.prototype.state = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cluster.stats](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cluster-stats.html) request
|
||||
* Perform a [cluster.stats](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/cluster-stats.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.flatSettings - Return settings in flat format (default: false)
|
||||
@ -1025,7 +1025,7 @@ api.cluster.prototype.stats = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [count](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-count.html) request
|
||||
* Perform a [count](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/search-count.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
|
||||
@ -1099,7 +1099,7 @@ api.count = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [countPercolate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-percolate.html) request
|
||||
* Perform a [countPercolate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/search-percolate.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String, String[], Boolean} params.routing - A comma-separated list of specific routing values
|
||||
@ -1193,7 +1193,7 @@ api.countPercolate = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [delete](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-delete.html) request
|
||||
* Perform a [delete](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/docs-delete.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} params.consistency - Specific write consistency setting for the operation
|
||||
@ -1270,7 +1270,7 @@ api['delete'] = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [deleteByQuery](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-delete-by-query.html) request
|
||||
* Perform a [deleteByQuery](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/docs-delete-by-query.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} params.analyzer - The analyzer to use for the query string
|
||||
@ -1416,7 +1416,7 @@ api.deleteTemplate = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [exists](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-get.html) request
|
||||
* Perform a [exists](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/docs-get.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} params.parent - The ID of the parent document
|
||||
@ -1464,7 +1464,7 @@ api.exists = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [explain](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-explain.html) request
|
||||
* Perform a [explain](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/search-explain.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.analyzeWildcard - Specify whether wildcards and prefix queries in the query string query should be analyzed (default: false)
|
||||
@ -1562,7 +1562,7 @@ api.explain = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [get](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-get.html) request
|
||||
* Perform a [get](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/docs-get.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String, String[], Boolean} params.fields - A comma-separated list of fields to return in the response
|
||||
@ -1663,7 +1663,7 @@ api.getScript = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [getSource](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-get.html) request
|
||||
* Perform a [getSource](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/docs-get.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} params.parent - The ID of the parent document
|
||||
@ -1756,7 +1756,7 @@ api.getTemplate = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [index](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-index_.html) request
|
||||
* Perform a [index](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/docs-index_.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} params.consistency - Explicit write consistency setting for the operation
|
||||
@ -1868,7 +1868,7 @@ api.indices = function IndicesNS(transport) {
|
||||
};
|
||||
|
||||
/**
|
||||
* Perform a [indices.analyze](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-analyze.html) request
|
||||
* Perform a [indices.analyze](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/indices-analyze.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} params.analyzer - The name of the analyzer to use
|
||||
@ -1935,7 +1935,7 @@ api.indices.prototype.analyze = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.clearCache](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-clearcache.html) request
|
||||
* Perform a [indices.clearCache](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/indices-clearcache.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.fieldData - Clear field data
|
||||
@ -2023,7 +2023,7 @@ api.indices.prototype.clearCache = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.close](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-open-close.html) request
|
||||
* Perform a [indices.close](http://www.elasticsearch.org/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
|
||||
@ -2072,7 +2072,7 @@ api.indices.prototype.close = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.create](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-create-index.html) request
|
||||
* Perform a [indices.create](http://www.elasticsearch.org/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
|
||||
@ -2101,7 +2101,7 @@ api.indices.prototype.create = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.delete](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-delete-index.html) request
|
||||
* Perform a [indices.delete](http://www.elasticsearch.org/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
|
||||
@ -2130,7 +2130,7 @@ api.indices.prototype['delete'] = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.deleteAlias](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-aliases.html) request
|
||||
* Perform a [indices.deleteAlias](http://www.elasticsearch.org/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
|
||||
@ -2163,7 +2163,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
|
||||
* Perform a [indices.deleteMapping](http://www.elasticsearch.org/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
|
||||
@ -2192,7 +2192,7 @@ api.indices.prototype.deleteMapping = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.deleteTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-templates.html) request
|
||||
* Perform a [indices.deleteTemplate](http://www.elasticsearch.org/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
|
||||
@ -2221,7 +2221,7 @@ api.indices.prototype.deleteTemplate = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.deleteWarmer](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-warmers.html) request
|
||||
* Perform a [indices.deleteWarmer](http://www.elasticsearch.org/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
|
||||
@ -2253,7 +2253,7 @@ api.indices.prototype.deleteWarmer = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.exists](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-get-settings.html) request
|
||||
* Perform a [indices.exists](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/indices-get-settings.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
|
||||
@ -2297,7 +2297,7 @@ api.indices.prototype.exists = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.existsAlias](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-aliases.html) request
|
||||
* Perform a [indices.existsAlias](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/indices-aliases.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
|
||||
@ -2366,7 +2366,7 @@ api.indices.prototype.existsAlias = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.existsTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-templates.html) request
|
||||
* Perform a [indices.existsTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/indices-templates.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false)
|
||||
@ -2390,7 +2390,7 @@ api.indices.prototype.existsTemplate = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.existsType](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-types-exists.html) request
|
||||
* Perform a [indices.existsType](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/indices-types-exists.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
|
||||
@ -2438,7 +2438,7 @@ api.indices.prototype.existsType = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.flush](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-flush.html) request
|
||||
* Perform a [indices.flush](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/indices-flush.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.force - Whether a flush should be forced even if it is not necessarily needed ie. if no changes will be committed to the index. This is useful if transaction log IDs should be incremented even if no uncommitted changes are present. (This setting can be considered as internal)
|
||||
@ -2491,7 +2491,7 @@ api.indices.prototype.flush = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.getAlias](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-aliases.html) request
|
||||
* Perform a [indices.getAlias](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/indices-aliases.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
|
||||
@ -2559,7 +2559,7 @@ api.indices.prototype.getAlias = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.getAliases](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-aliases.html) request
|
||||
* Perform a [indices.getAliases](http://www.elasticsearch.org/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
|
||||
@ -2611,7 +2611,7 @@ api.indices.prototype.getAliases = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.getFieldMapping](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-get-field-mapping.html) request
|
||||
* Perform a [indices.getFieldMapping](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/indices-get-field-mapping.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.includeDefaults - Whether the default mapping values should be returned as well
|
||||
@ -2699,7 +2699,7 @@ api.indices.prototype.getFieldMapping = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.getMapping](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-get-mapping.html) request
|
||||
* Perform a [indices.getMapping](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/indices-get-mapping.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
|
||||
@ -2767,7 +2767,7 @@ api.indices.prototype.getMapping = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.getSettings](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-get-mapping.html) request
|
||||
* Perform a [indices.getSettings](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/indices-get-settings.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
|
||||
@ -2843,7 +2843,7 @@ api.indices.prototype.getSettings = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.getTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-templates.html) request
|
||||
* Perform a [indices.getTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/indices-templates.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.flatSettings - Return settings in flat format (default: false)
|
||||
@ -2876,7 +2876,7 @@ api.indices.prototype.getTemplate = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.getWarmer](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-warmers.html) request
|
||||
* Perform a [indices.getWarmer](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/indices-warmers.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
|
||||
@ -2959,7 +2959,7 @@ api.indices.prototype.getWarmer = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.open](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-open-close.html) request
|
||||
* Perform a [indices.open](http://www.elasticsearch.org/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
|
||||
@ -3008,7 +3008,7 @@ api.indices.prototype.open = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.optimize](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-optimize.html) request
|
||||
* Perform a [indices.optimize](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/indices-optimize.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.flush - Specify whether the index should be flushed after performing the operation (default: true)
|
||||
@ -3080,7 +3080,7 @@ api.indices.prototype.optimize = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.putAlias](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-aliases.html) request
|
||||
* Perform a [indices.putAlias](http://www.elasticsearch.org/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
|
||||
@ -3123,7 +3123,7 @@ api.indices.prototype.putAlias = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.putMapping](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-put-mapping.html) request
|
||||
* Perform a [indices.putMapping](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/indices-put-mapping.html) request
|
||||
*
|
||||
* @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)
|
||||
@ -3192,7 +3192,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
|
||||
* Perform a [indices.putSettings](http://www.elasticsearch.org/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
|
||||
@ -3248,7 +3248,7 @@ api.indices.prototype.putSettings = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.putTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-templates.html) request
|
||||
* Perform a [indices.putTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/indices-templates.html) request
|
||||
*
|
||||
* @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)
|
||||
@ -3292,7 +3292,7 @@ api.indices.prototype.putTemplate = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.putWarmer](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-warmers.html) request
|
||||
* Perform a [indices.putWarmer](http://www.elasticsearch.org/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
|
||||
@ -3407,7 +3407,7 @@ api.indices.prototype.recovery = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.refresh](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-refresh.html) request
|
||||
* Perform a [indices.refresh](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/indices-refresh.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
|
||||
@ -3461,7 +3461,7 @@ api.indices.prototype.refresh = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.segments](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-segments.html) request
|
||||
* Perform a [indices.segments](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/indices-segments.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
|
||||
@ -3514,7 +3514,7 @@ api.indices.prototype.segments = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.stats](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-stats.html) request
|
||||
* Perform a [indices.stats](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/indices-stats.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String, String[], Boolean} params.completionFields - A comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards)
|
||||
@ -3633,7 +3633,7 @@ api.indices.prototype.stats = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.status](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-status.html) request
|
||||
* Perform a [indices.status](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/indices-status.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
|
||||
@ -3694,7 +3694,7 @@ api.indices.prototype.status = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.updateAliases](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-aliases.html) request
|
||||
* Perform a [indices.updateAliases](http://www.elasticsearch.org/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
|
||||
@ -3718,7 +3718,7 @@ api.indices.prototype.updateAliases = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.validateQuery](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-validate.html) request
|
||||
* Perform a [indices.validateQuery](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/search-validate.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.explain - Return detailed information about the error
|
||||
@ -3836,7 +3836,7 @@ api.listBenchmarks = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [mget](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-multi-get.html) request
|
||||
* Perform a [mget](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/docs-multi-get.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String, String[], Boolean} params.fields - A comma-separated list of fields to return in the response
|
||||
@ -3904,7 +3904,7 @@ api.mget = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [mlt](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-more-like-this.html) request
|
||||
* Perform a [mlt](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/search-more-like-this.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Number} params.boostTerms - The boost factor
|
||||
@ -4026,7 +4026,7 @@ api.mlt = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [mpercolate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-percolate.html) request
|
||||
* Perform a [mpercolate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/search-percolate.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
|
||||
@ -4085,7 +4085,7 @@ api.mpercolate = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [msearch](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-multi-search.html) request
|
||||
* Perform a [msearch](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/search-multi-search.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} params.searchType - Search operation type
|
||||
@ -4137,7 +4137,7 @@ api.msearch = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [mtermvectors](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-multi-termvectors.html) request
|
||||
* Perform a [mtermvectors](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/docs-multi-termvectors.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String, String[], Boolean} params.ids - A comma-separated list of documents ids. You must define ids as parameter or set "ids" or "docs" in the request body
|
||||
@ -4236,7 +4236,7 @@ api.nodes = function NodesNS(transport) {
|
||||
};
|
||||
|
||||
/**
|
||||
* Perform a [nodes.hotThreads](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cluster-nodes-hot-threads.html) request
|
||||
* Perform a [nodes.hotThreads](http://www.elasticsearch.org/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
|
||||
@ -4281,7 +4281,7 @@ api.nodes.prototype.hotThreads = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [nodes.info](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cluster-nodes-info.html) request
|
||||
* Perform a [nodes.info](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/cluster-nodes-info.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.flatSettings - Return settings in flat format (default: false)
|
||||
@ -4357,7 +4357,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
|
||||
* Perform a [nodes.shutdown](http://www.elasticsearch.org/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)
|
||||
@ -4390,7 +4390,7 @@ api.nodes.prototype.shutdown = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [nodes.stats](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cluster-nodes-stats.html) request
|
||||
* Perform a [nodes.stats](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/cluster-nodes-stats.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String, String[], Boolean} params.completionFields - A comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards)
|
||||
@ -4587,7 +4587,7 @@ api.nodes.prototype.stats = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [percolate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-percolate.html) request
|
||||
* Perform a [percolate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/search-percolate.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String, String[], Boolean} params.routing - A comma-separated list of specific routing values
|
||||
@ -4736,7 +4736,7 @@ api.putTemplate = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [scroll](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-request-scroll.html) request
|
||||
* Perform a [scroll](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/search-request-scroll.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Duration} params.scroll - Specify how long a consistent view of the index should be maintained for scrolled search
|
||||
@ -4769,7 +4769,7 @@ api.scroll = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [search](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-search.html) request
|
||||
* Perform a [search](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/search-search.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} params.analyzer - The analyzer to use for the query string
|
||||
@ -5128,7 +5128,7 @@ api.snapshot = function SnapshotNS(transport) {
|
||||
};
|
||||
|
||||
/**
|
||||
* Perform a [snapshot.create](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/modules-snapshots.html) request
|
||||
* Perform a [snapshot.create](http://www.elasticsearch.org/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
|
||||
@ -5163,7 +5163,7 @@ api.snapshot.prototype.create = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [snapshot.createRepository](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/modules-snapshots.html) request
|
||||
* Perform a [snapshot.createRepository](http://www.elasticsearch.org/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
|
||||
@ -5193,7 +5193,7 @@ api.snapshot.prototype.createRepository = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [snapshot.delete](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/modules-snapshots.html) request
|
||||
* Perform a [snapshot.delete](http://www.elasticsearch.org/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
|
||||
@ -5222,7 +5222,7 @@ api.snapshot.prototype['delete'] = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [snapshot.deleteRepository](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/modules-snapshots.html) request
|
||||
* Perform a [snapshot.deleteRepository](http://www.elasticsearch.org/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
|
||||
@ -5251,7 +5251,7 @@ api.snapshot.prototype.deleteRepository = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [snapshot.get](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/modules-snapshots.html) request
|
||||
* Perform a [snapshot.get](http://www.elasticsearch.org/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
|
||||
@ -5279,7 +5279,7 @@ api.snapshot.prototype.get = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [snapshot.getRepository](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/modules-snapshots.html) request
|
||||
* Perform a [snapshot.getRepository](http://www.elasticsearch.org/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
|
||||
@ -5312,7 +5312,7 @@ api.snapshot.prototype.getRepository = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [snapshot.restore](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/modules-snapshots.html) request
|
||||
* Perform a [snapshot.restore](http://www.elasticsearch.org/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
|
||||
@ -5388,7 +5388,7 @@ api.snapshot.prototype.status = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [suggest](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-search.html) request
|
||||
* Perform a [suggest](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/search-suggesters.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
|
||||
@ -5446,7 +5446,7 @@ api.suggest = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [termvector](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-termvectors.html) request
|
||||
* Perform a [termvector](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/docs-termvectors.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.termStatistics - Specifies if total term frequency and document frequency should be returned.
|
||||
@ -5526,7 +5526,7 @@ api.termvector = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [update](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-update.html) request
|
||||
* Perform a [update](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/docs-update.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} params.consistency - Explicit write consistency setting for the operation
|
||||
@ -5624,7 +5624,7 @@ api.update = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [create](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-index_.html) request
|
||||
* Perform a [create](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/docs-index_.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} params.consistency - Explicit write consistency setting for the operation
|
||||
|
||||
@ -6,7 +6,7 @@ var api = module.exports = {};
|
||||
api._namespaces = ['cat', 'cluster', 'indices', 'nodes', 'snapshot'];
|
||||
|
||||
/**
|
||||
* Perform a [bulk](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-bulk.html) request
|
||||
* Perform a [bulk](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/docs-bulk.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} params.consistency - Explicit write consistency setting for the operation
|
||||
@ -129,7 +129,7 @@ api.cat.prototype.aliases = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.allocation](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cat-allocation.html) request
|
||||
* Perform a [cat.allocation](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/cat-allocation.html) request
|
||||
*
|
||||
* @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
|
||||
@ -186,7 +186,7 @@ api.cat.prototype.allocation = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.count](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cat-count.html) request
|
||||
* Perform a [cat.count](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/cat-count.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false)
|
||||
@ -293,7 +293,7 @@ api.cat.prototype.fielddata = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.health](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cat-health.html) request
|
||||
* Perform a [cat.health](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/cat-health.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false)
|
||||
@ -334,7 +334,7 @@ api.cat.prototype.health = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.help](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cat.html) request
|
||||
* Perform a [cat.help](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/cat.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.help - Return help information
|
||||
@ -352,7 +352,7 @@ api.cat.prototype.help = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.indices](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cat-indices.html) request
|
||||
* Perform a [cat.indices](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/cat-indices.html) request
|
||||
*
|
||||
* @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
|
||||
@ -414,7 +414,7 @@ api.cat.prototype.indices = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.master](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cat-master.html) request
|
||||
* Perform a [cat.master](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/cat-master.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false)
|
||||
@ -450,7 +450,7 @@ api.cat.prototype.master = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.nodes](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cat-nodes.html) request
|
||||
* Perform a [cat.nodes](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/cat-nodes.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false)
|
||||
@ -486,7 +486,7 @@ api.cat.prototype.nodes = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.pendingTasks](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cat-pending-tasks.html) request
|
||||
* Perform a [cat.pendingTasks](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/cat-pending-tasks.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false)
|
||||
@ -558,7 +558,7 @@ api.cat.prototype.plugins = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.recovery](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cat-recovery.html) request
|
||||
* Perform a [cat.recovery](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/cat-recovery.html) request
|
||||
*
|
||||
* @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
|
||||
@ -611,7 +611,7 @@ api.cat.prototype.recovery = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.shards](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cat-shards.html) request
|
||||
* Perform a [cat.shards](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/cat-shards.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false)
|
||||
@ -700,7 +700,7 @@ api.cat.prototype.threadPool = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [clearScroll](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-request-scroll.html) request
|
||||
* Perform a [clearScroll](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/search-request-scroll.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String, String[], Boolean} params.scrollId - A comma-separated list of scroll IDs to clear
|
||||
@ -727,7 +727,7 @@ api.cluster = function ClusterNS(transport) {
|
||||
};
|
||||
|
||||
/**
|
||||
* Perform a [cluster.getSettings](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cluster-update-settings.html) request
|
||||
* Perform a [cluster.getSettings](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/cluster-update-settings.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.flatSettings - Return settings in flat format (default: false)
|
||||
@ -754,7 +754,7 @@ api.cluster.prototype.getSettings = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cluster.health](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cluster-health.html) request
|
||||
* Perform a [cluster.health](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/cluster-health.html) request
|
||||
*
|
||||
* @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
|
||||
@ -827,7 +827,7 @@ api.cluster.prototype.health = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cluster.pendingTasks](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cluster-pending.html) request
|
||||
* Perform a [cluster.pendingTasks](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/cluster-pending.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false)
|
||||
@ -849,7 +849,7 @@ api.cluster.prototype.pendingTasks = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cluster.putSettings](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cluster-update-settings.html) request
|
||||
* Perform a [cluster.putSettings](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/cluster-update-settings.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.flatSettings - Return settings in flat format (default: false)
|
||||
@ -868,7 +868,7 @@ api.cluster.prototype.putSettings = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cluster.reroute](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cluster-reroute.html) request
|
||||
* Perform a [cluster.reroute](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/cluster-reroute.html) request
|
||||
*
|
||||
* @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
|
||||
@ -913,7 +913,7 @@ api.cluster.prototype.reroute = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cluster.state](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cluster-state.html) request
|
||||
* Perform a [cluster.state](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/cluster-state.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false)
|
||||
@ -981,7 +981,7 @@ api.cluster.prototype.state = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cluster.stats](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cluster-stats.html) request
|
||||
* Perform a [cluster.stats](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/cluster-stats.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.flatSettings - Return settings in flat format (default: false)
|
||||
@ -1015,7 +1015,7 @@ api.cluster.prototype.stats = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [count](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-count.html) request
|
||||
* Perform a [count](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/search-count.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
|
||||
@ -1089,7 +1089,7 @@ api.count = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [countPercolate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-percolate.html) request
|
||||
* Perform a [countPercolate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/search-percolate.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String, String[], Boolean} params.routing - A comma-separated list of specific routing values
|
||||
@ -1183,7 +1183,7 @@ api.countPercolate = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [delete](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-delete.html) request
|
||||
* Perform a [delete](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/docs-delete.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} params.consistency - Specific write consistency setting for the operation
|
||||
@ -1260,7 +1260,7 @@ api['delete'] = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [deleteByQuery](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-delete-by-query.html) request
|
||||
* Perform a [deleteByQuery](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/docs-delete-by-query.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} params.analyzer - The analyzer to use for the query string
|
||||
@ -1408,9 +1408,26 @@ api.deleteScript = ca({
|
||||
* Perform a [deleteTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-template.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Number} params.version - Explicit version number for concurrency control
|
||||
* @param {String} params.versionType - Specific version type
|
||||
* @param {String} params.id - Template ID
|
||||
*/
|
||||
api.deleteTemplate = ca({
|
||||
params: {
|
||||
version: {
|
||||
type: 'number'
|
||||
},
|
||||
versionType: {
|
||||
type: 'enum',
|
||||
options: [
|
||||
'internal',
|
||||
'external',
|
||||
'external_gte',
|
||||
'force'
|
||||
],
|
||||
name: 'version_type'
|
||||
}
|
||||
},
|
||||
url: {
|
||||
fmt: '/_search/template/<%=id%>',
|
||||
req: {
|
||||
@ -1423,7 +1440,7 @@ api.deleteTemplate = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [exists](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-get.html) request
|
||||
* Perform a [exists](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/docs-get.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} params.parent - The ID of the parent document
|
||||
@ -1471,7 +1488,7 @@ api.exists = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [explain](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-explain.html) request
|
||||
* Perform a [explain](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/search-explain.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.analyzeWildcard - Specify whether wildcards and prefix queries in the query string query should be analyzed (default: false)
|
||||
@ -1569,7 +1586,7 @@ api.explain = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [get](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-get.html) request
|
||||
* Perform a [get](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/docs-get.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String, String[], Boolean} params.fields - A comma-separated list of fields to return in the response
|
||||
@ -1687,7 +1704,7 @@ api.getScript = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [getSource](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-get.html) request
|
||||
* Perform a [getSource](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/docs-get.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} params.parent - The ID of the parent document
|
||||
@ -1797,7 +1814,7 @@ api.getTemplate = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [index](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-index_.html) request
|
||||
* Perform a [index](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/docs-index_.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} params.consistency - Explicit write consistency setting for the operation
|
||||
@ -1909,7 +1926,7 @@ api.indices = function IndicesNS(transport) {
|
||||
};
|
||||
|
||||
/**
|
||||
* Perform a [indices.analyze](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-analyze.html) request
|
||||
* Perform a [indices.analyze](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-analyze.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} params.analyzer - The name of the analyzer to use
|
||||
@ -1976,7 +1993,7 @@ api.indices.prototype.analyze = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.clearCache](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-clearcache.html) request
|
||||
* Perform a [indices.clearCache](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-clearcache.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.fieldData - Clear field data
|
||||
@ -2069,7 +2086,7 @@ api.indices.prototype.clearCache = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.close](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-open-close.html) request
|
||||
* Perform a [indices.close](http://www.elasticsearch.org/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
|
||||
@ -2118,7 +2135,7 @@ api.indices.prototype.close = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.create](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-create-index.html) request
|
||||
* Perform a [indices.create](http://www.elasticsearch.org/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
|
||||
@ -2147,7 +2164,7 @@ api.indices.prototype.create = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.delete](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-delete-index.html) request
|
||||
* Perform a [indices.delete](http://www.elasticsearch.org/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
|
||||
@ -2176,7 +2193,7 @@ api.indices.prototype['delete'] = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.deleteAlias](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-aliases.html) request
|
||||
* Perform a [indices.deleteAlias](http://www.elasticsearch.org/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
|
||||
@ -2209,7 +2226,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
|
||||
* Perform a [indices.deleteMapping](http://www.elasticsearch.org/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
|
||||
@ -2238,7 +2255,7 @@ api.indices.prototype.deleteMapping = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.deleteTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-templates.html) request
|
||||
* Perform a [indices.deleteTemplate](http://www.elasticsearch.org/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
|
||||
@ -2267,7 +2284,7 @@ api.indices.prototype.deleteTemplate = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.deleteWarmer](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-warmers.html) request
|
||||
* Perform a [indices.deleteWarmer](http://www.elasticsearch.org/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
|
||||
@ -2299,7 +2316,7 @@ api.indices.prototype.deleteWarmer = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.exists](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-exists.html) request
|
||||
* Perform a [indices.exists](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-exists.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
|
||||
@ -2343,7 +2360,7 @@ api.indices.prototype.exists = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.existsAlias](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-aliases.html) request
|
||||
* Perform a [indices.existsAlias](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-aliases.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
|
||||
@ -2412,7 +2429,7 @@ api.indices.prototype.existsAlias = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.existsTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-templates.html) request
|
||||
* Perform a [indices.existsTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-templates.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false)
|
||||
@ -2436,7 +2453,7 @@ api.indices.prototype.existsTemplate = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.existsType](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-types-exists.html) request
|
||||
* Perform a [indices.existsType](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-types-exists.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
|
||||
@ -2484,7 +2501,7 @@ api.indices.prototype.existsType = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.flush](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-flush.html) request
|
||||
* Perform a [indices.flush](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-flush.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.force - Whether a flush should be forced even if it is not necessarily needed ie. if no changes will be committed to the index. This is useful if transaction log IDs should be incremented even if no uncommitted changes are present. (This setting can be considered as internal)
|
||||
@ -2542,7 +2559,7 @@ api.indices.prototype.flush = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.get](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-get-index.html) request
|
||||
* Perform a [indices.get](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-get-index.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false)
|
||||
@ -2594,7 +2611,7 @@ api.indices.prototype.get = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.getAlias](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-aliases.html) request
|
||||
* Perform a [indices.getAlias](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-aliases.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
|
||||
@ -2662,7 +2679,7 @@ api.indices.prototype.getAlias = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.getAliases](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-aliases.html) request
|
||||
* Perform a [indices.getAliases](http://www.elasticsearch.org/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
|
||||
@ -2714,7 +2731,7 @@ api.indices.prototype.getAliases = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.getFieldMapping](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-get-field-mapping.html) request
|
||||
* Perform a [indices.getFieldMapping](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-get-field-mapping.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.includeDefaults - Whether the default mapping values should be returned as well
|
||||
@ -2802,7 +2819,7 @@ api.indices.prototype.getFieldMapping = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.getMapping](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-get-mapping.html) request
|
||||
* Perform a [indices.getMapping](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-get-mapping.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
|
||||
@ -2870,7 +2887,7 @@ api.indices.prototype.getMapping = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.getSettings](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-get-mapping.html) request
|
||||
* Perform a [indices.getSettings](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-get-settings.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
|
||||
@ -2946,7 +2963,7 @@ api.indices.prototype.getSettings = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.getTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-templates.html) request
|
||||
* Perform a [indices.getTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-templates.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.flatSettings - Return settings in flat format (default: false)
|
||||
@ -3028,7 +3045,7 @@ api.indices.prototype.getUpgrade = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.getWarmer](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-warmers.html) request
|
||||
* Perform a [indices.getWarmer](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-warmers.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
|
||||
@ -3111,7 +3128,7 @@ api.indices.prototype.getWarmer = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.open](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-open-close.html) request
|
||||
* Perform a [indices.open](http://www.elasticsearch.org/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
|
||||
@ -3160,7 +3177,7 @@ api.indices.prototype.open = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.optimize](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-optimize.html) request
|
||||
* Perform a [indices.optimize](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-optimize.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.flush - Specify whether the index should be flushed after performing the operation (default: true)
|
||||
@ -3232,7 +3249,7 @@ api.indices.prototype.optimize = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.putAlias](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-aliases.html) request
|
||||
* Perform a [indices.putAlias](http://www.elasticsearch.org/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
|
||||
@ -3275,7 +3292,7 @@ api.indices.prototype.putAlias = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.putMapping](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-put-mapping.html) request
|
||||
* Perform a [indices.putMapping](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-put-mapping.html) request
|
||||
*
|
||||
* @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)
|
||||
@ -3344,7 +3361,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
|
||||
* Perform a [indices.putSettings](http://www.elasticsearch.org/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
|
||||
@ -3400,7 +3417,7 @@ api.indices.prototype.putSettings = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.putTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-templates.html) request
|
||||
* Perform a [indices.putTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-templates.html) request
|
||||
*
|
||||
* @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)
|
||||
@ -3444,7 +3461,7 @@ api.indices.prototype.putTemplate = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.putWarmer](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-warmers.html) request
|
||||
* Perform a [indices.putWarmer](http://www.elasticsearch.org/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
|
||||
@ -3559,7 +3576,7 @@ api.indices.prototype.recovery = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.refresh](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-refresh.html) request
|
||||
* Perform a [indices.refresh](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-refresh.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
|
||||
@ -3613,7 +3630,7 @@ api.indices.prototype.refresh = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.segments](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-segments.html) request
|
||||
* Perform a [indices.segments](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-segments.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
|
||||
@ -3666,7 +3683,7 @@ api.indices.prototype.segments = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.stats](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-stats.html) request
|
||||
* Perform a [indices.stats](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-stats.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String, String[], Boolean} params.completionFields - A comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards)
|
||||
@ -3787,7 +3804,7 @@ api.indices.prototype.stats = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.status](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-status.html) request
|
||||
* Perform a [indices.status](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-status.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
|
||||
@ -3848,7 +3865,7 @@ api.indices.prototype.status = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.updateAliases](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-aliases.html) request
|
||||
* Perform a [indices.updateAliases](http://www.elasticsearch.org/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
|
||||
@ -3922,7 +3939,7 @@ api.indices.prototype.upgrade = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.validateQuery](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-validate.html) request
|
||||
* Perform a [indices.validateQuery](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/search-validate.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.explain - Return detailed information about the error
|
||||
@ -4006,7 +4023,7 @@ api.info = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [mget](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-multi-get.html) request
|
||||
* Perform a [mget](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/docs-multi-get.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String, String[], Boolean} params.fields - A comma-separated list of fields to return in the response
|
||||
@ -4074,7 +4091,7 @@ api.mget = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [mlt](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-more-like-this.html) request
|
||||
* Perform a [mlt](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/search-more-like-this.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Number} params.boostTerms - The boost factor
|
||||
@ -4191,7 +4208,7 @@ api.mlt = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [mpercolate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-percolate.html) request
|
||||
* Perform a [mpercolate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/search-percolate.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
|
||||
@ -4250,7 +4267,7 @@ api.mpercolate = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [msearch](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-multi-search.html) request
|
||||
* Perform a [msearch](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/search-multi-search.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} params.searchType - Search operation type
|
||||
@ -4302,7 +4319,7 @@ api.msearch = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [mtermvectors](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-multi-termvectors.html) request
|
||||
* Perform a [mtermvectors](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/docs-multi-termvectors.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String, String[], Boolean} params.ids - A comma-separated list of documents ids. You must define ids as parameter or set "ids" or "docs" in the request body
|
||||
@ -4401,7 +4418,7 @@ api.nodes = function NodesNS(transport) {
|
||||
};
|
||||
|
||||
/**
|
||||
* Perform a [nodes.hotThreads](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cluster-nodes-hot-threads.html) request
|
||||
* Perform a [nodes.hotThreads](http://www.elasticsearch.org/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
|
||||
@ -4446,7 +4463,7 @@ api.nodes.prototype.hotThreads = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [nodes.info](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cluster-nodes-info.html) request
|
||||
* Perform a [nodes.info](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/cluster-nodes-info.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.flatSettings - Return settings in flat format (default: false)
|
||||
@ -4522,7 +4539,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
|
||||
* Perform a [nodes.shutdown](http://www.elasticsearch.org/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)
|
||||
@ -4555,7 +4572,7 @@ api.nodes.prototype.shutdown = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [nodes.stats](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cluster-nodes-stats.html) request
|
||||
* Perform a [nodes.stats](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/cluster-nodes-stats.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String, String[], Boolean} params.completionFields - A comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards)
|
||||
@ -4754,7 +4771,7 @@ api.nodes.prototype.stats = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [percolate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-percolate.html) request
|
||||
* Perform a [percolate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/search-percolate.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String, String[], Boolean} params.routing - A comma-separated list of specific routing values
|
||||
@ -4932,9 +4949,36 @@ api.putScript = ca({
|
||||
* Perform a [putTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-template.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} [params.opType=index] - Explicit operation type
|
||||
* @param {Number} params.version - Explicit version number for concurrency control
|
||||
* @param {String} params.versionType - Specific version type
|
||||
* @param {String} params.id - Template ID
|
||||
*/
|
||||
api.putTemplate = ca({
|
||||
params: {
|
||||
opType: {
|
||||
type: 'enum',
|
||||
'default': 'index',
|
||||
options: [
|
||||
'index',
|
||||
'create'
|
||||
],
|
||||
name: 'op_type'
|
||||
},
|
||||
version: {
|
||||
type: 'number'
|
||||
},
|
||||
versionType: {
|
||||
type: 'enum',
|
||||
options: [
|
||||
'internal',
|
||||
'external',
|
||||
'external_gte',
|
||||
'force'
|
||||
],
|
||||
name: 'version_type'
|
||||
}
|
||||
},
|
||||
url: {
|
||||
fmt: '/_search/template/<%=id%>',
|
||||
req: {
|
||||
@ -4948,7 +4992,7 @@ api.putTemplate = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [scroll](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-request-scroll.html) request
|
||||
* Perform a [scroll](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/search-request-scroll.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Duration} params.scroll - Specify how long a consistent view of the index should be maintained for scrolled search
|
||||
@ -4981,7 +5025,7 @@ api.scroll = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [search](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-search.html) request
|
||||
* Perform a [search](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/search-search.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} params.analyzer - The analyzer to use for the query string
|
||||
@ -5190,7 +5234,7 @@ api.search = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [searchExists](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/exists.html) request
|
||||
* Perform a [searchExists](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-exists.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
|
||||
@ -5419,7 +5463,7 @@ api.snapshot = function SnapshotNS(transport) {
|
||||
};
|
||||
|
||||
/**
|
||||
* Perform a [snapshot.create](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/modules-snapshots.html) request
|
||||
* Perform a [snapshot.create](http://www.elasticsearch.org/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
|
||||
@ -5454,7 +5498,7 @@ api.snapshot.prototype.create = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [snapshot.createRepository](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/modules-snapshots.html) request
|
||||
* Perform a [snapshot.createRepository](http://www.elasticsearch.org/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
|
||||
@ -5488,7 +5532,7 @@ api.snapshot.prototype.createRepository = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [snapshot.delete](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/modules-snapshots.html) request
|
||||
* Perform a [snapshot.delete](http://www.elasticsearch.org/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
|
||||
@ -5517,7 +5561,7 @@ api.snapshot.prototype['delete'] = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [snapshot.deleteRepository](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/modules-snapshots.html) request
|
||||
* Perform a [snapshot.deleteRepository](http://www.elasticsearch.org/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
|
||||
@ -5546,7 +5590,7 @@ api.snapshot.prototype.deleteRepository = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [snapshot.get](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/modules-snapshots.html) request
|
||||
* Perform a [snapshot.get](http://www.elasticsearch.org/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
|
||||
@ -5574,7 +5618,7 @@ api.snapshot.prototype.get = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [snapshot.getRepository](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/modules-snapshots.html) request
|
||||
* Perform a [snapshot.getRepository](http://www.elasticsearch.org/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
|
||||
@ -5607,7 +5651,7 @@ api.snapshot.prototype.getRepository = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [snapshot.restore](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/modules-snapshots.html) request
|
||||
* Perform a [snapshot.restore](http://www.elasticsearch.org/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
|
||||
@ -5712,7 +5756,7 @@ api.snapshot.prototype.verifyRepository = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [suggest](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-search.html) request
|
||||
* Perform a [suggest](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/search-suggesters.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
|
||||
@ -5770,7 +5814,7 @@ api.suggest = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [termvector](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-termvectors.html) request
|
||||
* Perform a [termvector](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/docs-termvectors.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.termStatistics - Specifies if total term frequency and document frequency should be returned.
|
||||
@ -5850,7 +5894,7 @@ api.termvector = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [update](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-update.html) request
|
||||
* Perform a [update](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/docs-update.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} params.consistency - Explicit write consistency setting for the operation
|
||||
@ -5957,7 +6001,7 @@ api.update = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [create](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-index_.html) request
|
||||
* Perform a [create](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/docs-index_.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} params.consistency - Explicit write consistency setting for the operation
|
||||
|
||||
@ -1408,9 +1408,26 @@ api.deleteScript = ca({
|
||||
* Perform a [deleteTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-template.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Number} params.version - Explicit version number for concurrency control
|
||||
* @param {String} params.versionType - Specific version type
|
||||
* @param {String} params.id - Template ID
|
||||
*/
|
||||
api.deleteTemplate = ca({
|
||||
params: {
|
||||
version: {
|
||||
type: 'number'
|
||||
},
|
||||
versionType: {
|
||||
type: 'enum',
|
||||
options: [
|
||||
'internal',
|
||||
'external',
|
||||
'external_gte',
|
||||
'force'
|
||||
],
|
||||
name: 'version_type'
|
||||
}
|
||||
},
|
||||
url: {
|
||||
fmt: '/_search/template/<%=id%>',
|
||||
req: {
|
||||
@ -2870,7 +2887,7 @@ api.indices.prototype.getMapping = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.getSettings](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-get-mapping.html) request
|
||||
* Perform a [indices.getSettings](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-get-settings.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
|
||||
@ -4927,9 +4944,36 @@ api.putScript = ca({
|
||||
* Perform a [putTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-template.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} [params.opType=index] - Explicit operation type
|
||||
* @param {Number} params.version - Explicit version number for concurrency control
|
||||
* @param {String} params.versionType - Specific version type
|
||||
* @param {String} params.id - Template ID
|
||||
*/
|
||||
api.putTemplate = ca({
|
||||
params: {
|
||||
opType: {
|
||||
type: 'enum',
|
||||
'default': 'index',
|
||||
options: [
|
||||
'index',
|
||||
'create'
|
||||
],
|
||||
name: 'op_type'
|
||||
},
|
||||
version: {
|
||||
type: 'number'
|
||||
},
|
||||
versionType: {
|
||||
type: 'enum',
|
||||
options: [
|
||||
'internal',
|
||||
'external',
|
||||
'external_gte',
|
||||
'force'
|
||||
],
|
||||
name: 'version_type'
|
||||
}
|
||||
},
|
||||
url: {
|
||||
fmt: '/_search/template/<%=id%>',
|
||||
req: {
|
||||
@ -5185,7 +5229,7 @@ api.search = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [searchExists](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/exists.html) request
|
||||
* Perform a [searchExists](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-exists.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
|
||||
@ -5707,7 +5751,7 @@ api.snapshot.prototype.verifyRepository = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [suggest](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-search.html) request
|
||||
* Perform a [suggest](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-suggesters.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
|
||||
|
||||
@ -1467,9 +1467,26 @@ api.deleteScript = ca({
|
||||
* Perform a [deleteTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-template.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Number} params.version - Explicit version number for concurrency control
|
||||
* @param {String} params.versionType - Specific version type
|
||||
* @param {String} params.id - Template ID
|
||||
*/
|
||||
api.deleteTemplate = ca({
|
||||
params: {
|
||||
version: {
|
||||
type: 'number'
|
||||
},
|
||||
versionType: {
|
||||
type: 'enum',
|
||||
options: [
|
||||
'internal',
|
||||
'external',
|
||||
'external_gte',
|
||||
'force'
|
||||
],
|
||||
name: 'version_type'
|
||||
}
|
||||
},
|
||||
url: {
|
||||
fmt: '/_search/template/<%=id%>',
|
||||
req: {
|
||||
@ -2929,7 +2946,7 @@ api.indices.prototype.getMapping = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.getSettings](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/indices-get-mapping.html) request
|
||||
* Perform a [indices.getSettings](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/indices-get-settings.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
|
||||
@ -4955,9 +4972,36 @@ api.putScript = ca({
|
||||
* Perform a [putTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-template.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} [params.opType=index] - Explicit operation type
|
||||
* @param {Number} params.version - Explicit version number for concurrency control
|
||||
* @param {String} params.versionType - Specific version type
|
||||
* @param {String} params.id - Template ID
|
||||
*/
|
||||
api.putTemplate = ca({
|
||||
params: {
|
||||
opType: {
|
||||
type: 'enum',
|
||||
'default': 'index',
|
||||
options: [
|
||||
'index',
|
||||
'create'
|
||||
],
|
||||
name: 'op_type'
|
||||
},
|
||||
version: {
|
||||
type: 'number'
|
||||
},
|
||||
versionType: {
|
||||
type: 'enum',
|
||||
options: [
|
||||
'internal',
|
||||
'external',
|
||||
'external_gte',
|
||||
'force'
|
||||
],
|
||||
name: 'version_type'
|
||||
}
|
||||
},
|
||||
url: {
|
||||
fmt: '/_search/template/<%=id%>',
|
||||
req: {
|
||||
@ -5208,7 +5252,7 @@ api.search = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [searchExists](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/exists.html) request
|
||||
* Perform a [searchExists](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-exists.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
|
||||
@ -5730,7 +5774,7 @@ api.snapshot.prototype.verifyRepository = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [suggest](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-search.html) request
|
||||
* Perform a [suggest](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-suggesters.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
|
||||
|
||||
Reference in New Issue
Block a user