[apis] [docs] regenerate
This commit is contained in:
spalger
@ -7,7 +7,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.1/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
|
||||
@ -128,7 +128,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.1/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
|
||||
@ -185,7 +185,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.1/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)
|
||||
@ -232,7 +232,7 @@ api.cat.prototype.count = 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.1/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)
|
||||
@ -273,7 +273,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.1/cat.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.help - Return help information
|
||||
@ -291,7 +291,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.1/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
|
||||
@ -353,7 +353,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.1/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)
|
||||
@ -389,7 +389,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.1/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)
|
||||
@ -425,7 +425,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.1/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)
|
||||
@ -461,7 +461,7 @@ api.cat.prototype.pendingTasks = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.plugins](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-plugins.html) request
|
||||
* Perform a [cat.plugins](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/cat-plugins.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)
|
||||
@ -497,7 +497,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.1/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
|
||||
@ -550,7 +550,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.1/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)
|
||||
@ -597,7 +597,7 @@ api.cat.prototype.shards = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.threadPool](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-thread-pool.html) request
|
||||
* Perform a [cat.threadPool](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/cat-thread-pool.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false)
|
||||
@ -639,7 +639,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.1/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
|
||||
@ -664,7 +664,7 @@ api.clearScroll = ca({
|
||||
api.cluster = namespace();
|
||||
|
||||
/**
|
||||
* 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.1/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)
|
||||
@ -691,7 +691,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.1/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
|
||||
@ -764,7 +764,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.1/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)
|
||||
@ -786,7 +786,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.1/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)
|
||||
@ -805,7 +805,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.1/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
|
||||
@ -842,7 +842,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.1/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)
|
||||
@ -915,7 +915,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.1/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)
|
||||
@ -949,7 +949,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.1/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)
|
||||
@ -1023,7 +1023,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.1/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
|
||||
@ -1117,7 +1117,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.1/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
|
||||
@ -1194,7 +1194,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.1/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
|
||||
@ -1300,7 +1300,7 @@ api.deleteByQuery = 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.1/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
|
||||
@ -1348,7 +1348,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.1/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)
|
||||
@ -1446,7 +1446,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.1/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
|
||||
@ -1526,7 +1526,7 @@ api.get = 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.1/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
|
||||
@ -1602,7 +1602,7 @@ api.getSource = 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.1/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
|
||||
@ -1712,7 +1712,7 @@ api.index = ca({
|
||||
api.indices = namespace();
|
||||
|
||||
/**
|
||||
* 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.1/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
|
||||
@ -1779,7 +1779,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.1/indices-clearcache.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.fieldData - Clear field data
|
||||
@ -1867,7 +1867,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.1/indices-open-close.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.timeout - Explicit operation timeout
|
||||
@ -1916,7 +1916,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.1/indices-create-index.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.timeout - Explicit operation timeout
|
||||
@ -1945,7 +1945,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.1/indices-delete-index.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.timeout - Explicit operation timeout
|
||||
@ -1974,7 +1974,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.1/indices-aliases.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.timeout - Explicit timestamp for the document
|
||||
@ -2007,7 +2007,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.1/indices-delete-mapping.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Specify timeout for connection to master
|
||||
@ -2036,7 +2036,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.1/indices-templates.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.timeout - Explicit operation timeout
|
||||
@ -2065,7 +2065,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.1/indices-warmers.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Specify timeout for connection to master
|
||||
@ -2097,7 +2097,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.1/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)
|
||||
@ -2141,7 +2141,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.1/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)
|
||||
@ -2210,7 +2210,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.1/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)
|
||||
@ -2234,7 +2234,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.1/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)
|
||||
@ -2282,7 +2282,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.1/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)
|
||||
@ -2335,7 +2335,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.1/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)
|
||||
@ -2403,7 +2403,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.1/indices-aliases.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.timeout - Explicit operation timeout
|
||||
@ -2455,7 +2455,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.1/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
|
||||
@ -2543,7 +2543,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.1/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)
|
||||
@ -2611,7 +2611,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.1/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)
|
||||
@ -2687,7 +2687,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.1/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)
|
||||
@ -2720,7 +2720,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.1/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)
|
||||
@ -2803,7 +2803,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.1/indices-open-close.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.timeout - Explicit operation timeout
|
||||
@ -2852,7 +2852,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.1/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)
|
||||
@ -2924,7 +2924,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.1/indices-aliases.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.timeout - Explicit timestamp for the document
|
||||
@ -2967,7 +2967,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.1/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)
|
||||
@ -3036,7 +3036,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.1/indices-update-settings.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Specify timeout for connection to master
|
||||
@ -3092,7 +3092,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.1/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)
|
||||
@ -3131,7 +3131,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.1/indices-warmers.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Specify timeout for connection to master
|
||||
@ -3206,7 +3206,7 @@ api.indices.prototype.putWarmer = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.recovery](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/indices-recovery.html) request
|
||||
* Perform a [indices.recovery](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/indices-recovery.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.detailed - Whether to display detailed information about shard recovery
|
||||
@ -3246,7 +3246,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.1/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)
|
||||
@ -3300,7 +3300,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.1/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)
|
||||
@ -3353,7 +3353,7 @@ api.indices.prototype.segments = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.snapshotIndex](http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-gateway-snapshot.html) request
|
||||
* Perform a [indices.snapshotIndex](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/indices-gateway-snapshot.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)
|
||||
@ -3398,7 +3398,7 @@ api.indices.prototype.snapshotIndex = 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.1/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)
|
||||
@ -3515,7 +3515,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.1/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)
|
||||
@ -3576,7 +3576,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.1/indices-aliases.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.timeout - Request timeout
|
||||
@ -3600,7 +3600,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.1/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
|
||||
@ -3684,7 +3684,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.1/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
|
||||
@ -3752,7 +3752,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.1/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
|
||||
@ -3874,7 +3874,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.1/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)
|
||||
@ -3933,7 +3933,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.1/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
|
||||
@ -3985,7 +3985,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.1/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
|
||||
@ -4082,7 +4082,7 @@ api.mtermvectors = ca({
|
||||
api.nodes = namespace();
|
||||
|
||||
/**
|
||||
* 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.1/cluster-nodes-hot-threads.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.interval - The interval for the second sampling of threads
|
||||
@ -4127,7 +4127,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.1/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)
|
||||
@ -4203,7 +4203,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.1/cluster-nodes-shutdown.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.delay - Set the delay for the operation (default: 1s)
|
||||
@ -4236,7 +4236,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.1/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)
|
||||
@ -4431,7 +4431,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.1/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
|
||||
@ -4538,7 +4538,7 @@ api.ping = 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.1/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
|
||||
@ -4572,7 +4572,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.1/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
|
||||
@ -4776,7 +4776,7 @@ api.search = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [searchTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-search.html) request
|
||||
* Perform a [searchTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/search-search.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String, String[], Boolean} params.index - A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
|
||||
@ -4811,7 +4811,7 @@ api.searchTemplate = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [searchShards](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-shards.html) request
|
||||
* Perform a [searchShards](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/search-shards.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} params.preference - Specify the node or shard the operation should be performed on (default: random)
|
||||
@ -4882,7 +4882,7 @@ api.searchShards = ca({
|
||||
api.snapshot = namespace();
|
||||
|
||||
/**
|
||||
* 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.1/modules-snapshots.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node
|
||||
@ -4917,7 +4917,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.1/modules-snapshots.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node
|
||||
@ -4947,7 +4947,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.1/modules-snapshots.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node
|
||||
@ -4976,7 +4976,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.1/modules-snapshots.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node
|
||||
@ -5005,7 +5005,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.1/modules-snapshots.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node
|
||||
@ -5033,7 +5033,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.1/modules-snapshots.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node
|
||||
@ -5066,7 +5066,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.1/modules-snapshots.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node
|
||||
@ -5101,7 +5101,7 @@ api.snapshot.prototype.restore = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [snapshot.status](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-snapshots.html) request
|
||||
* Perform a [snapshot.status](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/modules-snapshots.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node
|
||||
@ -5142,7 +5142,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.1/search-search.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)
|
||||
@ -5200,7 +5200,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.1/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.
|
||||
@ -5280,7 +5280,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.1/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
|
||||
@ -5380,7 +5380,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.1/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
|
||||
|
||||
@ -7,7 +7,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.2/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
|
||||
@ -128,7 +128,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.2/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
|
||||
@ -185,7 +185,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.2/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)
|
||||
@ -232,7 +232,7 @@ api.cat.prototype.count = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.fielddata](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-fielddata.html) request
|
||||
* Perform a [cat.fielddata](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/cat-fielddata.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
|
||||
@ -292,7 +292,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.2/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)
|
||||
@ -333,7 +333,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.2/cat.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.help - Return help information
|
||||
@ -351,7 +351,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.2/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
|
||||
@ -413,7 +413,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.2/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)
|
||||
@ -449,7 +449,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.2/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)
|
||||
@ -485,7 +485,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.2/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)
|
||||
@ -521,7 +521,7 @@ api.cat.prototype.pendingTasks = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.plugins](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-plugins.html) request
|
||||
* Perform a [cat.plugins](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/cat-plugins.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)
|
||||
@ -557,7 +557,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.2/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
|
||||
@ -610,7 +610,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.2/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)
|
||||
@ -657,7 +657,7 @@ api.cat.prototype.shards = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.threadPool](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-thread-pool.html) request
|
||||
* Perform a [cat.threadPool](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/cat-thread-pool.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false)
|
||||
@ -699,7 +699,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.2/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
|
||||
@ -724,7 +724,7 @@ api.clearScroll = ca({
|
||||
api.cluster = namespace();
|
||||
|
||||
/**
|
||||
* 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.2/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)
|
||||
@ -751,7 +751,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.2/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
|
||||
@ -824,7 +824,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.2/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)
|
||||
@ -846,7 +846,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.2/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)
|
||||
@ -865,7 +865,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.2/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
|
||||
@ -902,7 +902,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.2/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)
|
||||
@ -970,7 +970,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.2/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)
|
||||
@ -1004,7 +1004,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.2/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)
|
||||
@ -1078,7 +1078,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.2/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
|
||||
@ -1172,7 +1172,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.2/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
|
||||
@ -1249,7 +1249,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.2/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
|
||||
@ -1355,7 +1355,7 @@ api.deleteByQuery = 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.2/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
|
||||
@ -1403,7 +1403,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.2/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)
|
||||
@ -1501,7 +1501,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.2/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
|
||||
@ -1581,7 +1581,7 @@ api.get = 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.2/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
|
||||
@ -1657,7 +1657,7 @@ api.getSource = 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.2/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
|
||||
@ -1767,7 +1767,7 @@ api.index = ca({
|
||||
api.indices = namespace();
|
||||
|
||||
/**
|
||||
* 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.2/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
|
||||
@ -1834,7 +1834,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.2/indices-clearcache.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.fieldData - Clear field data
|
||||
@ -1922,7 +1922,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.2/indices-open-close.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.timeout - Explicit operation timeout
|
||||
@ -1971,7 +1971,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.2/indices-create-index.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.timeout - Explicit operation timeout
|
||||
@ -2000,7 +2000,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.2/indices-delete-index.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.timeout - Explicit operation timeout
|
||||
@ -2029,7 +2029,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.2/indices-aliases.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.timeout - Explicit timestamp for the document
|
||||
@ -2062,7 +2062,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.2/indices-delete-mapping.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Specify timeout for connection to master
|
||||
@ -2091,7 +2091,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.2/indices-templates.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.timeout - Explicit operation timeout
|
||||
@ -2120,7 +2120,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.2/indices-warmers.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Specify timeout for connection to master
|
||||
@ -2152,7 +2152,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.2/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)
|
||||
@ -2196,7 +2196,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.2/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)
|
||||
@ -2265,7 +2265,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.2/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)
|
||||
@ -2289,7 +2289,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.2/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)
|
||||
@ -2337,7 +2337,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.2/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)
|
||||
@ -2390,7 +2390,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.2/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)
|
||||
@ -2458,7 +2458,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.2/indices-aliases.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.timeout - Explicit operation timeout
|
||||
@ -2510,7 +2510,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.2/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
|
||||
@ -2598,7 +2598,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.2/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)
|
||||
@ -2666,7 +2666,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.2/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)
|
||||
@ -2742,7 +2742,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.2/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)
|
||||
@ -2775,7 +2775,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.2/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)
|
||||
@ -2858,7 +2858,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.2/indices-open-close.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.timeout - Explicit operation timeout
|
||||
@ -2907,7 +2907,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.2/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)
|
||||
@ -2979,7 +2979,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.2/indices-aliases.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.timeout - Explicit timestamp for the document
|
||||
@ -3022,7 +3022,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.2/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)
|
||||
@ -3091,7 +3091,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.2/indices-update-settings.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Specify timeout for connection to master
|
||||
@ -3147,7 +3147,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.2/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)
|
||||
@ -3186,7 +3186,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.2/indices-warmers.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Specify timeout for connection to master
|
||||
@ -3261,7 +3261,7 @@ api.indices.prototype.putWarmer = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.recovery](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/indices-recovery.html) request
|
||||
* Perform a [indices.recovery](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/indices-recovery.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.detailed - Whether to display detailed information about shard recovery
|
||||
@ -3301,7 +3301,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.2/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)
|
||||
@ -3355,7 +3355,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.2/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)
|
||||
@ -3408,7 +3408,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.2/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)
|
||||
@ -3527,7 +3527,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.2/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)
|
||||
@ -3588,7 +3588,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.2/indices-aliases.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.timeout - Request timeout
|
||||
@ -3612,7 +3612,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.2/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
|
||||
@ -3696,7 +3696,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.2/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
|
||||
@ -3764,7 +3764,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.2/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
|
||||
@ -3886,7 +3886,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.2/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)
|
||||
@ -3945,7 +3945,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.2/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
|
||||
@ -3997,7 +3997,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.2/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
|
||||
@ -4094,7 +4094,7 @@ api.mtermvectors = ca({
|
||||
api.nodes = namespace();
|
||||
|
||||
/**
|
||||
* 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.2/cluster-nodes-hot-threads.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.interval - The interval for the second sampling of threads
|
||||
@ -4139,7 +4139,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.2/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)
|
||||
@ -4215,7 +4215,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.2/cluster-nodes-shutdown.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.delay - Set the delay for the operation (default: 1s)
|
||||
@ -4248,7 +4248,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.2/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)
|
||||
@ -4445,7 +4445,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.2/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
|
||||
@ -4552,7 +4552,7 @@ api.ping = 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.2/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
|
||||
@ -4586,7 +4586,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.2/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
|
||||
@ -4790,7 +4790,7 @@ api.search = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [searchShards](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-shards.html) request
|
||||
* Perform a [searchShards](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/search-shards.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} params.preference - Specify the node or shard the operation should be performed on (default: random)
|
||||
@ -4859,7 +4859,7 @@ api.searchShards = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [searchTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-template.html) request
|
||||
* Perform a [searchTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/search-template.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)
|
||||
@ -4943,7 +4943,7 @@ api.searchTemplate = ca({
|
||||
api.snapshot = namespace();
|
||||
|
||||
/**
|
||||
* 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.2/modules-snapshots.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node
|
||||
@ -4978,7 +4978,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.2/modules-snapshots.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node
|
||||
@ -5008,7 +5008,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.2/modules-snapshots.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node
|
||||
@ -5037,7 +5037,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.2/modules-snapshots.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node
|
||||
@ -5066,7 +5066,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.2/modules-snapshots.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node
|
||||
@ -5094,7 +5094,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.2/modules-snapshots.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node
|
||||
@ -5127,7 +5127,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.2/modules-snapshots.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node
|
||||
@ -5162,7 +5162,7 @@ api.snapshot.prototype.restore = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [snapshot.status](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-snapshots.html) request
|
||||
* Perform a [snapshot.status](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/modules-snapshots.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node
|
||||
@ -5203,7 +5203,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.2/search-search.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)
|
||||
@ -5261,7 +5261,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.2/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.
|
||||
@ -5341,7 +5341,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.2/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
|
||||
@ -5439,7 +5439,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.2/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
|
||||
|
||||
@ -7,7 +7,7 @@ var api = module.exports = {};
|
||||
api._namespaces = ['cat', 'cluster', 'indices', 'nodes', 'snapshot'];
|
||||
|
||||
/**
|
||||
* Perform a [bulk](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/docs-bulk.html) request
|
||||
* Perform a [bulk](http://www.elastic.co/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
|
||||
@ -128,7 +128,7 @@ api.cat.prototype.aliases = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.allocation](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/cat-allocation.html) request
|
||||
* Perform a [cat.allocation](http://www.elastic.co/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
|
||||
@ -185,7 +185,7 @@ api.cat.prototype.allocation = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.count](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/cat-count.html) request
|
||||
* Perform a [cat.count](http://www.elastic.co/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)
|
||||
@ -232,7 +232,7 @@ api.cat.prototype.count = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.fielddata](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-fielddata.html) request
|
||||
* Perform a [cat.fielddata](http://www.elastic.co/guide/en/elasticsearch/reference/1.3/cat-fielddata.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
|
||||
@ -292,7 +292,7 @@ api.cat.prototype.fielddata = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.health](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/cat-health.html) request
|
||||
* Perform a [cat.health](http://www.elastic.co/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)
|
||||
@ -333,7 +333,7 @@ api.cat.prototype.health = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.help](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/cat.html) request
|
||||
* Perform a [cat.help](http://www.elastic.co/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
|
||||
@ -351,7 +351,7 @@ api.cat.prototype.help = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.indices](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/cat-indices.html) request
|
||||
* Perform a [cat.indices](http://www.elastic.co/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
|
||||
@ -413,7 +413,7 @@ api.cat.prototype.indices = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.master](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/cat-master.html) request
|
||||
* Perform a [cat.master](http://www.elastic.co/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)
|
||||
@ -449,7 +449,7 @@ api.cat.prototype.master = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.nodes](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/cat-nodes.html) request
|
||||
* Perform a [cat.nodes](http://www.elastic.co/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)
|
||||
@ -485,7 +485,7 @@ api.cat.prototype.nodes = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.pendingTasks](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/cat-pending-tasks.html) request
|
||||
* Perform a [cat.pendingTasks](http://www.elastic.co/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)
|
||||
@ -521,7 +521,7 @@ api.cat.prototype.pendingTasks = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.plugins](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-plugins.html) request
|
||||
* Perform a [cat.plugins](http://www.elastic.co/guide/en/elasticsearch/reference/1.3/cat-plugins.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)
|
||||
@ -557,7 +557,7 @@ api.cat.prototype.plugins = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.recovery](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/cat-recovery.html) request
|
||||
* Perform a [cat.recovery](http://www.elastic.co/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
|
||||
@ -610,7 +610,7 @@ api.cat.prototype.recovery = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.segments](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-segments.html) request
|
||||
* Perform a [cat.segments](http://www.elastic.co/guide/en/elasticsearch/reference/1.3/cat-segments.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String, String[], Boolean} params.h - Comma-separated list of column names to display
|
||||
@ -648,7 +648,7 @@ api.cat.prototype.segments = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.shards](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/cat-shards.html) request
|
||||
* Perform a [cat.shards](http://www.elastic.co/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)
|
||||
@ -695,7 +695,7 @@ api.cat.prototype.shards = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.threadPool](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-thread-pool.html) request
|
||||
* Perform a [cat.threadPool](http://www.elastic.co/guide/en/elasticsearch/reference/1.3/cat-thread-pool.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false)
|
||||
@ -737,7 +737,7 @@ api.cat.prototype.threadPool = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [clearScroll](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/search-request-scroll.html) request
|
||||
* Perform a [clearScroll](http://www.elastic.co/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
|
||||
@ -762,7 +762,7 @@ api.clearScroll = ca({
|
||||
api.cluster = namespace();
|
||||
|
||||
/**
|
||||
* Perform a [cluster.getSettings](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/cluster-update-settings.html) request
|
||||
* Perform a [cluster.getSettings](http://www.elastic.co/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)
|
||||
@ -789,7 +789,7 @@ api.cluster.prototype.getSettings = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cluster.health](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/cluster-health.html) request
|
||||
* Perform a [cluster.health](http://www.elastic.co/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
|
||||
@ -862,7 +862,7 @@ api.cluster.prototype.health = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cluster.pendingTasks](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/cluster-pending.html) request
|
||||
* Perform a [cluster.pendingTasks](http://www.elastic.co/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)
|
||||
@ -884,7 +884,7 @@ api.cluster.prototype.pendingTasks = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cluster.putSettings](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/cluster-update-settings.html) request
|
||||
* Perform a [cluster.putSettings](http://www.elastic.co/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)
|
||||
@ -903,7 +903,7 @@ api.cluster.prototype.putSettings = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cluster.reroute](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/cluster-reroute.html) request
|
||||
* Perform a [cluster.reroute](http://www.elastic.co/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
|
||||
@ -940,7 +940,7 @@ api.cluster.prototype.reroute = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cluster.state](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/cluster-state.html) request
|
||||
* Perform a [cluster.state](http://www.elastic.co/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)
|
||||
@ -1008,7 +1008,7 @@ api.cluster.prototype.state = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cluster.stats](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/cluster-stats.html) request
|
||||
* Perform a [cluster.stats](http://www.elastic.co/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)
|
||||
@ -1042,7 +1042,7 @@ api.cluster.prototype.stats = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [count](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/search-count.html) request
|
||||
* Perform a [count](http://www.elastic.co/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)
|
||||
@ -1116,7 +1116,7 @@ api.count = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [countPercolate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/search-percolate.html) request
|
||||
* Perform a [countPercolate](http://www.elastic.co/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
|
||||
@ -1210,7 +1210,7 @@ api.countPercolate = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [delete](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/docs-delete.html) request
|
||||
* Perform a [delete](http://www.elastic.co/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
|
||||
@ -1287,7 +1287,7 @@ api['delete'] = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [deleteByQuery](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/docs-delete-by-query.html) request
|
||||
* Perform a [deleteByQuery](http://www.elastic.co/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
|
||||
@ -1393,7 +1393,7 @@ api.deleteByQuery = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [deleteScript](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-scripting.html) request
|
||||
* Perform a [deleteScript](http://www.elastic.co/guide/en/elasticsearch/reference/1.3/modules-scripting.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} params.id - Script ID
|
||||
@ -1415,7 +1415,7 @@ api.deleteScript = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [deleteTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-template.html) request
|
||||
* Perform a [deleteTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/1.3/search-template.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} params.id - Template ID
|
||||
@ -1433,7 +1433,7 @@ api.deleteTemplate = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [exists](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/docs-get.html) request
|
||||
* Perform a [exists](http://www.elastic.co/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
|
||||
@ -1481,7 +1481,7 @@ api.exists = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [explain](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/search-explain.html) request
|
||||
* Perform a [explain](http://www.elastic.co/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)
|
||||
@ -1579,7 +1579,7 @@ api.explain = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [get](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/docs-get.html) request
|
||||
* Perform a [get](http://www.elastic.co/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
|
||||
@ -1659,7 +1659,7 @@ api.get = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [getScript](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-scripting.html) request
|
||||
* Perform a [getScript](http://www.elastic.co/guide/en/elasticsearch/reference/1.3/modules-scripting.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} params.id - Script ID
|
||||
@ -1680,7 +1680,7 @@ api.getScript = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [getSource](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/docs-get.html) request
|
||||
* Perform a [getSource](http://www.elastic.co/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.getSource = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [getTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-template.html) request
|
||||
* Perform a [getTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/1.3/search-template.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} params.id - Template ID
|
||||
@ -1773,7 +1773,7 @@ api.getTemplate = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [index](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/docs-index_.html) request
|
||||
* Perform a [index](http://www.elastic.co/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
|
||||
@ -1883,7 +1883,7 @@ api.index = ca({
|
||||
api.indices = namespace();
|
||||
|
||||
/**
|
||||
* Perform a [indices.analyze](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/indices-analyze.html) request
|
||||
* Perform a [indices.analyze](http://www.elastic.co/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
|
||||
@ -1950,7 +1950,7 @@ api.indices.prototype.analyze = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.clearCache](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/indices-clearcache.html) request
|
||||
* Perform a [indices.clearCache](http://www.elastic.co/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
|
||||
@ -2038,7 +2038,7 @@ api.indices.prototype.clearCache = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.close](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/indices-open-close.html) request
|
||||
* Perform a [indices.close](http://www.elastic.co/guide/en/elasticsearch/reference/1.3/indices-open-close.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.timeout - Explicit operation timeout
|
||||
@ -2087,7 +2087,7 @@ api.indices.prototype.close = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.create](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/indices-create-index.html) request
|
||||
* Perform a [indices.create](http://www.elastic.co/guide/en/elasticsearch/reference/1.3/indices-create-index.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.timeout - Explicit operation timeout
|
||||
@ -2116,7 +2116,7 @@ api.indices.prototype.create = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.delete](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/indices-delete-index.html) request
|
||||
* Perform a [indices.delete](http://www.elastic.co/guide/en/elasticsearch/reference/1.3/indices-delete-index.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.timeout - Explicit operation timeout
|
||||
@ -2145,7 +2145,7 @@ api.indices.prototype['delete'] = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.deleteAlias](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/indices-aliases.html) request
|
||||
* Perform a [indices.deleteAlias](http://www.elastic.co/guide/en/elasticsearch/reference/1.3/indices-aliases.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.timeout - Explicit timestamp for the document
|
||||
@ -2178,7 +2178,7 @@ api.indices.prototype.deleteAlias = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.deleteMapping](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/indices-delete-mapping.html) request
|
||||
* Perform a [indices.deleteMapping](http://www.elastic.co/guide/en/elasticsearch/reference/1.3/indices-delete-mapping.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Specify timeout for connection to master
|
||||
@ -2207,7 +2207,7 @@ api.indices.prototype.deleteMapping = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.deleteTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/indices-templates.html) request
|
||||
* Perform a [indices.deleteTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/1.3/indices-templates.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.timeout - Explicit operation timeout
|
||||
@ -2236,7 +2236,7 @@ api.indices.prototype.deleteTemplate = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.deleteWarmer](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/indices-warmers.html) request
|
||||
* Perform a [indices.deleteWarmer](http://www.elastic.co/guide/en/elasticsearch/reference/1.3/indices-warmers.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Specify timeout for connection to master
|
||||
@ -2268,7 +2268,7 @@ api.indices.prototype.deleteWarmer = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.exists](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/indices-get-settings.html) request
|
||||
* Perform a [indices.exists](http://www.elastic.co/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)
|
||||
@ -2312,7 +2312,7 @@ api.indices.prototype.exists = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.existsAlias](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/indices-aliases.html) request
|
||||
* Perform a [indices.existsAlias](http://www.elastic.co/guide/en/elasticsearch/reference/1.3/indices-aliases.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
|
||||
@ -2381,7 +2381,7 @@ api.indices.prototype.existsAlias = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.existsTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/indices-templates.html) request
|
||||
* Perform a [indices.existsTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/1.3/indices-templates.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false)
|
||||
@ -2405,7 +2405,7 @@ api.indices.prototype.existsTemplate = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.existsType](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/indices-types-exists.html) request
|
||||
* Perform a [indices.existsType](http://www.elastic.co/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)
|
||||
@ -2453,7 +2453,7 @@ api.indices.prototype.existsType = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.flush](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/indices-flush.html) request
|
||||
* Perform a [indices.flush](http://www.elastic.co/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)
|
||||
@ -2506,7 +2506,7 @@ api.indices.prototype.flush = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.getAlias](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/indices-aliases.html) request
|
||||
* Perform a [indices.getAlias](http://www.elastic.co/guide/en/elasticsearch/reference/1.3/indices-aliases.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
|
||||
@ -2574,7 +2574,7 @@ api.indices.prototype.getAlias = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.getAliases](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/indices-aliases.html) request
|
||||
* Perform a [indices.getAliases](http://www.elastic.co/guide/en/elasticsearch/reference/1.3/indices-aliases.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.timeout - Explicit operation timeout
|
||||
@ -2626,7 +2626,7 @@ api.indices.prototype.getAliases = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.getFieldMapping](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/indices-get-field-mapping.html) request
|
||||
* Perform a [indices.getFieldMapping](http://www.elastic.co/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
|
||||
@ -2714,7 +2714,7 @@ api.indices.prototype.getFieldMapping = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.getMapping](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/indices-get-mapping.html) request
|
||||
* Perform a [indices.getMapping](http://www.elastic.co/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)
|
||||
@ -2782,7 +2782,7 @@ api.indices.prototype.getMapping = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.getSettings](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/indices-get-settings.html) request
|
||||
* Perform a [indices.getSettings](http://www.elastic.co/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)
|
||||
@ -2858,7 +2858,7 @@ api.indices.prototype.getSettings = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.getTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/indices-templates.html) request
|
||||
* Perform a [indices.getTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/1.3/indices-templates.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.flatSettings - Return settings in flat format (default: false)
|
||||
@ -2891,7 +2891,7 @@ api.indices.prototype.getTemplate = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.getWarmer](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/indices-warmers.html) request
|
||||
* Perform a [indices.getWarmer](http://www.elastic.co/guide/en/elasticsearch/reference/1.3/indices-warmers.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
|
||||
@ -2974,7 +2974,7 @@ api.indices.prototype.getWarmer = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.open](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/indices-open-close.html) request
|
||||
* Perform a [indices.open](http://www.elastic.co/guide/en/elasticsearch/reference/1.3/indices-open-close.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.timeout - Explicit operation timeout
|
||||
@ -3023,7 +3023,7 @@ api.indices.prototype.open = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.optimize](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/indices-optimize.html) request
|
||||
* Perform a [indices.optimize](http://www.elastic.co/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)
|
||||
@ -3095,7 +3095,7 @@ api.indices.prototype.optimize = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.putAlias](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/indices-aliases.html) request
|
||||
* Perform a [indices.putAlias](http://www.elastic.co/guide/en/elasticsearch/reference/1.3/indices-aliases.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.timeout - Explicit timestamp for the document
|
||||
@ -3138,7 +3138,7 @@ api.indices.prototype.putAlias = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.putMapping](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/indices-put-mapping.html) request
|
||||
* Perform a [indices.putMapping](http://www.elastic.co/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)
|
||||
@ -3207,7 +3207,7 @@ api.indices.prototype.putMapping = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.putSettings](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/indices-update-settings.html) request
|
||||
* Perform a [indices.putSettings](http://www.elastic.co/guide/en/elasticsearch/reference/1.3/indices-update-settings.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Specify timeout for connection to master
|
||||
@ -3263,7 +3263,7 @@ api.indices.prototype.putSettings = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.putTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/indices-templates.html) request
|
||||
* Perform a [indices.putTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/1.3/indices-templates.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Number} params.order - The order for this template when merging multiple matching ones (higher numbers are merged later, overriding the lower numbers)
|
||||
@ -3307,7 +3307,7 @@ api.indices.prototype.putTemplate = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.putWarmer](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/indices-warmers.html) request
|
||||
* Perform a [indices.putWarmer](http://www.elastic.co/guide/en/elasticsearch/reference/1.3/indices-warmers.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Specify timeout for connection to master
|
||||
@ -3382,7 +3382,7 @@ api.indices.prototype.putWarmer = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.recovery](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/indices-recovery.html) request
|
||||
* Perform a [indices.recovery](http://www.elastic.co/guide/en/elasticsearch/reference/1.3/indices-recovery.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.detailed - Whether to display detailed information about shard recovery
|
||||
@ -3422,7 +3422,7 @@ api.indices.prototype.recovery = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.refresh](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/indices-refresh.html) request
|
||||
* Perform a [indices.refresh](http://www.elastic.co/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)
|
||||
@ -3476,7 +3476,7 @@ api.indices.prototype.refresh = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.segments](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/indices-segments.html) request
|
||||
* Perform a [indices.segments](http://www.elastic.co/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)
|
||||
@ -3529,7 +3529,7 @@ api.indices.prototype.segments = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.stats](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/indices-stats.html) request
|
||||
* Perform a [indices.stats](http://www.elastic.co/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)
|
||||
@ -3648,7 +3648,7 @@ api.indices.prototype.stats = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.status](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/indices-status.html) request
|
||||
* Perform a [indices.status](http://www.elastic.co/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)
|
||||
@ -3709,7 +3709,7 @@ api.indices.prototype.status = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.updateAliases](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/indices-aliases.html) request
|
||||
* Perform a [indices.updateAliases](http://www.elastic.co/guide/en/elasticsearch/reference/1.3/indices-aliases.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.timeout - Request timeout
|
||||
@ -3733,7 +3733,7 @@ api.indices.prototype.updateAliases = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.validateQuery](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/search-validate.html) request
|
||||
* Perform a [indices.validateQuery](http://www.elastic.co/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
|
||||
@ -3806,7 +3806,7 @@ api.indices.prototype.validateQuery = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [info](http://www.elasticsearch.org/guide/) request
|
||||
* Perform a [info](http://www.elastic.co/guide/) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
*/
|
||||
@ -3817,7 +3817,7 @@ api.info = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [mget](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/docs-multi-get.html) request
|
||||
* Perform a [mget](http://www.elastic.co/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
|
||||
@ -3885,7 +3885,7 @@ api.mget = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [mlt](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/search-more-like-this.html) request
|
||||
* Perform a [mlt](http://www.elastic.co/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
|
||||
@ -4007,7 +4007,7 @@ api.mlt = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [mpercolate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/search-percolate.html) request
|
||||
* Perform a [mpercolate](http://www.elastic.co/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)
|
||||
@ -4066,7 +4066,7 @@ api.mpercolate = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [msearch](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/search-multi-search.html) request
|
||||
* Perform a [msearch](http://www.elastic.co/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
|
||||
@ -4118,7 +4118,7 @@ api.msearch = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [mtermvectors](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/docs-multi-termvectors.html) request
|
||||
* Perform a [mtermvectors](http://www.elastic.co/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
|
||||
@ -4215,7 +4215,7 @@ api.mtermvectors = ca({
|
||||
api.nodes = namespace();
|
||||
|
||||
/**
|
||||
* Perform a [nodes.hotThreads](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/cluster-nodes-hot-threads.html) request
|
||||
* Perform a [nodes.hotThreads](http://www.elastic.co/guide/en/elasticsearch/reference/1.3/cluster-nodes-hot-threads.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.interval - The interval for the second sampling of threads
|
||||
@ -4260,7 +4260,7 @@ api.nodes.prototype.hotThreads = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [nodes.info](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/cluster-nodes-info.html) request
|
||||
* Perform a [nodes.info](http://www.elastic.co/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)
|
||||
@ -4336,7 +4336,7 @@ api.nodes.prototype.info = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [nodes.shutdown](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/cluster-nodes-shutdown.html) request
|
||||
* Perform a [nodes.shutdown](http://www.elastic.co/guide/en/elasticsearch/reference/1.3/cluster-nodes-shutdown.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.delay - Set the delay for the operation (default: 1s)
|
||||
@ -4369,7 +4369,7 @@ api.nodes.prototype.shutdown = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [nodes.stats](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/cluster-nodes-stats.html) request
|
||||
* Perform a [nodes.stats](http://www.elastic.co/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)
|
||||
@ -4566,7 +4566,7 @@ api.nodes.prototype.stats = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [percolate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/search-percolate.html) request
|
||||
* Perform a [percolate](http://www.elastic.co/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
|
||||
@ -4660,7 +4660,7 @@ api.percolate = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [ping](http://www.elasticsearch.org/guide/) request
|
||||
* Perform a [ping](http://www.elastic.co/guide/) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
*/
|
||||
@ -4673,7 +4673,7 @@ api.ping = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [putScript](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-scripting.html) request
|
||||
* Perform a [putScript](http://www.elastic.co/guide/en/elasticsearch/reference/1.3/modules-scripting.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} params.id - Script ID
|
||||
@ -4696,7 +4696,7 @@ api.putScript = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [putTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-template.html) request
|
||||
* Perform a [putTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/1.3/search-template.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} params.id - Template ID
|
||||
@ -4715,7 +4715,7 @@ api.putTemplate = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [scroll](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/search-request-scroll.html) request
|
||||
* Perform a [scroll](http://www.elastic.co/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
|
||||
@ -4749,7 +4749,7 @@ api.scroll = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [search](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/search-search.html) request
|
||||
* Perform a [search](http://www.elastic.co/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
|
||||
@ -4958,7 +4958,7 @@ api.search = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [searchShards](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-shards.html) request
|
||||
* Perform a [searchShards](http://www.elastic.co/guide/en/elasticsearch/reference/1.3/search-shards.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} params.preference - Specify the node or shard the operation should be performed on (default: random)
|
||||
@ -5027,7 +5027,7 @@ api.searchShards = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [searchTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-template.html) request
|
||||
* Perform a [searchTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.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)
|
||||
@ -5111,7 +5111,7 @@ api.searchTemplate = ca({
|
||||
api.snapshot = namespace();
|
||||
|
||||
/**
|
||||
* Perform a [snapshot.create](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/modules-snapshots.html) request
|
||||
* Perform a [snapshot.create](http://www.elastic.co/guide/en/elasticsearch/reference/1.3/modules-snapshots.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node
|
||||
@ -5146,7 +5146,7 @@ api.snapshot.prototype.create = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [snapshot.createRepository](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/modules-snapshots.html) request
|
||||
* Perform a [snapshot.createRepository](http://www.elastic.co/guide/en/elasticsearch/reference/1.3/modules-snapshots.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node
|
||||
@ -5176,7 +5176,7 @@ api.snapshot.prototype.createRepository = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [snapshot.delete](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/modules-snapshots.html) request
|
||||
* Perform a [snapshot.delete](http://www.elastic.co/guide/en/elasticsearch/reference/1.3/modules-snapshots.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node
|
||||
@ -5205,7 +5205,7 @@ api.snapshot.prototype['delete'] = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [snapshot.deleteRepository](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/modules-snapshots.html) request
|
||||
* Perform a [snapshot.deleteRepository](http://www.elastic.co/guide/en/elasticsearch/reference/1.3/modules-snapshots.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node
|
||||
@ -5234,7 +5234,7 @@ api.snapshot.prototype.deleteRepository = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [snapshot.get](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/modules-snapshots.html) request
|
||||
* Perform a [snapshot.get](http://www.elastic.co/guide/en/elasticsearch/reference/1.3/modules-snapshots.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node
|
||||
@ -5262,7 +5262,7 @@ api.snapshot.prototype.get = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [snapshot.getRepository](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/modules-snapshots.html) request
|
||||
* Perform a [snapshot.getRepository](http://www.elastic.co/guide/en/elasticsearch/reference/1.3/modules-snapshots.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node
|
||||
@ -5295,7 +5295,7 @@ api.snapshot.prototype.getRepository = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [snapshot.restore](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/modules-snapshots.html) request
|
||||
* Perform a [snapshot.restore](http://www.elastic.co/guide/en/elasticsearch/reference/1.3/modules-snapshots.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node
|
||||
@ -5330,7 +5330,7 @@ api.snapshot.prototype.restore = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [snapshot.status](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-snapshots.html) request
|
||||
* Perform a [snapshot.status](http://www.elastic.co/guide/en/elasticsearch/reference/1.3/modules-snapshots.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node
|
||||
@ -5371,7 +5371,7 @@ api.snapshot.prototype.status = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [suggest](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/search-suggesters.html) request
|
||||
* Perform a [suggest](http://www.elastic.co/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)
|
||||
@ -5429,7 +5429,7 @@ api.suggest = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [termvector](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/docs-termvectors.html) request
|
||||
* Perform a [termvector](http://www.elastic.co/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.
|
||||
@ -5509,7 +5509,7 @@ api.termvector = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [update](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/docs-update.html) request
|
||||
* Perform a [update](http://www.elastic.co/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
|
||||
@ -5607,7 +5607,7 @@ api.update = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [create](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/docs-index_.html) request
|
||||
* Perform a [create](http://www.elastic.co/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
|
||||
|
||||
@ -7,7 +7,7 @@ var api = module.exports = {};
|
||||
api._namespaces = ['cat', 'cluster', 'indices', 'nodes', 'snapshot'];
|
||||
|
||||
/**
|
||||
* Perform a [bulk](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/docs-bulk.html) request
|
||||
* Perform a [bulk](http://www.elastic.co/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
|
||||
@ -128,7 +128,7 @@ api.cat.prototype.aliases = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.allocation](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/cat-allocation.html) request
|
||||
* Perform a [cat.allocation](http://www.elastic.co/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
|
||||
@ -185,7 +185,7 @@ api.cat.prototype.allocation = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.count](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/cat-count.html) request
|
||||
* Perform a [cat.count](http://www.elastic.co/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)
|
||||
@ -232,7 +232,7 @@ api.cat.prototype.count = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.fielddata](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-fielddata.html) request
|
||||
* Perform a [cat.fielddata](http://www.elastic.co/guide/en/elasticsearch/reference/1.4/cat-fielddata.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
|
||||
@ -292,7 +292,7 @@ api.cat.prototype.fielddata = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.health](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/cat-health.html) request
|
||||
* Perform a [cat.health](http://www.elastic.co/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)
|
||||
@ -333,7 +333,7 @@ api.cat.prototype.health = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.help](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/cat.html) request
|
||||
* Perform a [cat.help](http://www.elastic.co/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
|
||||
@ -351,7 +351,7 @@ api.cat.prototype.help = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.indices](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/cat-indices.html) request
|
||||
* Perform a [cat.indices](http://www.elastic.co/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
|
||||
@ -413,7 +413,7 @@ api.cat.prototype.indices = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.master](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/cat-master.html) request
|
||||
* Perform a [cat.master](http://www.elastic.co/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)
|
||||
@ -449,7 +449,7 @@ api.cat.prototype.master = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.nodes](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/cat-nodes.html) request
|
||||
* Perform a [cat.nodes](http://www.elastic.co/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)
|
||||
@ -485,7 +485,7 @@ api.cat.prototype.nodes = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.pendingTasks](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/cat-pending-tasks.html) request
|
||||
* Perform a [cat.pendingTasks](http://www.elastic.co/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)
|
||||
@ -521,7 +521,7 @@ api.cat.prototype.pendingTasks = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.plugins](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-plugins.html) request
|
||||
* Perform a [cat.plugins](http://www.elastic.co/guide/en/elasticsearch/reference/1.4/cat-plugins.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)
|
||||
@ -557,7 +557,7 @@ api.cat.prototype.plugins = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.recovery](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/cat-recovery.html) request
|
||||
* Perform a [cat.recovery](http://www.elastic.co/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
|
||||
@ -610,7 +610,7 @@ api.cat.prototype.recovery = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.segments](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-segments.html) request
|
||||
* Perform a [cat.segments](http://www.elastic.co/guide/en/elasticsearch/reference/1.4/cat-segments.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String, String[], Boolean} params.h - Comma-separated list of column names to display
|
||||
@ -648,7 +648,7 @@ api.cat.prototype.segments = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.shards](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/cat-shards.html) request
|
||||
* Perform a [cat.shards](http://www.elastic.co/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)
|
||||
@ -695,7 +695,7 @@ api.cat.prototype.shards = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.threadPool](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-thread-pool.html) request
|
||||
* Perform a [cat.threadPool](http://www.elastic.co/guide/en/elasticsearch/reference/1.4/cat-thread-pool.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false)
|
||||
@ -737,7 +737,7 @@ api.cat.prototype.threadPool = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [clearScroll](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/search-request-scroll.html) request
|
||||
* Perform a [clearScroll](http://www.elastic.co/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
|
||||
@ -762,7 +762,7 @@ api.clearScroll = ca({
|
||||
api.cluster = namespace();
|
||||
|
||||
/**
|
||||
* Perform a [cluster.getSettings](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/cluster-update-settings.html) request
|
||||
* Perform a [cluster.getSettings](http://www.elastic.co/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)
|
||||
@ -789,7 +789,7 @@ api.cluster.prototype.getSettings = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cluster.health](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/cluster-health.html) request
|
||||
* Perform a [cluster.health](http://www.elastic.co/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
|
||||
@ -862,7 +862,7 @@ api.cluster.prototype.health = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cluster.pendingTasks](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/cluster-pending.html) request
|
||||
* Perform a [cluster.pendingTasks](http://www.elastic.co/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)
|
||||
@ -884,7 +884,7 @@ api.cluster.prototype.pendingTasks = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cluster.putSettings](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/cluster-update-settings.html) request
|
||||
* Perform a [cluster.putSettings](http://www.elastic.co/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)
|
||||
@ -903,7 +903,7 @@ api.cluster.prototype.putSettings = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cluster.reroute](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/cluster-reroute.html) request
|
||||
* Perform a [cluster.reroute](http://www.elastic.co/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
|
||||
@ -948,7 +948,7 @@ api.cluster.prototype.reroute = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cluster.state](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/cluster-state.html) request
|
||||
* Perform a [cluster.state](http://www.elastic.co/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)
|
||||
@ -1016,7 +1016,7 @@ api.cluster.prototype.state = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cluster.stats](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/cluster-stats.html) request
|
||||
* Perform a [cluster.stats](http://www.elastic.co/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)
|
||||
@ -1050,7 +1050,7 @@ api.cluster.prototype.stats = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [count](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/search-count.html) request
|
||||
* Perform a [count](http://www.elastic.co/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)
|
||||
@ -1126,7 +1126,7 @@ api.count = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [countPercolate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/search-percolate.html) request
|
||||
* Perform a [countPercolate](http://www.elastic.co/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} params.source - The URL-encoded request definition
|
||||
@ -1226,7 +1226,7 @@ api.countPercolate = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [delete](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/docs-delete.html) request
|
||||
* Perform a [delete](http://www.elastic.co/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
|
||||
@ -1303,7 +1303,7 @@ api['delete'] = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [deleteByQuery](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/docs-delete-by-query.html) request
|
||||
* Perform a [deleteByQuery](http://www.elastic.co/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
|
||||
@ -1411,7 +1411,7 @@ api.deleteByQuery = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [deleteScript](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-scripting.html) request
|
||||
* Perform a [deleteScript](http://www.elastic.co/guide/en/elasticsearch/reference/1.4/modules-scripting.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
|
||||
@ -1450,7 +1450,7 @@ api.deleteScript = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [deleteTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-template.html) request
|
||||
* Perform a [deleteTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/1.4/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
|
||||
@ -1485,7 +1485,7 @@ api.deleteTemplate = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [exists](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/docs-get.html) request
|
||||
* Perform a [exists](http://www.elastic.co/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
|
||||
@ -1533,7 +1533,7 @@ api.exists = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [explain](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/search-explain.html) request
|
||||
* Perform a [explain](http://www.elastic.co/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)
|
||||
@ -1631,7 +1631,7 @@ api.explain = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [get](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/docs-get.html) request
|
||||
* Perform a [get](http://www.elastic.co/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
|
||||
@ -1711,7 +1711,7 @@ api.get = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [getScript](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-scripting.html) request
|
||||
* Perform a [getScript](http://www.elastic.co/guide/en/elasticsearch/reference/1.4/modules-scripting.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
|
||||
@ -1749,7 +1749,7 @@ api.getScript = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [getSource](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/docs-get.html) request
|
||||
* Perform a [getSource](http://www.elastic.co/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
|
||||
@ -1825,7 +1825,7 @@ api.getSource = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [getTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-template.html) request
|
||||
* Perform a [getTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/1.4/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
|
||||
@ -1859,7 +1859,7 @@ api.getTemplate = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [index](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/docs-index_.html) request
|
||||
* Perform a [index](http://www.elastic.co/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
|
||||
@ -1969,7 +1969,7 @@ api.index = ca({
|
||||
api.indices = namespace();
|
||||
|
||||
/**
|
||||
* Perform a [indices.analyze](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-analyze.html) request
|
||||
* Perform a [indices.analyze](http://www.elastic.co/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.source - The URL-encoded request definition
|
||||
@ -2040,7 +2040,7 @@ api.indices.prototype.analyze = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.clearCache](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-clearcache.html) request
|
||||
* Perform a [indices.clearCache](http://www.elastic.co/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
|
||||
@ -2135,7 +2135,7 @@ api.indices.prototype.clearCache = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.close](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-open-close.html) request
|
||||
* Perform a [indices.close](http://www.elastic.co/guide/en/elasticsearch/reference/1.4/indices-open-close.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.timeout - Explicit operation timeout
|
||||
@ -2186,7 +2186,7 @@ api.indices.prototype.close = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.create](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-create-index.html) request
|
||||
* Perform a [indices.create](http://www.elastic.co/guide/en/elasticsearch/reference/1.4/indices-create-index.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.timeout - Explicit operation timeout
|
||||
@ -2215,7 +2215,7 @@ api.indices.prototype.create = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.delete](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-delete-index.html) request
|
||||
* Perform a [indices.delete](http://www.elastic.co/guide/en/elasticsearch/reference/1.4/indices-delete-index.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.timeout - Explicit operation timeout
|
||||
@ -2244,7 +2244,7 @@ api.indices.prototype['delete'] = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.deleteAlias](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-aliases.html) request
|
||||
* Perform a [indices.deleteAlias](http://www.elastic.co/guide/en/elasticsearch/reference/1.4/indices-aliases.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.timeout - Explicit timestamp for the document
|
||||
@ -2277,7 +2277,7 @@ api.indices.prototype.deleteAlias = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.deleteMapping](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-delete-mapping.html) request
|
||||
* Perform a [indices.deleteMapping](http://www.elastic.co/guide/en/elasticsearch/reference/1.4/indices-delete-mapping.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Specify timeout for connection to master
|
||||
@ -2306,7 +2306,7 @@ api.indices.prototype.deleteMapping = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.deleteTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-templates.html) request
|
||||
* Perform a [indices.deleteTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/1.4/indices-templates.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.timeout - Explicit operation timeout
|
||||
@ -2335,7 +2335,7 @@ api.indices.prototype.deleteTemplate = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.deleteWarmer](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-warmers.html) request
|
||||
* Perform a [indices.deleteWarmer](http://www.elastic.co/guide/en/elasticsearch/reference/1.4/indices-warmers.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Specify timeout for connection to master
|
||||
@ -2367,7 +2367,7 @@ api.indices.prototype.deleteWarmer = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.exists](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-exists.html) request
|
||||
* Perform a [indices.exists](http://www.elastic.co/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)
|
||||
@ -2413,7 +2413,7 @@ api.indices.prototype.exists = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.existsAlias](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-aliases.html) request
|
||||
* Perform a [indices.existsAlias](http://www.elastic.co/guide/en/elasticsearch/reference/1.4/indices-aliases.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
|
||||
@ -2484,7 +2484,7 @@ api.indices.prototype.existsAlias = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.existsTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-templates.html) request
|
||||
* Perform a [indices.existsTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/1.4/indices-templates.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false)
|
||||
@ -2508,7 +2508,7 @@ api.indices.prototype.existsTemplate = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.existsType](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-types-exists.html) request
|
||||
* Perform a [indices.existsType](http://www.elastic.co/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)
|
||||
@ -2558,7 +2558,7 @@ api.indices.prototype.existsType = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.flush](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-flush.html) request
|
||||
* Perform a [indices.flush](http://www.elastic.co/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)
|
||||
@ -2618,7 +2618,7 @@ api.indices.prototype.flush = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.get](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-get-index.html) request
|
||||
* Perform a [indices.get](http://www.elastic.co/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)
|
||||
@ -2677,7 +2677,7 @@ api.indices.prototype.get = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.getAlias](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-aliases.html) request
|
||||
* Perform a [indices.getAlias](http://www.elastic.co/guide/en/elasticsearch/reference/1.4/indices-aliases.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
|
||||
@ -2747,7 +2747,7 @@ api.indices.prototype.getAlias = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.getAliases](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-aliases.html) request
|
||||
* Perform a [indices.getAliases](http://www.elastic.co/guide/en/elasticsearch/reference/1.4/indices-aliases.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.timeout - Explicit operation timeout
|
||||
@ -2799,7 +2799,7 @@ api.indices.prototype.getAliases = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.getFieldMapping](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-get-field-mapping.html) request
|
||||
* Perform a [indices.getFieldMapping](http://www.elastic.co/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
|
||||
@ -2889,7 +2889,7 @@ api.indices.prototype.getFieldMapping = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.getMapping](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-get-mapping.html) request
|
||||
* Perform a [indices.getMapping](http://www.elastic.co/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)
|
||||
@ -2959,7 +2959,7 @@ api.indices.prototype.getMapping = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.getSettings](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-get-settings.html) request
|
||||
* Perform a [indices.getSettings](http://www.elastic.co/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)
|
||||
@ -3037,7 +3037,7 @@ api.indices.prototype.getSettings = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.getTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-templates.html) request
|
||||
* Perform a [indices.getTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/1.4/indices-templates.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.flatSettings - Return settings in flat format (default: false)
|
||||
@ -3070,7 +3070,7 @@ api.indices.prototype.getTemplate = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.getUpgrade](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/indices-upgrade.html) request
|
||||
* Perform a [indices.getUpgrade](http://www.elastic.co/guide/en/elasticsearch/reference/1.4/indices-upgrade.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)
|
||||
@ -3121,7 +3121,7 @@ api.indices.prototype.getUpgrade = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.getWarmer](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-warmers.html) request
|
||||
* Perform a [indices.getWarmer](http://www.elastic.co/guide/en/elasticsearch/reference/1.4/indices-warmers.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
|
||||
@ -3206,7 +3206,7 @@ api.indices.prototype.getWarmer = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.open](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-open-close.html) request
|
||||
* Perform a [indices.open](http://www.elastic.co/guide/en/elasticsearch/reference/1.4/indices-open-close.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.timeout - Explicit operation timeout
|
||||
@ -3257,7 +3257,7 @@ api.indices.prototype.open = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.optimize](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-optimize.html) request
|
||||
* Perform a [indices.optimize](http://www.elastic.co/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)
|
||||
@ -3331,7 +3331,7 @@ api.indices.prototype.optimize = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.putAlias](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-aliases.html) request
|
||||
* Perform a [indices.putAlias](http://www.elastic.co/guide/en/elasticsearch/reference/1.4/indices-aliases.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.timeout - Explicit timestamp for the document
|
||||
@ -3374,7 +3374,7 @@ api.indices.prototype.putAlias = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.putMapping](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-put-mapping.html) request
|
||||
* Perform a [indices.putMapping](http://www.elastic.co/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)
|
||||
@ -3445,7 +3445,7 @@ api.indices.prototype.putMapping = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.putSettings](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-update-settings.html) request
|
||||
* Perform a [indices.putSettings](http://www.elastic.co/guide/en/elasticsearch/reference/1.4/indices-update-settings.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Specify timeout for connection to master
|
||||
@ -3503,7 +3503,7 @@ api.indices.prototype.putSettings = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.putTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-templates.html) request
|
||||
* Perform a [indices.putTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/1.4/indices-templates.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Number} params.order - The order for this template when merging multiple matching ones (higher numbers are merged later, overriding the lower numbers)
|
||||
@ -3547,7 +3547,7 @@ api.indices.prototype.putTemplate = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.putWarmer](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-warmers.html) request
|
||||
* Perform a [indices.putWarmer](http://www.elastic.co/guide/en/elasticsearch/reference/1.4/indices-warmers.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Specify timeout for connection to master
|
||||
@ -3624,7 +3624,7 @@ api.indices.prototype.putWarmer = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.recovery](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/indices-recovery.html) request
|
||||
* Perform a [indices.recovery](http://www.elastic.co/guide/en/elasticsearch/reference/1.4/indices-recovery.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.detailed - Whether to display detailed information about shard recovery
|
||||
@ -3664,7 +3664,7 @@ api.indices.prototype.recovery = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.refresh](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-refresh.html) request
|
||||
* Perform a [indices.refresh](http://www.elastic.co/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)
|
||||
@ -3720,7 +3720,7 @@ api.indices.prototype.refresh = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.segments](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-segments.html) request
|
||||
* Perform a [indices.segments](http://www.elastic.co/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)
|
||||
@ -3775,7 +3775,7 @@ api.indices.prototype.segments = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.stats](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-stats.html) request
|
||||
* Perform a [indices.stats](http://www.elastic.co/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)
|
||||
@ -3896,7 +3896,7 @@ api.indices.prototype.stats = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.status](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-status.html) request
|
||||
* Perform a [indices.status](http://www.elastic.co/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)
|
||||
@ -3959,7 +3959,7 @@ api.indices.prototype.status = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.updateAliases](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-aliases.html) request
|
||||
* Perform a [indices.updateAliases](http://www.elastic.co/guide/en/elasticsearch/reference/1.4/indices-aliases.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.timeout - Request timeout
|
||||
@ -3983,7 +3983,7 @@ api.indices.prototype.updateAliases = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.upgrade](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/indices-upgrade.html) request
|
||||
* Perform a [indices.upgrade](http://www.elastic.co/guide/en/elasticsearch/reference/1.4/indices-upgrade.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
|
||||
@ -4035,7 +4035,7 @@ api.indices.prototype.upgrade = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.validateQuery](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/search-validate.html) request
|
||||
* Perform a [indices.validateQuery](http://www.elastic.co/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
|
||||
@ -4110,7 +4110,7 @@ api.indices.prototype.validateQuery = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [info](http://www.elasticsearch.org/guide/) request
|
||||
* Perform a [info](http://www.elastic.co/guide/) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
*/
|
||||
@ -4121,7 +4121,7 @@ api.info = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [mget](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/docs-multi-get.html) request
|
||||
* Perform a [mget](http://www.elastic.co/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} params.source - The URL-encoded request definition
|
||||
@ -4193,7 +4193,7 @@ api.mget = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [mlt](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/search-more-like-this.html) request
|
||||
* Perform a [mlt](http://www.elastic.co/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 {String} params.source - The URL-encoded request definition
|
||||
@ -4314,7 +4314,7 @@ api.mlt = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [mpercolate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/search-percolate.html) request
|
||||
* Perform a [mpercolate](http://www.elastic.co/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} params.source - The URL-encoded request definition
|
||||
@ -4379,7 +4379,7 @@ api.mpercolate = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [msearch](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/search-multi-search.html) request
|
||||
* Perform a [msearch](http://www.elastic.co/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.source - The URL-encoded request definition
|
||||
@ -4435,7 +4435,7 @@ api.msearch = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [mtermvectors](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/docs-multi-termvectors.html) request
|
||||
* Perform a [mtermvectors](http://www.elastic.co/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} params.source - The URL-encoded request definition
|
||||
@ -4535,7 +4535,7 @@ api.mtermvectors = ca({
|
||||
api.nodes = namespace();
|
||||
|
||||
/**
|
||||
* Perform a [nodes.hotThreads](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/cluster-nodes-hot-threads.html) request
|
||||
* Perform a [nodes.hotThreads](http://www.elastic.co/guide/en/elasticsearch/reference/1.4/cluster-nodes-hot-threads.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.interval - The interval for the second sampling of threads
|
||||
@ -4580,7 +4580,7 @@ api.nodes.prototype.hotThreads = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [nodes.info](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/cluster-nodes-info.html) request
|
||||
* Perform a [nodes.info](http://www.elastic.co/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)
|
||||
@ -4656,7 +4656,7 @@ api.nodes.prototype.info = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [nodes.shutdown](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/cluster-nodes-shutdown.html) request
|
||||
* Perform a [nodes.shutdown](http://www.elastic.co/guide/en/elasticsearch/reference/1.4/cluster-nodes-shutdown.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.delay - Set the delay for the operation (default: 1s)
|
||||
@ -4689,7 +4689,7 @@ api.nodes.prototype.shutdown = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [nodes.stats](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/cluster-nodes-stats.html) request
|
||||
* Perform a [nodes.stats](http://www.elastic.co/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)
|
||||
@ -4888,7 +4888,7 @@ api.nodes.prototype.stats = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [percolate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/search-percolate.html) request
|
||||
* Perform a [percolate](http://www.elastic.co/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} params.source - The URL-encoded request definition
|
||||
@ -5006,7 +5006,7 @@ api.percolate = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [ping](http://www.elasticsearch.org/guide/) request
|
||||
* Perform a [ping](http://www.elastic.co/guide/) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
*/
|
||||
@ -5019,7 +5019,7 @@ api.ping = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [putScript](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-scripting.html) request
|
||||
* Perform a [putScript](http://www.elastic.co/guide/en/elasticsearch/reference/1.4/modules-scripting.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} [params.opType=index] - Explicit operation type
|
||||
@ -5069,7 +5069,7 @@ api.putScript = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [putTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-template.html) request
|
||||
* Perform a [putTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/1.4/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
|
||||
@ -5115,7 +5115,7 @@ api.putTemplate = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [scroll](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/search-request-scroll.html) request
|
||||
* Perform a [scroll](http://www.elastic.co/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} params.source - The URL-encoded request definition
|
||||
@ -5153,7 +5153,7 @@ api.scroll = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [search](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/search-search.html) request
|
||||
* Perform a [search](http://www.elastic.co/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
|
||||
@ -5374,7 +5374,7 @@ api.search = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [searchExists](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-exists.html) request
|
||||
* Perform a [searchExists](http://www.elastic.co/guide/en/elasticsearch/reference/1.4/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)
|
||||
@ -5450,7 +5450,7 @@ api.searchExists = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [searchShards](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-shards.html) request
|
||||
* Perform a [searchShards](http://www.elastic.co/guide/en/elasticsearch/reference/1.4/search-shards.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} params.preference - Specify the node or shard the operation should be performed on (default: random)
|
||||
@ -5521,7 +5521,7 @@ api.searchShards = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [searchTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-template.html) request
|
||||
* Perform a [searchTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/1.4/search-template.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} params.source - The URL-encoded request definition
|
||||
@ -5611,7 +5611,7 @@ api.searchTemplate = ca({
|
||||
api.snapshot = namespace();
|
||||
|
||||
/**
|
||||
* Perform a [snapshot.create](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/modules-snapshots.html) request
|
||||
* Perform a [snapshot.create](http://www.elastic.co/guide/en/elasticsearch/reference/1.4/modules-snapshots.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node
|
||||
@ -5646,7 +5646,7 @@ api.snapshot.prototype.create = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [snapshot.createRepository](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/modules-snapshots.html) request
|
||||
* Perform a [snapshot.createRepository](http://www.elastic.co/guide/en/elasticsearch/reference/1.4/modules-snapshots.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node
|
||||
@ -5680,7 +5680,7 @@ api.snapshot.prototype.createRepository = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [snapshot.delete](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/modules-snapshots.html) request
|
||||
* Perform a [snapshot.delete](http://www.elastic.co/guide/en/elasticsearch/reference/1.4/modules-snapshots.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node
|
||||
@ -5709,7 +5709,7 @@ api.snapshot.prototype['delete'] = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [snapshot.deleteRepository](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/modules-snapshots.html) request
|
||||
* Perform a [snapshot.deleteRepository](http://www.elastic.co/guide/en/elasticsearch/reference/1.4/modules-snapshots.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node
|
||||
@ -5738,7 +5738,7 @@ api.snapshot.prototype.deleteRepository = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [snapshot.get](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/modules-snapshots.html) request
|
||||
* Perform a [snapshot.get](http://www.elastic.co/guide/en/elasticsearch/reference/1.4/modules-snapshots.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node
|
||||
@ -5766,7 +5766,7 @@ api.snapshot.prototype.get = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [snapshot.getRepository](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/modules-snapshots.html) request
|
||||
* Perform a [snapshot.getRepository](http://www.elastic.co/guide/en/elasticsearch/reference/1.4/modules-snapshots.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node
|
||||
@ -5799,7 +5799,7 @@ api.snapshot.prototype.getRepository = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [snapshot.restore](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/modules-snapshots.html) request
|
||||
* Perform a [snapshot.restore](http://www.elastic.co/guide/en/elasticsearch/reference/1.4/modules-snapshots.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node
|
||||
@ -5834,7 +5834,7 @@ api.snapshot.prototype.restore = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [snapshot.status](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-snapshots.html) request
|
||||
* Perform a [snapshot.status](http://www.elastic.co/guide/en/elasticsearch/reference/1.4/modules-snapshots.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node
|
||||
@ -5875,7 +5875,7 @@ api.snapshot.prototype.status = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [snapshot.verifyRepository](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-snapshots.html) request
|
||||
* Perform a [snapshot.verifyRepository](http://www.elastic.co/guide/en/elasticsearch/reference/1.4/modules-snapshots.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node
|
||||
@ -5904,7 +5904,7 @@ api.snapshot.prototype.verifyRepository = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [suggest](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/search-suggesters.html) request
|
||||
* Perform a [suggest](http://www.elastic.co/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)
|
||||
@ -5964,7 +5964,7 @@ api.suggest = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [termvector](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/docs-termvectors.html) request
|
||||
* Perform a [termvector](http://www.elastic.co/guide/en/elasticsearch/reference/1.4/docs-termvectors.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} params.source - The URL-encoded request definition
|
||||
@ -6061,7 +6061,7 @@ api.termvector = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [update](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/docs-update.html) request
|
||||
* Perform a [update](http://www.elastic.co/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
|
||||
@ -6168,7 +6168,7 @@ api.update = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [create](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/docs-index_.html) request
|
||||
* Perform a [create](http://www.elastic.co/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
|
||||
|
||||
@ -7,7 +7,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.elastic.co/guide/en/elasticsearch/reference/1.5/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
|
||||
@ -128,7 +128,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.elastic.co/guide/en/elasticsearch/reference/1.5/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
|
||||
@ -185,7 +185,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.elastic.co/guide/en/elasticsearch/reference/1.5/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)
|
||||
@ -232,7 +232,7 @@ api.cat.prototype.count = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.fielddata](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-fielddata.html) request
|
||||
* Perform a [cat.fielddata](http://www.elastic.co/guide/en/elasticsearch/reference/1.5/cat-fielddata.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
|
||||
@ -292,7 +292,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.elastic.co/guide/en/elasticsearch/reference/1.5/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)
|
||||
@ -333,7 +333,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.elastic.co/guide/en/elasticsearch/reference/1.5/cat.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.help - Return help information
|
||||
@ -351,7 +351,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.elastic.co/guide/en/elasticsearch/reference/1.5/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
|
||||
@ -413,7 +413,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.elastic.co/guide/en/elasticsearch/reference/1.5/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)
|
||||
@ -449,7 +449,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.elastic.co/guide/en/elasticsearch/reference/1.5/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)
|
||||
@ -485,7 +485,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.elastic.co/guide/en/elasticsearch/reference/1.5/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)
|
||||
@ -521,7 +521,7 @@ api.cat.prototype.pendingTasks = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.plugins](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-plugins.html) request
|
||||
* Perform a [cat.plugins](http://www.elastic.co/guide/en/elasticsearch/reference/1.5/cat-plugins.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)
|
||||
@ -557,7 +557,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.elastic.co/guide/en/elasticsearch/reference/1.5/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
|
||||
@ -610,7 +610,7 @@ api.cat.prototype.recovery = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.segments](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-segments.html) request
|
||||
* Perform a [cat.segments](http://www.elastic.co/guide/en/elasticsearch/reference/1.5/cat-segments.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String, String[], Boolean} params.h - Comma-separated list of column names to display
|
||||
@ -648,7 +648,7 @@ api.cat.prototype.segments = 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.elastic.co/guide/en/elasticsearch/reference/1.5/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)
|
||||
@ -695,7 +695,7 @@ api.cat.prototype.shards = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.threadPool](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-thread-pool.html) request
|
||||
* Perform a [cat.threadPool](http://www.elastic.co/guide/en/elasticsearch/reference/1.5/cat-thread-pool.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false)
|
||||
@ -737,7 +737,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.elastic.co/guide/en/elasticsearch/reference/1.5/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
|
||||
@ -762,7 +762,7 @@ api.clearScroll = ca({
|
||||
api.cluster = namespace();
|
||||
|
||||
/**
|
||||
* 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.elastic.co/guide/en/elasticsearch/reference/1.5/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)
|
||||
@ -789,7 +789,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.elastic.co/guide/en/elasticsearch/reference/1.5/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
|
||||
@ -862,7 +862,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.elastic.co/guide/en/elasticsearch/reference/1.5/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)
|
||||
@ -884,7 +884,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.elastic.co/guide/en/elasticsearch/reference/1.5/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)
|
||||
@ -912,7 +912,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.elastic.co/guide/en/elasticsearch/reference/1.5/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
|
||||
@ -957,7 +957,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.elastic.co/guide/en/elasticsearch/reference/1.5/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)
|
||||
@ -1047,7 +1047,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.elastic.co/guide/en/elasticsearch/reference/1.5/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)
|
||||
@ -1081,7 +1081,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.elastic.co/guide/en/elasticsearch/reference/1.5/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)
|
||||
@ -1157,7 +1157,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.elastic.co/guide/en/elasticsearch/reference/1.5/search-percolate.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} params.source - The URL-encoded request definition
|
||||
@ -1257,7 +1257,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.elastic.co/guide/en/elasticsearch/reference/1.5/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
|
||||
@ -1334,7 +1334,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.elastic.co/guide/en/elasticsearch/reference/1.5/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
|
||||
@ -1442,7 +1442,7 @@ api.deleteByQuery = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [deleteScript](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-scripting.html) request
|
||||
* Perform a [deleteScript](http://www.elastic.co/guide/en/elasticsearch/reference/1.5/modules-scripting.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
|
||||
@ -1481,7 +1481,7 @@ api.deleteScript = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [deleteTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-template.html) request
|
||||
* Perform a [deleteTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/1.5/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
|
||||
@ -1516,7 +1516,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.elastic.co/guide/en/elasticsearch/reference/1.5/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
|
||||
@ -1564,7 +1564,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.elastic.co/guide/en/elasticsearch/reference/1.5/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)
|
||||
@ -1662,7 +1662,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.elastic.co/guide/en/elasticsearch/reference/1.5/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
|
||||
@ -1742,7 +1742,7 @@ api.get = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [getScript](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-scripting.html) request
|
||||
* Perform a [getScript](http://www.elastic.co/guide/en/elasticsearch/reference/1.5/modules-scripting.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
|
||||
@ -1780,7 +1780,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.elastic.co/guide/en/elasticsearch/reference/1.5/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
|
||||
@ -1856,7 +1856,7 @@ api.getSource = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [getTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-template.html) request
|
||||
* Perform a [getTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/1.5/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
|
||||
@ -1890,7 +1890,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.elastic.co/guide/en/elasticsearch/reference/1.5/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
|
||||
@ -2000,7 +2000,7 @@ api.index = ca({
|
||||
api.indices = namespace();
|
||||
|
||||
/**
|
||||
* Perform a [indices.analyze](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-analyze.html) request
|
||||
* Perform a [indices.analyze](http://www.elastic.co/guide/en/elasticsearch/reference/1.5/indices-analyze.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} params.source - The URL-encoded request definition
|
||||
@ -2071,7 +2071,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.elastic.co/guide/en/elasticsearch/reference/1.5/indices-clearcache.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.fieldData - Clear field data
|
||||
@ -2166,7 +2166,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.elastic.co/guide/en/elasticsearch/reference/1.5/indices-open-close.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.timeout - Explicit operation timeout
|
||||
@ -2217,7 +2217,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.elastic.co/guide/en/elasticsearch/reference/1.5/indices-create-index.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.timeout - Explicit operation timeout
|
||||
@ -2246,7 +2246,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.elastic.co/guide/en/elasticsearch/reference/1.5/indices-delete-index.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.timeout - Explicit operation timeout
|
||||
@ -2275,7 +2275,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.elastic.co/guide/en/elasticsearch/reference/1.5/indices-aliases.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.timeout - Explicit timestamp for the document
|
||||
@ -2308,7 +2308,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.elastic.co/guide/en/elasticsearch/reference/1.5/indices-delete-mapping.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Specify timeout for connection to master
|
||||
@ -2337,7 +2337,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.elastic.co/guide/en/elasticsearch/reference/1.5/indices-templates.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.timeout - Explicit operation timeout
|
||||
@ -2366,7 +2366,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.elastic.co/guide/en/elasticsearch/reference/1.5/indices-warmers.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Specify timeout for connection to master
|
||||
@ -2398,7 +2398,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.elastic.co/guide/en/elasticsearch/reference/1.5/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)
|
||||
@ -2444,7 +2444,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.elastic.co/guide/en/elasticsearch/reference/1.5/indices-aliases.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
|
||||
@ -2515,7 +2515,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.elastic.co/guide/en/elasticsearch/reference/1.5/indices-templates.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node
|
||||
@ -2544,7 +2544,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.elastic.co/guide/en/elasticsearch/reference/1.5/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)
|
||||
@ -2594,7 +2594,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.elastic.co/guide/en/elasticsearch/reference/1.5/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)
|
||||
@ -2650,7 +2650,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.elastic.co/guide/en/elasticsearch/reference/1.5/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)
|
||||
@ -2709,7 +2709,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.elastic.co/guide/en/elasticsearch/reference/1.5/indices-aliases.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
|
||||
@ -2779,7 +2779,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.elastic.co/guide/en/elasticsearch/reference/1.5/indices-aliases.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.timeout - Explicit operation timeout
|
||||
@ -2831,7 +2831,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.elastic.co/guide/en/elasticsearch/reference/1.5/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
|
||||
@ -2921,7 +2921,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.elastic.co/guide/en/elasticsearch/reference/1.5/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)
|
||||
@ -2991,7 +2991,7 @@ api.indices.prototype.getMapping = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.getSettings](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-get-settings.html) request
|
||||
* Perform a [indices.getSettings](http://www.elastic.co/guide/en/elasticsearch/reference/1.5/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)
|
||||
@ -3069,7 +3069,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.elastic.co/guide/en/elasticsearch/reference/1.5/indices-templates.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.flatSettings - Return settings in flat format (default: false)
|
||||
@ -3107,7 +3107,7 @@ api.indices.prototype.getTemplate = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.getUpgrade](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/indices-upgrade.html) request
|
||||
* Perform a [indices.getUpgrade](http://www.elastic.co/guide/en/elasticsearch/reference/1.5/indices-upgrade.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)
|
||||
@ -3158,7 +3158,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.elastic.co/guide/en/elasticsearch/reference/1.5/indices-warmers.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
|
||||
@ -3243,7 +3243,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.elastic.co/guide/en/elasticsearch/reference/1.5/indices-open-close.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.timeout - Explicit operation timeout
|
||||
@ -3294,7 +3294,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.elastic.co/guide/en/elasticsearch/reference/1.5/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)
|
||||
@ -3368,7 +3368,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.elastic.co/guide/en/elasticsearch/reference/1.5/indices-aliases.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.timeout - Explicit timestamp for the document
|
||||
@ -3401,7 +3401,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.elastic.co/guide/en/elasticsearch/reference/1.5/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)
|
||||
@ -3472,7 +3472,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.elastic.co/guide/en/elasticsearch/reference/1.5/indices-update-settings.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Specify timeout for connection to master
|
||||
@ -3530,7 +3530,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.elastic.co/guide/en/elasticsearch/reference/1.5/indices-templates.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Number} params.order - The order for this template when merging multiple matching ones (higher numbers are merged later, overriding the lower numbers)
|
||||
@ -3574,7 +3574,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.elastic.co/guide/en/elasticsearch/reference/1.5/indices-warmers.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Specify timeout for connection to master
|
||||
@ -3651,7 +3651,7 @@ api.indices.prototype.putWarmer = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.recovery](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/indices-recovery.html) request
|
||||
* Perform a [indices.recovery](http://www.elastic.co/guide/en/elasticsearch/reference/1.5/indices-recovery.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.detailed - Whether to display detailed information about shard recovery
|
||||
@ -3691,7 +3691,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.elastic.co/guide/en/elasticsearch/reference/1.5/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)
|
||||
@ -3747,7 +3747,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.elastic.co/guide/en/elasticsearch/reference/1.5/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)
|
||||
@ -3802,7 +3802,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.elastic.co/guide/en/elasticsearch/reference/1.5/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)
|
||||
@ -3923,7 +3923,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.elastic.co/guide/en/elasticsearch/reference/1.5/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)
|
||||
@ -3986,7 +3986,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.elastic.co/guide/en/elasticsearch/reference/1.5/indices-aliases.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.timeout - Request timeout
|
||||
@ -4010,7 +4010,7 @@ api.indices.prototype.updateAliases = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.upgrade](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/indices-upgrade.html) request
|
||||
* Perform a [indices.upgrade](http://www.elastic.co/guide/en/elasticsearch/reference/1.5/indices-upgrade.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
|
||||
@ -4062,7 +4062,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.elastic.co/guide/en/elasticsearch/reference/1.5/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
|
||||
@ -4137,7 +4137,7 @@ api.indices.prototype.validateQuery = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [info](http://www.elasticsearch.org/guide/) request
|
||||
* Perform a [info](http://www.elastic.co/guide/) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
*/
|
||||
@ -4148,7 +4148,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.elastic.co/guide/en/elasticsearch/reference/1.5/docs-multi-get.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} params.source - The URL-encoded request definition
|
||||
@ -4220,7 +4220,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.elastic.co/guide/en/elasticsearch/reference/1.5/search-more-like-this.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} params.source - The URL-encoded request definition
|
||||
@ -4341,7 +4341,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.elastic.co/guide/en/elasticsearch/reference/1.5/search-percolate.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} params.source - The URL-encoded request definition
|
||||
@ -4406,7 +4406,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.elastic.co/guide/en/elasticsearch/reference/1.5/search-multi-search.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} params.source - The URL-encoded request definition
|
||||
@ -4462,7 +4462,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.elastic.co/guide/en/elasticsearch/reference/1.5/docs-multi-termvectors.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} params.source - The URL-encoded request definition
|
||||
@ -4568,7 +4568,7 @@ api.mtermvectors = ca({
|
||||
api.nodes = namespace();
|
||||
|
||||
/**
|
||||
* 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.elastic.co/guide/en/elasticsearch/reference/1.5/cluster-nodes-hot-threads.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.interval - The interval for the second sampling of threads
|
||||
@ -4618,7 +4618,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.elastic.co/guide/en/elasticsearch/reference/1.5/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)
|
||||
@ -4694,7 +4694,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.elastic.co/guide/en/elasticsearch/reference/1.5/cluster-nodes-shutdown.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.delay - Set the delay for the operation (default: 1s)
|
||||
@ -4727,7 +4727,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.elastic.co/guide/en/elasticsearch/reference/1.5/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)
|
||||
@ -4926,7 +4926,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.elastic.co/guide/en/elasticsearch/reference/1.5/search-percolate.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} params.source - The URL-encoded request definition
|
||||
@ -5044,7 +5044,7 @@ api.percolate = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [ping](http://www.elasticsearch.org/guide/) request
|
||||
* Perform a [ping](http://www.elastic.co/guide/) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
*/
|
||||
@ -5057,7 +5057,7 @@ api.ping = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [putScript](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-scripting.html) request
|
||||
* Perform a [putScript](http://www.elastic.co/guide/en/elasticsearch/reference/1.5/modules-scripting.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} [params.opType=index] - Explicit operation type
|
||||
@ -5107,7 +5107,7 @@ api.putScript = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [putTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-template.html) request
|
||||
* Perform a [putTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/1.5/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
|
||||
@ -5153,7 +5153,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.elastic.co/guide/en/elasticsearch/reference/1.5/search-request-scroll.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} params.source - The URL-encoded request definition
|
||||
@ -5191,7 +5191,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.elastic.co/guide/en/elasticsearch/reference/1.5/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
|
||||
@ -5407,7 +5407,7 @@ api.search = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [searchExists](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-exists.html) request
|
||||
* Perform a [searchExists](http://www.elastic.co/guide/en/elasticsearch/reference/1.5/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)
|
||||
@ -5483,7 +5483,7 @@ api.searchExists = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [searchShards](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-shards.html) request
|
||||
* Perform a [searchShards](http://www.elastic.co/guide/en/elasticsearch/reference/1.5/search-shards.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} params.preference - Specify the node or shard the operation should be performed on (default: random)
|
||||
@ -5554,7 +5554,7 @@ api.searchShards = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [searchTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-template.html) request
|
||||
* Perform a [searchTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} params.source - The URL-encoded request definition
|
||||
@ -5644,7 +5644,7 @@ api.searchTemplate = ca({
|
||||
api.snapshot = namespace();
|
||||
|
||||
/**
|
||||
* Perform a [snapshot.create](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/modules-snapshots.html) request
|
||||
* Perform a [snapshot.create](http://www.elastic.co/guide/en/elasticsearch/reference/1.5/modules-snapshots.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node
|
||||
@ -5679,7 +5679,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.elastic.co/guide/en/elasticsearch/reference/1.5/modules-snapshots.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node
|
||||
@ -5713,7 +5713,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.elastic.co/guide/en/elasticsearch/reference/1.5/modules-snapshots.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node
|
||||
@ -5742,7 +5742,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.elastic.co/guide/en/elasticsearch/reference/1.5/modules-snapshots.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node
|
||||
@ -5771,7 +5771,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.elastic.co/guide/en/elasticsearch/reference/1.5/modules-snapshots.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node
|
||||
@ -5799,7 +5799,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.elastic.co/guide/en/elasticsearch/reference/1.5/modules-snapshots.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node
|
||||
@ -5832,7 +5832,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.elastic.co/guide/en/elasticsearch/reference/1.5/modules-snapshots.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node
|
||||
@ -5867,7 +5867,7 @@ api.snapshot.prototype.restore = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [snapshot.status](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-snapshots.html) request
|
||||
* Perform a [snapshot.status](http://www.elastic.co/guide/en/elasticsearch/reference/1.5/modules-snapshots.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node
|
||||
@ -5908,7 +5908,7 @@ api.snapshot.prototype.status = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [snapshot.verifyRepository](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-snapshots.html) request
|
||||
* Perform a [snapshot.verifyRepository](http://www.elastic.co/guide/en/elasticsearch/reference/1.5/modules-snapshots.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node
|
||||
@ -5937,7 +5937,7 @@ api.snapshot.prototype.verifyRepository = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [suggest](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-suggesters.html) request
|
||||
* Perform a [suggest](http://www.elastic.co/guide/en/elasticsearch/reference/1.5/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)
|
||||
@ -5997,7 +5997,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.elastic.co/guide/en/elasticsearch/reference/1.5/docs-termvectors.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} params.source - The URL-encoded request definition
|
||||
@ -6099,7 +6099,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.elastic.co/guide/en/elasticsearch/reference/1.5/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
|
||||
@ -6206,7 +6206,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.elastic.co/guide/en/elasticsearch/reference/1.5/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
|
||||
|
||||
@ -241,7 +241,7 @@ api.cat.prototype.count = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.fielddata](http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-fielddata.html) request
|
||||
* Perform a [cat.fielddata](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/cat-fielddata.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
|
||||
@ -530,7 +530,7 @@ api.cat.prototype.pendingTasks = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.plugins](http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-plugins.html) request
|
||||
* Perform a [cat.plugins](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/cat-plugins.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)
|
||||
@ -619,7 +619,7 @@ api.cat.prototype.recovery = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.segments](http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-segments.html) request
|
||||
* Perform a [cat.segments](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/cat-segments.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String, String[], Boolean} params.h - Comma-separated list of column names to display
|
||||
@ -704,7 +704,7 @@ api.cat.prototype.shards = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.threadPool](http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-thread-pool.html) request
|
||||
* Perform a [cat.threadPool](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/cat-thread-pool.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false)
|
||||
@ -1477,7 +1477,7 @@ api.deleteByQuery = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [deleteScript](http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html) request
|
||||
* Perform a [deleteScript](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/modules-scripting.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
|
||||
@ -1516,7 +1516,7 @@ api.deleteScript = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [deleteTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-template.html) request
|
||||
* Perform a [deleteTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/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
|
||||
@ -1693,7 +1693,7 @@ api.explain = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [fieldStats](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-field-stats.html) request
|
||||
* Perform a [fieldStats](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/search-field-stats.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 for to get field statistics for (min value, max value, and more)
|
||||
@ -1833,7 +1833,7 @@ api.get = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [getScript](http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html) request
|
||||
* Perform a [getScript](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/modules-scripting.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
|
||||
@ -1947,7 +1947,7 @@ api.getSource = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [getTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-template.html) request
|
||||
* Perform a [getTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/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
|
||||
@ -2737,7 +2737,7 @@ api.indices.prototype.flush = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.flushSynced](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-synced-flush.html) request
|
||||
* Perform a [indices.flushSynced](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-synced-flush.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String, String[], Boolean} params.index - A comma-separated list of index names; use `_all` or empty string for all indices
|
||||
@ -3220,7 +3220,7 @@ api.indices.prototype.getTemplate = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.getUpgrade](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-upgrade.html) request
|
||||
* Perform a [indices.getUpgrade](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-upgrade.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)
|
||||
@ -3764,7 +3764,7 @@ api.indices.prototype.putWarmer = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.recovery](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-recovery.html) request
|
||||
* Perform a [indices.recovery](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-recovery.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.detailed - Whether to display detailed information about shard recovery
|
||||
@ -4123,7 +4123,7 @@ api.indices.prototype.updateAliases = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.upgrade](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-upgrade.html) request
|
||||
* Perform a [indices.upgrade](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-upgrade.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
|
||||
@ -5183,7 +5183,7 @@ api.ping = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [putScript](http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html) request
|
||||
* Perform a [putScript](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/modules-scripting.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} [params.opType=index] - Explicit operation type
|
||||
@ -5233,7 +5233,7 @@ api.putScript = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [putTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-template.html) request
|
||||
* Perform a [putTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/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
|
||||
@ -5520,7 +5520,7 @@ api.search = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [searchExists](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-exists.html) request
|
||||
* Perform a [searchExists](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/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)
|
||||
@ -5628,7 +5628,7 @@ api.searchExists = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [searchShards](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-shards.html) request
|
||||
* Perform a [searchShards](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/search-shards.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} params.preference - Specify the node or shard the operation should be performed on (default: random)
|
||||
@ -6008,7 +6008,7 @@ api.snapshot.prototype.restore = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [snapshot.status](http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html) request
|
||||
* Perform a [snapshot.status](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/modules-snapshots.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node
|
||||
@ -6049,7 +6049,7 @@ api.snapshot.prototype.status = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [snapshot.verifyRepository](http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html) request
|
||||
* Perform a [snapshot.verifyRepository](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/modules-snapshots.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node
|
||||
|
||||
@ -241,7 +241,7 @@ api.cat.prototype.count = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.fielddata](http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-fielddata.html) request
|
||||
* Perform a [cat.fielddata](http://www.elastic.co/guide/en/elasticsearch/reference/1.7/cat-fielddata.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
|
||||
@ -530,7 +530,7 @@ api.cat.prototype.pendingTasks = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.plugins](http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-plugins.html) request
|
||||
* Perform a [cat.plugins](http://www.elastic.co/guide/en/elasticsearch/reference/1.7/cat-plugins.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)
|
||||
@ -619,7 +619,7 @@ api.cat.prototype.recovery = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.segments](http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-segments.html) request
|
||||
* Perform a [cat.segments](http://www.elastic.co/guide/en/elasticsearch/reference/1.7/cat-segments.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String, String[], Boolean} params.h - Comma-separated list of column names to display
|
||||
@ -704,7 +704,7 @@ api.cat.prototype.shards = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.threadPool](http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-thread-pool.html) request
|
||||
* Perform a [cat.threadPool](http://www.elastic.co/guide/en/elasticsearch/reference/1.7/cat-thread-pool.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false)
|
||||
@ -1481,7 +1481,7 @@ api.deleteByQuery = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [deleteScript](http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html) request
|
||||
* Perform a [deleteScript](http://www.elastic.co/guide/en/elasticsearch/reference/1.7/modules-scripting.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
|
||||
@ -1520,7 +1520,7 @@ api.deleteScript = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [deleteTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-template.html) request
|
||||
* Perform a [deleteTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/1.7/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
|
||||
@ -1697,7 +1697,7 @@ api.explain = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [fieldStats](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-field-stats.html) request
|
||||
* Perform a [fieldStats](http://www.elastic.co/guide/en/elasticsearch/reference/1.7/search-field-stats.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 for to get field statistics for (min value, max value, and more)
|
||||
@ -1837,7 +1837,7 @@ api.get = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [getScript](http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html) request
|
||||
* Perform a [getScript](http://www.elastic.co/guide/en/elasticsearch/reference/1.7/modules-scripting.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
|
||||
@ -1951,7 +1951,7 @@ api.getSource = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [getTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-template.html) request
|
||||
* Perform a [getTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/1.7/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
|
||||
@ -2741,7 +2741,7 @@ api.indices.prototype.flush = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.flushSynced](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-synced-flush.html) request
|
||||
* Perform a [indices.flushSynced](http://www.elastic.co/guide/en/elasticsearch/reference/1.7/indices-synced-flush.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String, String[], Boolean} params.index - A comma-separated list of index names; use `_all` or empty string for all indices
|
||||
@ -3224,7 +3224,7 @@ api.indices.prototype.getTemplate = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.getUpgrade](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-upgrade.html) request
|
||||
* Perform a [indices.getUpgrade](http://www.elastic.co/guide/en/elasticsearch/reference/1.7/indices-upgrade.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)
|
||||
@ -3768,7 +3768,7 @@ api.indices.prototype.putWarmer = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.recovery](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-recovery.html) request
|
||||
* Perform a [indices.recovery](http://www.elastic.co/guide/en/elasticsearch/reference/1.7/indices-recovery.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.detailed - Whether to display detailed information about shard recovery
|
||||
@ -4127,7 +4127,7 @@ api.indices.prototype.updateAliases = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.upgrade](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-upgrade.html) request
|
||||
* Perform a [indices.upgrade](http://www.elastic.co/guide/en/elasticsearch/reference/1.7/indices-upgrade.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
|
||||
@ -5199,7 +5199,7 @@ api.ping = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [putScript](http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html) request
|
||||
* Perform a [putScript](http://www.elastic.co/guide/en/elasticsearch/reference/1.7/modules-scripting.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} [params.opType=index] - Explicit operation type
|
||||
@ -5249,7 +5249,7 @@ api.putScript = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [putTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-template.html) request
|
||||
* Perform a [putTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/1.7/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
|
||||
@ -5536,7 +5536,7 @@ api.search = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [searchExists](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-exists.html) request
|
||||
* Perform a [searchExists](http://www.elastic.co/guide/en/elasticsearch/reference/1.7/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)
|
||||
@ -5644,7 +5644,7 @@ api.searchExists = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [searchShards](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-shards.html) request
|
||||
* Perform a [searchShards](http://www.elastic.co/guide/en/elasticsearch/reference/1.7/search-shards.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} params.preference - Specify the node or shard the operation should be performed on (default: random)
|
||||
@ -6024,7 +6024,7 @@ api.snapshot.prototype.restore = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [snapshot.status](http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html) request
|
||||
* Perform a [snapshot.status](http://www.elastic.co/guide/en/elasticsearch/reference/1.7/modules-snapshots.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node
|
||||
@ -6065,7 +6065,7 @@ api.snapshot.prototype.status = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [snapshot.verifyRepository](http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html) request
|
||||
* Perform a [snapshot.verifyRepository](http://www.elastic.co/guide/en/elasticsearch/reference/1.7/modules-snapshots.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node
|
||||
|
||||
@ -16,7 +16,7 @@ var api = module.exports = {};
|
||||
api._namespaces = ['cat', 'cluster', 'indices', 'nodes', 'snapshot'];
|
||||
|
||||
/**
|
||||
* Perform a [bulk](http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-bulk.html) request
|
||||
* Perform a [bulk](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/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
|
||||
@ -132,7 +132,7 @@ api.cat.prototype.aliases = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.allocation](http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-allocation.html) request
|
||||
* Perform a [cat.allocation](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/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
|
||||
@ -189,7 +189,7 @@ api.cat.prototype.allocation = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.count](http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-count.html) request
|
||||
* Perform a [cat.count](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/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)
|
||||
@ -236,7 +236,7 @@ api.cat.prototype.count = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.fielddata](http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-fielddata.html) request
|
||||
* Perform a [cat.fielddata](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/cat-fielddata.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
|
||||
@ -296,7 +296,7 @@ api.cat.prototype.fielddata = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.health](http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-health.html) request
|
||||
* Perform a [cat.health](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/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)
|
||||
@ -337,7 +337,7 @@ api.cat.prototype.health = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.help](http://www.elastic.co/guide/en/elasticsearch/reference/master/cat.html) request
|
||||
* Perform a [cat.help](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/cat.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.help - Return help information
|
||||
@ -355,7 +355,7 @@ api.cat.prototype.help = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.indices](http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-indices.html) request
|
||||
* Perform a [cat.indices](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/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
|
||||
@ -417,7 +417,7 @@ api.cat.prototype.indices = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.master](http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-master.html) request
|
||||
* Perform a [cat.master](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/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)
|
||||
@ -453,7 +453,7 @@ api.cat.prototype.master = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.nodeattrs](http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodeattrs.html) request
|
||||
* Perform a [cat.nodeattrs](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/cat-nodeattrs.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)
|
||||
@ -489,7 +489,7 @@ api.cat.prototype.nodeattrs = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.nodes](http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodes.html) request
|
||||
* Perform a [cat.nodes](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/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)
|
||||
@ -525,7 +525,7 @@ api.cat.prototype.nodes = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.pendingTasks](http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-pending-tasks.html) request
|
||||
* Perform a [cat.pendingTasks](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/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)
|
||||
@ -561,7 +561,7 @@ api.cat.prototype.pendingTasks = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.plugins](http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-plugins.html) request
|
||||
* Perform a [cat.plugins](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/cat-plugins.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)
|
||||
@ -597,7 +597,7 @@ api.cat.prototype.plugins = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.recovery](http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-recovery.html) request
|
||||
* Perform a [cat.recovery](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/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
|
||||
@ -650,7 +650,7 @@ api.cat.prototype.recovery = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.segments](http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-segments.html) request
|
||||
* Perform a [cat.segments](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/cat-segments.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String, String[], Boolean} params.h - Comma-separated list of column names to display
|
||||
@ -688,7 +688,7 @@ api.cat.prototype.segments = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.shards](http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-shards.html) request
|
||||
* Perform a [cat.shards](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/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)
|
||||
@ -735,7 +735,7 @@ api.cat.prototype.shards = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.threadPool](http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-thread-pool.html) request
|
||||
* Perform a [cat.threadPool](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/cat-thread-pool.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false)
|
||||
@ -777,7 +777,7 @@ api.cat.prototype.threadPool = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [clearScroll](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-request-scroll.html) request
|
||||
* Perform a [clearScroll](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/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
|
||||
@ -802,7 +802,7 @@ api.clearScroll = ca({
|
||||
api.cluster = namespace();
|
||||
|
||||
/**
|
||||
* Perform a [cluster.getSettings](http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-update-settings.html) request
|
||||
* Perform a [cluster.getSettings](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/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)
|
||||
@ -829,7 +829,7 @@ api.cluster.prototype.getSettings = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cluster.health](http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-health.html) request
|
||||
* Perform a [cluster.health](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/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
|
||||
@ -902,7 +902,7 @@ api.cluster.prototype.health = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cluster.pendingTasks](http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-pending.html) request
|
||||
* Perform a [cluster.pendingTasks](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/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)
|
||||
@ -924,7 +924,7 @@ api.cluster.prototype.pendingTasks = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cluster.putSettings](http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-update-settings.html) request
|
||||
* Perform a [cluster.putSettings](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/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)
|
||||
@ -952,7 +952,7 @@ api.cluster.prototype.putSettings = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cluster.reroute](http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-reroute.html) request
|
||||
* Perform a [cluster.reroute](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/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
|
||||
@ -997,7 +997,7 @@ api.cluster.prototype.reroute = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cluster.state](http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-state.html) request
|
||||
* Perform a [cluster.state](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/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)
|
||||
@ -1089,7 +1089,7 @@ api.cluster.prototype.state = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cluster.stats](http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-stats.html) request
|
||||
* Perform a [cluster.stats](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/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)
|
||||
@ -1127,7 +1127,7 @@ api.cluster.prototype.stats = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [count](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-count.html) request
|
||||
* Perform a [count](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/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)
|
||||
@ -1235,7 +1235,7 @@ api.count = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [countPercolate](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-percolate.html) request
|
||||
* Perform a [countPercolate](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/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
|
||||
@ -1331,7 +1331,7 @@ api.countPercolate = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [delete](http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete.html) request
|
||||
* Perform a [delete](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/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
|
||||
@ -1399,7 +1399,7 @@ api['delete'] = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [deleteScript](http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html) request
|
||||
* Perform a [deleteScript](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/modules-scripting.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
|
||||
@ -1438,7 +1438,7 @@ api.deleteScript = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [deleteTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-template.html) request
|
||||
* Perform a [deleteTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/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
|
||||
@ -1473,7 +1473,7 @@ api.deleteTemplate = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [exists](http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html) request
|
||||
* Perform a [exists](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/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
|
||||
@ -1521,7 +1521,7 @@ api.exists = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [explain](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-explain.html) request
|
||||
* Perform a [explain](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/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)
|
||||
@ -1615,7 +1615,7 @@ api.explain = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [fieldStats](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-field-stats.html) request
|
||||
* Perform a [fieldStats](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/search-field-stats.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 for to get field statistics for (min value, max value, and more)
|
||||
@ -1675,7 +1675,7 @@ api.fieldStats = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [get](http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html) request
|
||||
* Perform a [get](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/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
|
||||
@ -1755,7 +1755,7 @@ api.get = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [getScript](http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html) request
|
||||
* Perform a [getScript](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/modules-scripting.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
|
||||
@ -1793,7 +1793,7 @@ api.getScript = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [getSource](http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html) request
|
||||
* Perform a [getSource](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/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
|
||||
@ -1869,7 +1869,7 @@ api.getSource = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [getTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-template.html) request
|
||||
* Perform a [getTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/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
|
||||
@ -1903,7 +1903,7 @@ api.getTemplate = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [index](http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html) request
|
||||
* Perform a [index](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/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
|
||||
@ -2004,7 +2004,7 @@ api.index = ca({
|
||||
api.indices = namespace();
|
||||
|
||||
/**
|
||||
* Perform a [indices.analyze](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-analyze.html) request
|
||||
* Perform a [indices.analyze](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/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
|
||||
@ -2071,7 +2071,7 @@ api.indices.prototype.analyze = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.clearCache](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-clearcache.html) request
|
||||
* Perform a [indices.clearCache](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-clearcache.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.fieldData - Clear field data
|
||||
@ -2146,7 +2146,7 @@ api.indices.prototype.clearCache = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.close](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-open-close.html) request
|
||||
* Perform a [indices.close](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-open-close.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.timeout - Explicit operation timeout
|
||||
@ -2197,7 +2197,7 @@ api.indices.prototype.close = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.create](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-create-index.html) request
|
||||
* Perform a [indices.create](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-create-index.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.timeout - Explicit operation timeout
|
||||
@ -2231,7 +2231,7 @@ api.indices.prototype.create = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.delete](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-delete-index.html) request
|
||||
* Perform a [indices.delete](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-delete-index.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.timeout - Explicit operation timeout
|
||||
@ -2260,7 +2260,7 @@ api.indices.prototype['delete'] = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.deleteAlias](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html) request
|
||||
* Perform a [indices.deleteAlias](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-aliases.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.timeout - Explicit timestamp for the document
|
||||
@ -2293,7 +2293,7 @@ api.indices.prototype.deleteAlias = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.deleteTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html) request
|
||||
* Perform a [indices.deleteTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-templates.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.timeout - Explicit operation timeout
|
||||
@ -2322,7 +2322,7 @@ api.indices.prototype.deleteTemplate = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.deleteWarmer](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-warmers.html) request
|
||||
* Perform a [indices.deleteWarmer](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-warmers.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Specify timeout for connection to master
|
||||
@ -2354,7 +2354,7 @@ api.indices.prototype.deleteWarmer = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.exists](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-exists.html) request
|
||||
* Perform a [indices.exists](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/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)
|
||||
@ -2400,7 +2400,7 @@ api.indices.prototype.exists = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.existsAlias](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html) request
|
||||
* Perform a [indices.existsAlias](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-aliases.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
|
||||
@ -2471,7 +2471,7 @@ api.indices.prototype.existsAlias = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.existsTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html) request
|
||||
* Perform a [indices.existsTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-templates.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node
|
||||
@ -2500,7 +2500,7 @@ api.indices.prototype.existsTemplate = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.existsType](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-types-exists.html) request
|
||||
* Perform a [indices.existsType](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/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)
|
||||
@ -2550,7 +2550,7 @@ api.indices.prototype.existsType = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.flush](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-flush.html) request
|
||||
* Perform a [indices.flush](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/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)
|
||||
@ -2606,7 +2606,7 @@ api.indices.prototype.flush = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.flushSynced](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-synced-flush.html) request
|
||||
* Perform a [indices.flushSynced](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-synced-flush.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)
|
||||
@ -2653,7 +2653,7 @@ api.indices.prototype.flushSynced = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.get](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-index.html) request
|
||||
* Perform a [indices.get](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/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)
|
||||
@ -2728,7 +2728,7 @@ api.indices.prototype.get = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.getAlias](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html) request
|
||||
* Perform a [indices.getAlias](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-aliases.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
|
||||
@ -2798,7 +2798,7 @@ api.indices.prototype.getAlias = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.getAliases](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html) request
|
||||
* Perform a [indices.getAliases](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-aliases.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.timeout - Explicit operation timeout
|
||||
@ -2850,7 +2850,7 @@ api.indices.prototype.getAliases = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.getFieldMapping](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-field-mapping.html) request
|
||||
* Perform a [indices.getFieldMapping](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/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
|
||||
@ -2940,7 +2940,7 @@ api.indices.prototype.getFieldMapping = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.getMapping](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-mapping.html) request
|
||||
* Perform a [indices.getMapping](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/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)
|
||||
@ -3010,7 +3010,7 @@ api.indices.prototype.getMapping = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.getSettings](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-settings.html) request
|
||||
* Perform a [indices.getSettings](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/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)
|
||||
@ -3093,7 +3093,7 @@ api.indices.prototype.getSettings = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.getTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html) request
|
||||
* Perform a [indices.getTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-templates.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.flatSettings - Return settings in flat format (default: false)
|
||||
@ -3131,7 +3131,7 @@ api.indices.prototype.getTemplate = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.getUpgrade](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-upgrade.html) request
|
||||
* Perform a [indices.getUpgrade](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-upgrade.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)
|
||||
@ -3182,7 +3182,7 @@ api.indices.prototype.getUpgrade = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.getWarmer](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-warmers.html) request
|
||||
* Perform a [indices.getWarmer](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-warmers.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
|
||||
@ -3267,7 +3267,7 @@ api.indices.prototype.getWarmer = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.open](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-open-close.html) request
|
||||
* Perform a [indices.open](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-open-close.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.timeout - Explicit operation timeout
|
||||
@ -3318,7 +3318,7 @@ api.indices.prototype.open = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.optimize](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-optimize.html) request
|
||||
* Perform a [indices.optimize](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/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)
|
||||
@ -3388,7 +3388,7 @@ api.indices.prototype.optimize = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.putAlias](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html) request
|
||||
* Perform a [indices.putAlias](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-aliases.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.timeout - Explicit timestamp for the document
|
||||
@ -3421,7 +3421,7 @@ api.indices.prototype.putAlias = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.putMapping](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-put-mapping.html) request
|
||||
* Perform a [indices.putMapping](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-put-mapping.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.timeout - Explicit operation timeout
|
||||
@ -3492,7 +3492,7 @@ api.indices.prototype.putMapping = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.putSettings](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-update-settings.html) request
|
||||
* Perform a [indices.putSettings](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-update-settings.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Specify timeout for connection to master
|
||||
@ -3550,7 +3550,7 @@ api.indices.prototype.putSettings = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.putTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html) request
|
||||
* Perform a [indices.putTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-templates.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Number} params.order - The order for this template when merging multiple matching ones (higher numbers are merged later, overriding the lower numbers)
|
||||
@ -3594,7 +3594,7 @@ api.indices.prototype.putTemplate = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.putWarmer](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-warmers.html) request
|
||||
* Perform a [indices.putWarmer](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-warmers.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Specify timeout for connection to master
|
||||
@ -3676,7 +3676,7 @@ api.indices.prototype.putWarmer = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.recovery](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-recovery.html) request
|
||||
* Perform a [indices.recovery](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-recovery.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.detailed - Whether to display detailed information about shard recovery
|
||||
@ -3716,7 +3716,7 @@ api.indices.prototype.recovery = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.refresh](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-refresh.html) request
|
||||
* Perform a [indices.refresh](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/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)
|
||||
@ -3772,7 +3772,7 @@ api.indices.prototype.refresh = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.segments](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-segments.html) request
|
||||
* Perform a [indices.segments](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/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)
|
||||
@ -3827,7 +3827,7 @@ api.indices.prototype.segments = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.shardStores](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-shards-stores.html) request
|
||||
* Perform a [indices.shardStores](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-shards-stores.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String, String[], Boolean} params.status - A comma-separated list of statuses used to filter on shards to get store information for
|
||||
@ -3887,7 +3887,7 @@ api.indices.prototype.shardStores = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.stats](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-stats.html) request
|
||||
* Perform a [indices.stats](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/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)
|
||||
@ -4006,7 +4006,7 @@ api.indices.prototype.stats = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.updateAliases](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html) request
|
||||
* Perform a [indices.updateAliases](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-aliases.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.timeout - Request timeout
|
||||
@ -4030,7 +4030,7 @@ api.indices.prototype.updateAliases = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.upgrade](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-upgrade.html) request
|
||||
* Perform a [indices.upgrade](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-upgrade.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
|
||||
@ -4087,7 +4087,7 @@ api.indices.prototype.upgrade = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.validateQuery](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-validate.html) request
|
||||
* Perform a [indices.validateQuery](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/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
|
||||
@ -4205,7 +4205,7 @@ api.info = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [mget](http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-get.html) request
|
||||
* Perform a [mget](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/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
|
||||
@ -4273,7 +4273,7 @@ api.mget = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [mpercolate](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-percolate.html) request
|
||||
* Perform a [mpercolate](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/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)
|
||||
@ -4334,7 +4334,7 @@ api.mpercolate = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [msearch](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-multi-search.html) request
|
||||
* Perform a [msearch](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/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
|
||||
@ -4386,7 +4386,7 @@ api.msearch = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [mtermvectors](http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-termvectors.html) request
|
||||
* Perform a [mtermvectors](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/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
|
||||
@ -4502,7 +4502,7 @@ api.mtermvectors = ca({
|
||||
api.nodes = namespace();
|
||||
|
||||
/**
|
||||
* Perform a [nodes.hotThreads](http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-hot-threads.html) request
|
||||
* Perform a [nodes.hotThreads](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/cluster-nodes-hot-threads.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.interval - The interval for the second sampling of threads
|
||||
@ -4556,7 +4556,7 @@ api.nodes.prototype.hotThreads = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [nodes.info](http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-info.html) request
|
||||
* Perform a [nodes.info](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/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)
|
||||
@ -4634,7 +4634,7 @@ api.nodes.prototype.info = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [nodes.stats](http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-stats.html) request
|
||||
* Perform a [nodes.stats](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/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)
|
||||
@ -4831,7 +4831,7 @@ api.nodes.prototype.stats = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [percolate](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-percolate.html) request
|
||||
* Perform a [percolate](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/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
|
||||
@ -4958,7 +4958,7 @@ api.ping = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [putScript](http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html) request
|
||||
* Perform a [putScript](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/modules-scripting.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} [params.opType=index] - Explicit operation type
|
||||
@ -5008,7 +5008,7 @@ api.putScript = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [putTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-template.html) request
|
||||
* Perform a [putTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/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
|
||||
@ -5054,7 +5054,7 @@ api.putTemplate = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [renderSearchTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-template.html) request
|
||||
* Perform a [renderSearchTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/2.0/search-template.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} params.id - The id of the stored search template
|
||||
@ -5077,7 +5077,7 @@ api.renderSearchTemplate = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [scroll](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-request-scroll.html) request
|
||||
* Perform a [scroll](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/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
|
||||
@ -5111,7 +5111,7 @@ api.scroll = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [search](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-search.html) request
|
||||
* Perform a [search](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/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
|
||||
@ -5321,7 +5321,7 @@ api.search = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [searchExists](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-exists.html) request
|
||||
* Perform a [searchExists](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/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)
|
||||
@ -5429,7 +5429,7 @@ api.searchExists = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [searchShards](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-shards.html) request
|
||||
* Perform a [searchShards](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/search-shards.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} params.preference - Specify the node or shard the operation should be performed on (default: random)
|
||||
@ -5586,7 +5586,7 @@ api.searchTemplate = ca({
|
||||
api.snapshot = namespace();
|
||||
|
||||
/**
|
||||
* Perform a [snapshot.create](http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html) request
|
||||
* Perform a [snapshot.create](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/modules-snapshots.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node
|
||||
@ -5621,7 +5621,7 @@ api.snapshot.prototype.create = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [snapshot.createRepository](http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html) request
|
||||
* Perform a [snapshot.createRepository](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/modules-snapshots.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node
|
||||
@ -5655,7 +5655,7 @@ api.snapshot.prototype.createRepository = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [snapshot.delete](http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html) request
|
||||
* Perform a [snapshot.delete](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/modules-snapshots.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node
|
||||
@ -5684,7 +5684,7 @@ api.snapshot.prototype['delete'] = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [snapshot.deleteRepository](http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html) request
|
||||
* Perform a [snapshot.deleteRepository](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/modules-snapshots.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node
|
||||
@ -5713,7 +5713,7 @@ api.snapshot.prototype.deleteRepository = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [snapshot.get](http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html) request
|
||||
* Perform a [snapshot.get](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/modules-snapshots.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node
|
||||
@ -5741,7 +5741,7 @@ api.snapshot.prototype.get = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [snapshot.getRepository](http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html) request
|
||||
* Perform a [snapshot.getRepository](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/modules-snapshots.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node
|
||||
@ -5774,7 +5774,7 @@ api.snapshot.prototype.getRepository = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [snapshot.restore](http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html) request
|
||||
* Perform a [snapshot.restore](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/modules-snapshots.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node
|
||||
@ -5809,7 +5809,7 @@ api.snapshot.prototype.restore = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [snapshot.status](http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html) request
|
||||
* Perform a [snapshot.status](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/modules-snapshots.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node
|
||||
@ -5850,7 +5850,7 @@ api.snapshot.prototype.status = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [snapshot.verifyRepository](http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html) request
|
||||
* Perform a [snapshot.verifyRepository](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/modules-snapshots.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node
|
||||
@ -5879,7 +5879,7 @@ api.snapshot.prototype.verifyRepository = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [suggest](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-suggesters.html) request
|
||||
* Perform a [suggest](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/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)
|
||||
@ -5935,7 +5935,7 @@ api.suggest = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [termvectors](http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-termvectors.html) request
|
||||
* Perform a [termvectors](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/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.
|
||||
@ -6054,7 +6054,7 @@ api.termvectors = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [update](http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update.html) request
|
||||
* Perform a [update](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/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
|
||||
@ -6157,7 +6157,7 @@ api.update = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [create](http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html) request
|
||||
* Perform a [create](http://www.elastic.co/guide/en/elasticsearch/reference/2.0/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
|
||||
|
||||
@ -16,7 +16,7 @@ var api = module.exports = {};
|
||||
api._namespaces = ['cat', 'cluster', 'indices', 'nodes', 'snapshot'];
|
||||
|
||||
/**
|
||||
* Perform a [bulk](http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-bulk.html) request
|
||||
* Perform a [bulk](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/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
|
||||
@ -132,7 +132,7 @@ api.cat.prototype.aliases = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.allocation](http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-allocation.html) request
|
||||
* Perform a [cat.allocation](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/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
|
||||
@ -189,7 +189,7 @@ api.cat.prototype.allocation = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.count](http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-count.html) request
|
||||
* Perform a [cat.count](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/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)
|
||||
@ -236,7 +236,7 @@ api.cat.prototype.count = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.fielddata](http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-fielddata.html) request
|
||||
* Perform a [cat.fielddata](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/cat-fielddata.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
|
||||
@ -296,7 +296,7 @@ api.cat.prototype.fielddata = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.health](http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-health.html) request
|
||||
* Perform a [cat.health](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/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)
|
||||
@ -337,7 +337,7 @@ api.cat.prototype.health = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.help](http://www.elastic.co/guide/en/elasticsearch/reference/master/cat.html) request
|
||||
* Perform a [cat.help](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/cat.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.help - Return help information
|
||||
@ -355,7 +355,7 @@ api.cat.prototype.help = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.indices](http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-indices.html) request
|
||||
* Perform a [cat.indices](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/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
|
||||
@ -417,7 +417,7 @@ api.cat.prototype.indices = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.master](http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-master.html) request
|
||||
* Perform a [cat.master](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/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)
|
||||
@ -453,7 +453,7 @@ api.cat.prototype.master = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.nodeattrs](http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodeattrs.html) request
|
||||
* Perform a [cat.nodeattrs](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/cat-nodeattrs.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)
|
||||
@ -489,7 +489,7 @@ api.cat.prototype.nodeattrs = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.nodes](http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodes.html) request
|
||||
* Perform a [cat.nodes](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/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)
|
||||
@ -525,7 +525,7 @@ api.cat.prototype.nodes = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.pendingTasks](http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-pending-tasks.html) request
|
||||
* Perform a [cat.pendingTasks](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/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)
|
||||
@ -561,7 +561,7 @@ api.cat.prototype.pendingTasks = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.plugins](http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-plugins.html) request
|
||||
* Perform a [cat.plugins](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/cat-plugins.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)
|
||||
@ -597,7 +597,7 @@ api.cat.prototype.plugins = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.recovery](http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-recovery.html) request
|
||||
* Perform a [cat.recovery](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/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
|
||||
@ -650,7 +650,7 @@ api.cat.prototype.recovery = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.segments](http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-segments.html) request
|
||||
* Perform a [cat.segments](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/cat-segments.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String, String[], Boolean} params.h - Comma-separated list of column names to display
|
||||
@ -688,7 +688,7 @@ api.cat.prototype.segments = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.shards](http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-shards.html) request
|
||||
* Perform a [cat.shards](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/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)
|
||||
@ -735,7 +735,7 @@ api.cat.prototype.shards = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cat.threadPool](http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-thread-pool.html) request
|
||||
* Perform a [cat.threadPool](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/cat-thread-pool.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false)
|
||||
@ -777,7 +777,7 @@ api.cat.prototype.threadPool = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [clearScroll](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-request-scroll.html) request
|
||||
* Perform a [clearScroll](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/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
|
||||
@ -802,7 +802,7 @@ api.clearScroll = ca({
|
||||
api.cluster = namespace();
|
||||
|
||||
/**
|
||||
* Perform a [cluster.getSettings](http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-update-settings.html) request
|
||||
* Perform a [cluster.getSettings](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/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)
|
||||
@ -829,7 +829,7 @@ api.cluster.prototype.getSettings = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cluster.health](http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-health.html) request
|
||||
* Perform a [cluster.health](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/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
|
||||
@ -902,7 +902,7 @@ api.cluster.prototype.health = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cluster.pendingTasks](http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-pending.html) request
|
||||
* Perform a [cluster.pendingTasks](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/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)
|
||||
@ -924,7 +924,7 @@ api.cluster.prototype.pendingTasks = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cluster.putSettings](http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-update-settings.html) request
|
||||
* Perform a [cluster.putSettings](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/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)
|
||||
@ -952,7 +952,7 @@ api.cluster.prototype.putSettings = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cluster.reroute](http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-reroute.html) request
|
||||
* Perform a [cluster.reroute](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/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
|
||||
@ -997,7 +997,7 @@ api.cluster.prototype.reroute = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cluster.state](http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-state.html) request
|
||||
* Perform a [cluster.state](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/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)
|
||||
@ -1089,7 +1089,7 @@ api.cluster.prototype.state = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [cluster.stats](http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-stats.html) request
|
||||
* Perform a [cluster.stats](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/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)
|
||||
@ -1127,7 +1127,7 @@ api.cluster.prototype.stats = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [count](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-count.html) request
|
||||
* Perform a [count](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/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)
|
||||
@ -1235,7 +1235,7 @@ api.count = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [countPercolate](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-percolate.html) request
|
||||
* Perform a [countPercolate](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/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
|
||||
@ -1331,7 +1331,7 @@ api.countPercolate = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [delete](http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete.html) request
|
||||
* Perform a [delete](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/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
|
||||
@ -1399,7 +1399,7 @@ api['delete'] = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [deleteScript](http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html) request
|
||||
* Perform a [deleteScript](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/modules-scripting.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
|
||||
@ -1438,7 +1438,7 @@ api.deleteScript = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [deleteTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-template.html) request
|
||||
* Perform a [deleteTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/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
|
||||
@ -1473,7 +1473,7 @@ api.deleteTemplate = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [exists](http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html) request
|
||||
* Perform a [exists](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/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
|
||||
@ -1521,7 +1521,7 @@ api.exists = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [explain](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-explain.html) request
|
||||
* Perform a [explain](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/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)
|
||||
@ -1615,7 +1615,7 @@ api.explain = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [fieldStats](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-field-stats.html) request
|
||||
* Perform a [fieldStats](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/search-field-stats.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 for to get field statistics for (min value, max value, and more)
|
||||
@ -1675,7 +1675,7 @@ api.fieldStats = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [get](http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html) request
|
||||
* Perform a [get](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/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
|
||||
@ -1755,7 +1755,7 @@ api.get = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [getScript](http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html) request
|
||||
* Perform a [getScript](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/modules-scripting.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
|
||||
@ -1793,7 +1793,7 @@ api.getScript = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [getSource](http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html) request
|
||||
* Perform a [getSource](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/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
|
||||
@ -1869,7 +1869,7 @@ api.getSource = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [getTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-template.html) request
|
||||
* Perform a [getTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/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
|
||||
@ -1903,7 +1903,7 @@ api.getTemplate = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [index](http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html) request
|
||||
* Perform a [index](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/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
|
||||
@ -2004,7 +2004,7 @@ api.index = ca({
|
||||
api.indices = namespace();
|
||||
|
||||
/**
|
||||
* Perform a [indices.analyze](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-analyze.html) request
|
||||
* Perform a [indices.analyze](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/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
|
||||
@ -2071,7 +2071,7 @@ api.indices.prototype.analyze = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.clearCache](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-clearcache.html) request
|
||||
* Perform a [indices.clearCache](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-clearcache.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.fieldData - Clear field data
|
||||
@ -2146,7 +2146,7 @@ api.indices.prototype.clearCache = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.close](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-open-close.html) request
|
||||
* Perform a [indices.close](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-open-close.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.timeout - Explicit operation timeout
|
||||
@ -2197,7 +2197,7 @@ api.indices.prototype.close = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.create](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-create-index.html) request
|
||||
* Perform a [indices.create](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-create-index.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.timeout - Explicit operation timeout
|
||||
@ -2231,7 +2231,7 @@ api.indices.prototype.create = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.delete](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-delete-index.html) request
|
||||
* Perform a [indices.delete](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-delete-index.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.timeout - Explicit operation timeout
|
||||
@ -2260,7 +2260,7 @@ api.indices.prototype['delete'] = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.deleteAlias](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html) request
|
||||
* Perform a [indices.deleteAlias](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-aliases.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.timeout - Explicit timestamp for the document
|
||||
@ -2293,7 +2293,7 @@ api.indices.prototype.deleteAlias = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.deleteTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html) request
|
||||
* Perform a [indices.deleteTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-templates.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.timeout - Explicit operation timeout
|
||||
@ -2322,7 +2322,7 @@ api.indices.prototype.deleteTemplate = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.deleteWarmer](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-warmers.html) request
|
||||
* Perform a [indices.deleteWarmer](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-warmers.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Specify timeout for connection to master
|
||||
@ -2354,7 +2354,7 @@ api.indices.prototype.deleteWarmer = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.exists](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-exists.html) request
|
||||
* Perform a [indices.exists](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/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)
|
||||
@ -2400,7 +2400,7 @@ api.indices.prototype.exists = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.existsAlias](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html) request
|
||||
* Perform a [indices.existsAlias](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-aliases.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
|
||||
@ -2471,7 +2471,7 @@ api.indices.prototype.existsAlias = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.existsTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html) request
|
||||
* Perform a [indices.existsTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-templates.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node
|
||||
@ -2500,7 +2500,7 @@ api.indices.prototype.existsTemplate = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.existsType](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-types-exists.html) request
|
||||
* Perform a [indices.existsType](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/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)
|
||||
@ -2550,7 +2550,7 @@ api.indices.prototype.existsType = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.flush](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-flush.html) request
|
||||
* Perform a [indices.flush](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/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)
|
||||
@ -2606,7 +2606,7 @@ api.indices.prototype.flush = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.flushSynced](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-synced-flush.html) request
|
||||
* Perform a [indices.flushSynced](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-synced-flush.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)
|
||||
@ -2653,7 +2653,7 @@ api.indices.prototype.flushSynced = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.forcemerge](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-forcemerge.html) request
|
||||
* Perform a [indices.forcemerge](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-forcemerge.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)
|
||||
@ -2723,7 +2723,7 @@ api.indices.prototype.forcemerge = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.get](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-index.html) request
|
||||
* Perform a [indices.get](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/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)
|
||||
@ -2798,7 +2798,7 @@ api.indices.prototype.get = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.getAlias](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html) request
|
||||
* Perform a [indices.getAlias](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-aliases.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
|
||||
@ -2868,7 +2868,7 @@ api.indices.prototype.getAlias = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.getAliases](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html) request
|
||||
* Perform a [indices.getAliases](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-aliases.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.timeout - Explicit operation timeout
|
||||
@ -2920,7 +2920,7 @@ api.indices.prototype.getAliases = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.getFieldMapping](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-field-mapping.html) request
|
||||
* Perform a [indices.getFieldMapping](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/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
|
||||
@ -3010,7 +3010,7 @@ api.indices.prototype.getFieldMapping = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.getMapping](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-mapping.html) request
|
||||
* Perform a [indices.getMapping](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/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)
|
||||
@ -3080,7 +3080,7 @@ api.indices.prototype.getMapping = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.getSettings](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-settings.html) request
|
||||
* Perform a [indices.getSettings](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/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)
|
||||
@ -3163,7 +3163,7 @@ api.indices.prototype.getSettings = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.getTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html) request
|
||||
* Perform a [indices.getTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-templates.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.flatSettings - Return settings in flat format (default: false)
|
||||
@ -3201,7 +3201,7 @@ api.indices.prototype.getTemplate = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.getUpgrade](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-upgrade.html) request
|
||||
* Perform a [indices.getUpgrade](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-upgrade.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)
|
||||
@ -3252,7 +3252,7 @@ api.indices.prototype.getUpgrade = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.getWarmer](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-warmers.html) request
|
||||
* Perform a [indices.getWarmer](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-warmers.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
|
||||
@ -3337,7 +3337,7 @@ api.indices.prototype.getWarmer = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.open](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-open-close.html) request
|
||||
* Perform a [indices.open](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-open-close.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.timeout - Explicit operation timeout
|
||||
@ -3388,7 +3388,7 @@ api.indices.prototype.open = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.optimize](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-optimize.html) request
|
||||
* Perform a [indices.optimize](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/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)
|
||||
@ -3458,7 +3458,7 @@ api.indices.prototype.optimize = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.putAlias](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html) request
|
||||
* Perform a [indices.putAlias](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-aliases.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.timeout - Explicit timestamp for the document
|
||||
@ -3491,7 +3491,7 @@ api.indices.prototype.putAlias = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.putMapping](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-put-mapping.html) request
|
||||
* Perform a [indices.putMapping](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-put-mapping.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.timeout - Explicit operation timeout
|
||||
@ -3562,7 +3562,7 @@ api.indices.prototype.putMapping = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.putSettings](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-update-settings.html) request
|
||||
* Perform a [indices.putSettings](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-update-settings.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Specify timeout for connection to master
|
||||
@ -3620,7 +3620,7 @@ api.indices.prototype.putSettings = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.putTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html) request
|
||||
* Perform a [indices.putTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-templates.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Number} params.order - The order for this template when merging multiple matching ones (higher numbers are merged later, overriding the lower numbers)
|
||||
@ -3664,7 +3664,7 @@ api.indices.prototype.putTemplate = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.putWarmer](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-warmers.html) request
|
||||
* Perform a [indices.putWarmer](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-warmers.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Specify timeout for connection to master
|
||||
@ -3746,7 +3746,7 @@ api.indices.prototype.putWarmer = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.recovery](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-recovery.html) request
|
||||
* Perform a [indices.recovery](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-recovery.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.detailed - Whether to display detailed information about shard recovery
|
||||
@ -3786,7 +3786,7 @@ api.indices.prototype.recovery = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.refresh](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-refresh.html) request
|
||||
* Perform a [indices.refresh](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/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)
|
||||
@ -3842,7 +3842,7 @@ api.indices.prototype.refresh = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.segments](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-segments.html) request
|
||||
* Perform a [indices.segments](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/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)
|
||||
@ -3897,7 +3897,7 @@ api.indices.prototype.segments = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.shardStores](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-shards-stores.html) request
|
||||
* Perform a [indices.shardStores](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-shards-stores.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String, String[], Boolean} params.status - A comma-separated list of statuses used to filter on shards to get store information for
|
||||
@ -3957,7 +3957,7 @@ api.indices.prototype.shardStores = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.stats](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-stats.html) request
|
||||
* Perform a [indices.stats](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/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)
|
||||
@ -4076,7 +4076,7 @@ api.indices.prototype.stats = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.updateAliases](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html) request
|
||||
* Perform a [indices.updateAliases](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-aliases.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.timeout - Request timeout
|
||||
@ -4100,7 +4100,7 @@ api.indices.prototype.updateAliases = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.upgrade](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-upgrade.html) request
|
||||
* Perform a [indices.upgrade](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-upgrade.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
|
||||
@ -4157,7 +4157,7 @@ api.indices.prototype.upgrade = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.validateQuery](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-validate.html) request
|
||||
* Perform a [indices.validateQuery](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/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
|
||||
@ -4275,7 +4275,7 @@ api.info = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [mget](http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-get.html) request
|
||||
* Perform a [mget](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/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
|
||||
@ -4343,7 +4343,7 @@ api.mget = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [mpercolate](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-percolate.html) request
|
||||
* Perform a [mpercolate](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/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)
|
||||
@ -4404,7 +4404,7 @@ api.mpercolate = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [msearch](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-multi-search.html) request
|
||||
* Perform a [msearch](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/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
|
||||
@ -4456,7 +4456,7 @@ api.msearch = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [mtermvectors](http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-termvectors.html) request
|
||||
* Perform a [mtermvectors](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/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
|
||||
@ -4572,7 +4572,7 @@ api.mtermvectors = ca({
|
||||
api.nodes = namespace();
|
||||
|
||||
/**
|
||||
* Perform a [nodes.hotThreads](http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-hot-threads.html) request
|
||||
* Perform a [nodes.hotThreads](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/cluster-nodes-hot-threads.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.interval - The interval for the second sampling of threads
|
||||
@ -4626,7 +4626,7 @@ api.nodes.prototype.hotThreads = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [nodes.info](http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-info.html) request
|
||||
* Perform a [nodes.info](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/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)
|
||||
@ -4704,7 +4704,7 @@ api.nodes.prototype.info = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [nodes.stats](http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-stats.html) request
|
||||
* Perform a [nodes.stats](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/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)
|
||||
@ -4901,7 +4901,7 @@ api.nodes.prototype.stats = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [percolate](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-percolate.html) request
|
||||
* Perform a [percolate](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/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
|
||||
@ -5028,7 +5028,7 @@ api.ping = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [putScript](http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html) request
|
||||
* Perform a [putScript](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/modules-scripting.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} [params.opType=index] - Explicit operation type
|
||||
@ -5078,7 +5078,7 @@ api.putScript = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [putTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-template.html) request
|
||||
* Perform a [putTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/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
|
||||
@ -5124,7 +5124,7 @@ api.putTemplate = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [renderSearchTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-template.html) request
|
||||
* Perform a [renderSearchTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/search-template.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} params.id - The id of the stored search template
|
||||
@ -5147,7 +5147,7 @@ api.renderSearchTemplate = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [scroll](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-request-scroll.html) request
|
||||
* Perform a [scroll](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/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
|
||||
@ -5181,7 +5181,7 @@ api.scroll = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [search](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-search.html) request
|
||||
* Perform a [search](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/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
|
||||
@ -5391,7 +5391,7 @@ api.search = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [searchExists](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-exists.html) request
|
||||
* Perform a [searchExists](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/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)
|
||||
@ -5499,7 +5499,7 @@ api.searchExists = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [searchShards](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-shards.html) request
|
||||
* Perform a [searchShards](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/search-shards.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} params.preference - Specify the node or shard the operation should be performed on (default: random)
|
||||
@ -5656,7 +5656,7 @@ api.searchTemplate = ca({
|
||||
api.snapshot = namespace();
|
||||
|
||||
/**
|
||||
* Perform a [snapshot.create](http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html) request
|
||||
* Perform a [snapshot.create](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/modules-snapshots.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node
|
||||
@ -5691,7 +5691,7 @@ api.snapshot.prototype.create = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [snapshot.createRepository](http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html) request
|
||||
* Perform a [snapshot.createRepository](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/modules-snapshots.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node
|
||||
@ -5725,7 +5725,7 @@ api.snapshot.prototype.createRepository = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [snapshot.delete](http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html) request
|
||||
* Perform a [snapshot.delete](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/modules-snapshots.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node
|
||||
@ -5754,7 +5754,7 @@ api.snapshot.prototype['delete'] = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [snapshot.deleteRepository](http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html) request
|
||||
* Perform a [snapshot.deleteRepository](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/modules-snapshots.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node
|
||||
@ -5783,7 +5783,7 @@ api.snapshot.prototype.deleteRepository = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [snapshot.get](http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html) request
|
||||
* Perform a [snapshot.get](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/modules-snapshots.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node
|
||||
@ -5811,7 +5811,7 @@ api.snapshot.prototype.get = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [snapshot.getRepository](http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html) request
|
||||
* Perform a [snapshot.getRepository](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/modules-snapshots.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node
|
||||
@ -5844,7 +5844,7 @@ api.snapshot.prototype.getRepository = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [snapshot.restore](http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html) request
|
||||
* Perform a [snapshot.restore](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/modules-snapshots.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node
|
||||
@ -5879,7 +5879,7 @@ api.snapshot.prototype.restore = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [snapshot.status](http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html) request
|
||||
* Perform a [snapshot.status](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/modules-snapshots.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node
|
||||
@ -5920,7 +5920,7 @@ api.snapshot.prototype.status = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [snapshot.verifyRepository](http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html) request
|
||||
* Perform a [snapshot.verifyRepository](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/modules-snapshots.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node
|
||||
@ -5949,7 +5949,7 @@ api.snapshot.prototype.verifyRepository = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [suggest](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-suggesters.html) request
|
||||
* Perform a [suggest](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/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)
|
||||
@ -6005,7 +6005,7 @@ api.suggest = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [termvectors](http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-termvectors.html) request
|
||||
* Perform a [termvectors](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/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.
|
||||
@ -6124,7 +6124,7 @@ api.termvectors = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [update](http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update.html) request
|
||||
* Perform a [update](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/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
|
||||
@ -6227,7 +6227,7 @@ api.update = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [create](http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html) request
|
||||
* Perform a [create](http://www.elastic.co/guide/en/elasticsearch/reference/2.1/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
|
||||
|
||||
@ -5386,114 +5386,6 @@ api.search = ca({
|
||||
method: 'POST'
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [searchExists](http://www.elastic.co/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)
|
||||
* @param {Boolean} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
|
||||
* @param {String} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both.
|
||||
* @param {Number} params.minScore - Include only documents with a specific `_score` value in the result
|
||||
* @param {String} params.preference - Specify the node or shard the operation should be performed on (default: random)
|
||||
* @param {String} params.routing - Specific routing value
|
||||
* @param {String} params.q - Query in the Lucene query string syntax
|
||||
* @param {String} params.analyzer - The analyzer to use for the query string
|
||||
* @param {Boolean} params.analyzeWildcard - Specify whether wildcard and prefix queries should be analyzed (default: false)
|
||||
* @param {String} [params.defaultOperator=OR] - The default operator for query string query (AND or OR)
|
||||
* @param {String} params.df - The field to use as default where no field prefix is given in the query string
|
||||
* @param {Boolean} params.lenient - Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
|
||||
* @param {Boolean} params.lowercaseExpandedTerms - Specify whether query terms should be lowercased
|
||||
* @param {String, String[], Boolean} params.index - A comma-separated list of indices to restrict the results
|
||||
* @param {String, String[], Boolean} params.type - A comma-separated list of types to restrict the results
|
||||
*/
|
||||
api.searchExists = ca({
|
||||
params: {
|
||||
ignoreUnavailable: {
|
||||
type: 'boolean',
|
||||
name: 'ignore_unavailable'
|
||||
},
|
||||
allowNoIndices: {
|
||||
type: 'boolean',
|
||||
name: 'allow_no_indices'
|
||||
},
|
||||
expandWildcards: {
|
||||
type: 'enum',
|
||||
'default': 'open',
|
||||
options: [
|
||||
'open',
|
||||
'closed',
|
||||
'none',
|
||||
'all'
|
||||
],
|
||||
name: 'expand_wildcards'
|
||||
},
|
||||
minScore: {
|
||||
type: 'number',
|
||||
name: 'min_score'
|
||||
},
|
||||
preference: {
|
||||
type: 'string'
|
||||
},
|
||||
routing: {
|
||||
type: 'string'
|
||||
},
|
||||
q: {
|
||||
type: 'string'
|
||||
},
|
||||
analyzer: {
|
||||
type: 'string'
|
||||
},
|
||||
analyzeWildcard: {
|
||||
type: 'boolean',
|
||||
name: 'analyze_wildcard'
|
||||
},
|
||||
defaultOperator: {
|
||||
type: 'enum',
|
||||
'default': 'OR',
|
||||
options: [
|
||||
'AND',
|
||||
'OR'
|
||||
],
|
||||
name: 'default_operator'
|
||||
},
|
||||
df: {
|
||||
type: 'string'
|
||||
},
|
||||
lenient: {
|
||||
type: 'boolean'
|
||||
},
|
||||
lowercaseExpandedTerms: {
|
||||
type: 'boolean',
|
||||
name: 'lowercase_expanded_terms'
|
||||
}
|
||||
},
|
||||
urls: [
|
||||
{
|
||||
fmt: '/<%=index%>/<%=type%>/_search/exists',
|
||||
req: {
|
||||
index: {
|
||||
type: 'list'
|
||||
},
|
||||
type: {
|
||||
type: 'list'
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
fmt: '/<%=index%>/_search/exists',
|
||||
req: {
|
||||
index: {
|
||||
type: 'list'
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
fmt: '/_search/exists'
|
||||
}
|
||||
],
|
||||
method: 'POST'
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [searchShards](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-shards.html) request
|
||||
*
|
||||
|
||||
Reference in New Issue
Block a user