habsi/elasticsearch-js
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

polished up the build tasks a bit, splitting the default task into three logical groups and properly requireing the tasks that are required by others

Browse Source
This commit is contained in:
Spencer Alger
2013-11-11 17:25:08 -07:00
parent 57bfccca0f
commit 77a73d22c2
7 changed files with 32790 additions and 150 deletions
Download Patch File Download Diff File Expand all files Collapse all files

250
test/browser_integration/yaml_tests.js
View File

@ -27174,7 +27174,7 @@ api.bulk = ca({
* Perform a [clearScroll](http://www.elasticsearch.org/guide/reference/api/search/scroll/) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {String|ArrayOfStrings|Boolean} params.scrollId - A comma-separated list of scroll IDs to clear
* @param {String or String[] or Boolean} params.scrollId - A comma-separated list of scroll IDs to clear
*/
api.clearScroll = ca({
methods: [
@ -27226,8 +27226,8 @@ api.cluster.prototype.getSettings = ca({
* @param {Object} params - An object with parameters used to carry out this action
* @param {String} [params.level=cluster] - Specify the level of detail for returned information
* @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false)
* @param {Date|Number} params.masterTimeout - Explicit operation timeout for connection to master node
* @param {Date|Number} params.timeout - Explicit operation timeout
* @param {Date or Number} params.masterTimeout - Explicit operation timeout for connection to master node
* @param {Date or Number} params.timeout - Explicit operation timeout
* @param {Number} params.waitForActiveShards - Wait until the specified number of shards is active
* @param {String} params.waitForNodes - Wait until the specified number of nodes is available
* @param {Number} params.waitForRelocatingShards - Wait until the specified number of relocating shards is finished
@ -27301,11 +27301,11 @@ api.cluster.prototype.health = ca({
* Perform a [cluster.nodeHotThreads](http://www.elasticsearch.org/guide/reference/api/admin-cluster-nodes-hot-threads/) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {Date|Number} params.interval - The interval for the second sampling of threads
* @param {Date or Number} params.interval - The interval for the second sampling of threads
* @param {Number} params.snapshots - Number of samples of thread stacktrace (default: 10)
* @param {Number} params.threads - Specify the number of threads to provide information for (default: 3)
* @param {String} params.type - The type to sample (default: cpu)
* @param {String|ArrayOfStrings|Boolean} params.nodeId - A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes
* @param {String or String[] or Boolean} params.nodeId - A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes
*/
api.cluster.prototype.nodeHotThreads = ca({
methods: [
@ -27360,9 +27360,9 @@ api.cluster.prototype.nodeHotThreads = ca({
* @param {Boolean} params.process - Return information about the Elasticsearch process
* @param {Boolean} params.settings - Return information about node settings
* @param {Boolean} params.threadPool - Return information about the thread pool
* @param {Date|Number} params.timeout - Explicit operation timeout
* @param {Date or Number} params.timeout - Explicit operation timeout
* @param {Boolean} params.transport - Return information about transport
* @param {String|ArrayOfStrings|Boolean} params.nodeId - A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes
* @param {String or String[] or Boolean} params.nodeId - A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes
*/
api.cluster.prototype.nodeInfo = ca({
methods: [
@ -27427,9 +27427,9 @@ api.cluster.prototype.nodeInfo = ca({
* Perform a [cluster.nodeShutdown](http://elasticsearch.org/guide/reference/api/admin-cluster-nodes-shutdown/) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {Date|Number} params.delay - Set the delay for the operation (default: 1s)
* @param {Date or Number} params.delay - Set the delay for the operation (default: 1s)
* @param {Boolean} params.exit - Exit the JVM as well (default: true)
* @param {String|ArrayOfStrings|Boolean} params.nodeId - A comma-separated list of node IDs or names to perform the operation on; use `_local` to perform the operation on the node you're connected to, leave empty to perform the operation on all nodes
* @param {String or String[] or Boolean} params.nodeId - A comma-separated list of node IDs or names to perform the operation on; use `_local` to perform the operation on the node you're connected to, leave empty to perform the operation on all nodes
*/
api.cluster.prototype.nodeShutdown = ca({
methods: [
@ -27465,7 +27465,7 @@ api.cluster.prototype.nodeShutdown = ca({
* @param {Object} params - An object with parameters used to carry out this action
* @param {Boolean} params.all - Return all available information
* @param {Boolean} params.clear - Reset the default level of detail
* @param {String|ArrayOfStrings|Boolean} params.fields - A comma-separated list of fields to return detailed information for, when returning the `indices` metric family (supports wildcards)
* @param {String or String[] or Boolean} params.fields - A comma-separated list of fields to return detailed information for, when returning the `indices` metric family (supports wildcards)
* @param {Boolean} params.fs - Return information about the filesystem
* @param {Boolean} params.http - Return information about HTTP
* @param {Boolean} params.indices - Return information about indices
@ -27477,7 +27477,7 @@ api.cluster.prototype.nodeShutdown = ca({
* @param {Boolean} params.transport - Return information about transport
* @param {String} params.metricFamily - Limit the information returned to a certain metric family
* @param {String} params.metric - Limit the information returned for `indices` family to a specific metric
* @param {String|ArrayOfStrings|Boolean} params.nodeId - A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes
* @param {String or String[] or Boolean} params.nodeId - A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes
*/
api.cluster.prototype.nodeStats = ca({
methods: [
@ -27591,12 +27591,12 @@ api.cluster.prototype.reroute = ca({
* @param {Object} params - An object with parameters used to carry out this action
* @param {Boolean} params.filterBlocks - Do not return information about blocks
* @param {Boolean} params.filterIndexTemplates - Do not return information about index templates
* @param {String|ArrayOfStrings|Boolean} params.filterIndices - Limit returned metadata information to specific indices
* @param {String or String[] or Boolean} params.filterIndices - Limit returned metadata information to specific indices
* @param {Boolean} params.filterMetadata - Do not return information about indices metadata
* @param {Boolean} params.filterNodes - Do not return information about nodes
* @param {Boolean} params.filterRoutingTable - Do not return information about shard allocation (`routing_table` and `routing_nodes`)
* @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false)
* @param {Date|Number} params.masterTimeout - Specify timeout for connection to master
* @param {Date or Number} params.masterTimeout - Specify timeout for connection to master
*/
api.cluster.prototype.state = ca({
methods: [
@ -27652,8 +27652,8 @@ api.cluster.prototype.state = ca({
* @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.source - The URL-encoded query definition (instead of using the request body)
* @param {String|ArrayOfStrings|Boolean} params.index - A comma-separated list of indices to restrict the results
* @param {String|ArrayOfStrings|Boolean} params.type - A comma-separated list of types to restrict the results
* @param {String or String[] or Boolean} params.index - A comma-separated list of indices to restrict the results
* @param {String or String[] or Boolean} params.type - A comma-separated list of types to restrict the results
*/
api.count = ca({
methods: [
@ -27722,8 +27722,8 @@ api.count = ca({
* @param {Boolean} params.refresh - Refresh the index after performing the operation
* @param {String} [params.replication=sync] - Specific replication type
* @param {String} params.routing - Specific routing value
* @param {Date|Number} params.timeout - Explicit operation timeout
* @param {Date|Number} params.timestamp - Explicit timestamp for the document
* @param {Date or Number} params.timeout - Explicit operation timeout
* @param {Date or Number} params.timestamp - Explicit timestamp for the document
* @param {Duration} params.ttl - Expiration time for the document
* @param {Number} params.version - Explicit version number for concurrency control
* @param {String} params.versionType - Specific version type
@ -27827,7 +27827,7 @@ api.create = ca({
* @param {Boolean} params.refresh - Refresh the index after performing the operation
* @param {String} [params.replication=sync] - Specific replication type
* @param {String} params.routing - Specific routing value
* @param {Date|Number} params.timeout - Explicit operation timeout
* @param {Date or Number} params.timeout - Explicit operation timeout
* @param {Number} params.version - Explicit version number for concurrency control
* @param {String} params.versionType - Specific version type
* @param {String} params.id - The document ID
@ -27911,9 +27911,9 @@ api['delete'] = ca({
* @param {String} params.q - Query in the Lucene query string syntax
* @param {String} params.routing - Specific routing value
* @param {String} params.source - The URL-encoded query definition (instead of using the request body)
* @param {Date|Number} params.timeout - Explicit operation timeout
* @param {String|ArrayOfStrings|Boolean} params.index - A comma-separated list of indices to restrict the operation; use `_all` to perform the operation on all indices
* @param {String|ArrayOfStrings|Boolean} params.type - A comma-separated list of types to restrict the operation
* @param {Date or Number} params.timeout - Explicit operation timeout
* @param {String or String[] or Boolean} params.index - A comma-separated list of indices to restrict the operation; use `_all` to perform the operation on all indices
* @param {String or String[] or Boolean} params.type - A comma-separated list of types to restrict the operation
*/
api.deleteByQuery = ca({
methods: [
@ -28062,16 +28062,16 @@ api.exists = ca({
* @param {String} params.analyzer - The analyzer for the query string query
* @param {String} [params.defaultOperator=OR] - The default operator for query string query (AND or OR)
* @param {String} params.df - The default field for query string query (default: _all)
* @param {String|ArrayOfStrings|Boolean} params.fields - A comma-separated list of fields to return in the response
* @param {String or String[] or Boolean} params.fields - A comma-separated list of fields to return in the response
* @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} params.parent - The ID of the parent document
* @param {String} params.preference - Specify the node or shard the operation should be performed on (default: random)
* @param {String} params.q - Query in the Lucene query string syntax
* @param {String} params.routing - Specific routing value
* @param {String|ArrayOfStrings|Boolean} params.source - True or false to return the _source field or not, or a list of fields to return
* @param {String|ArrayOfStrings|Boolean} params.sourceExclude - A list of fields to exclude from the returned _source field
* @param {String|ArrayOfStrings|Boolean} params.sourceInclude - A list of fields to extract and return from the _source field
* @param {String or String[] or Boolean} params.source - True or false to return the _source field or not, or a list of fields to return
* @param {String or String[] or Boolean} params.sourceExclude - A list of fields to exclude from the returned _source field
* @param {String or String[] or Boolean} params.sourceInclude - A list of fields to extract and return from the _source field
* @param {String} params.id - The document ID
* @param {String} params.index - The name of the index
* @param {String} params.type - The type of the document
@ -28159,15 +28159,15 @@ api.explain = ca({
* Perform a [get](http://elasticsearch.org/guide/reference/api/get/) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {String|ArrayOfStrings|Boolean} params.fields - A comma-separated list of fields to return in the response
* @param {String or String[] or Boolean} params.fields - A comma-separated list of fields to return in the response
* @param {String} params.parent - The ID of the parent document
* @param {String} params.preference - Specify the node or shard the operation should be performed on (default: random)
* @param {Boolean} params.realtime - Specify whether to perform the operation in realtime or search mode
* @param {Boolean} params.refresh - Refresh the shard containing the document before performing the operation
* @param {String} params.routing - Specific routing value
* @param {String|ArrayOfStrings|Boolean} params.source - True or false to return the _source field or not, or a list of fields to return
* @param {String|ArrayOfStrings|Boolean} params.sourceExclude - A list of fields to exclude from the returned _source field
* @param {String|ArrayOfStrings|Boolean} params.sourceInclude - A list of fields to extract and return from the _source field
* @param {String or String[] or Boolean} params.source - True or false to return the _source field or not, or a list of fields to return
* @param {String or String[] or Boolean} params.sourceExclude - A list of fields to exclude from the returned _source field
* @param {String or String[] or Boolean} params.sourceInclude - A list of fields to extract and return from the _source field
* @param {String} params.id - The document ID
* @param {String} params.index - The name of the index
* @param {String} [params.type=_all] - The type of the document (use `_all` to fetch the first document matching the ID across all types)
@ -28234,8 +28234,8 @@ api.get = ca({
* Perform a [getSource](http://elasticsearch.org/guide/reference/api/get/) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {String|ArrayOfStrings|Boolean} params.exclude - A list of fields to exclude from the returned _source field
* @param {String|ArrayOfStrings|Boolean} params.include - A list of fields to extract and return from the _source field
* @param {String or String[] or Boolean} params.exclude - A list of fields to exclude from the returned _source field
* @param {String or String[] or Boolean} params.include - A list of fields to extract and return from the _source field
* @param {String} params.parent - The ID of the parent document
* @param {String} params.preference - Specify the node or shard the operation should be performed on (default: random)
* @param {Boolean} params.realtime - Specify whether to perform the operation in realtime or search mode
@ -28305,8 +28305,8 @@ api.getSource = ca({
* @param {Boolean} params.refresh - Refresh the index after performing the operation
* @param {String} [params.replication=sync] - Specific replication type
* @param {String} params.routing - Specific routing value
* @param {Date|Number} params.timeout - Explicit operation timeout
* @param {Date|Number} params.timestamp - Explicit timestamp for the document
* @param {Date or Number} params.timeout - Explicit operation timeout
* @param {Date or Number} params.timestamp - Explicit timestamp for the document
* @param {Duration} params.ttl - Expiration time for the document
* @param {Number} params.version - Explicit version number for concurrency control
* @param {String} params.versionType - Specific version type
@ -28422,7 +28422,7 @@ api.indices = function IndicesNS(client) {
* @param {Object} params - An object with parameters used to carry out this action
* @param {String} params.analyzer - The name of the analyzer to use
* @param {String} params.field - Use the analyzer configured for this field (instead of passing the analyzer name)
* @param {String|ArrayOfStrings|Boolean} params.filters - A comma-separated list of filters to use for the analysis
* @param {String or String[] or Boolean} params.filters - A comma-separated list of filters to use for the analysis
* @param {String} params.index - The name of the index to scope the operation
* @param {Boolean} params.preferLocal - With `true`, specify that a local shard should be used if available, with `false`, use a random shard (default: true)
* @param {String} params.text - The text on which the analysis should be performed (when request body is not used)
@ -28488,14 +28488,14 @@ api.indices.prototype.analyze = ca({
* @param {Object} params - An object with parameters used to carry out this action
* @param {Boolean} params.fieldData - Clear field data
* @param {Boolean} params.fielddata - Clear field data
* @param {String|ArrayOfStrings|Boolean} params.fields - A comma-separated list of fields to clear when using the `field_data` parameter (default: all)
* @param {String or String[] or Boolean} params.fields - A comma-separated list of fields to clear when using the `field_data` parameter (default: all)
* @param {Boolean} params.filter - Clear filter caches
* @param {Boolean} params.filterCache - Clear filter caches
* @param {Boolean} params.filterKeys - A comma-separated list of keys to clear when using the `filter_cache` parameter (default: all)
* @param {Boolean} params.id - Clear ID caches for parent/child
* @param {Boolean} params.idCache - Clear ID caches for parent/child
* @param {String} [params.ignoreIndices=none] - When performed on multiple indices, allows to ignore `missing` ones
* @param {String|ArrayOfStrings|Boolean} params.index - A comma-separated list of index name to limit the operation
* @param {String or String[] or Boolean} params.index - A comma-separated list of index name to limit the operation
* @param {Boolean} params.recycler - Clear the recycler cache
*/
api.indices.prototype.clearCache = ca({
@ -28568,8 +28568,8 @@ api.indices.prototype.clearCache = ca({
* Perform a [indices.close](http://www.elasticsearch.org/guide/reference/api/admin-indices-open-close/) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {Date|Number} params.timeout - Explicit operation timeout
* @param {Date|Number} params.masterTimeout - Specify timeout for connection to master
* @param {Date or Number} params.timeout - Explicit operation timeout
* @param {Date or Number} params.masterTimeout - Specify timeout for connection to master
* @param {String} params.index - The name of the index
*/
api.indices.prototype.close = ca({
@ -28602,8 +28602,8 @@ api.indices.prototype.close = ca({
* Perform a [indices.create](http://www.elasticsearch.org/guide/reference/api/admin-indices-create-index/) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {Date|Number} params.timeout - Explicit operation timeout
* @param {Date|Number} params.masterTimeout - Specify timeout for connection to master
* @param {Date or Number} params.timeout - Explicit operation timeout
* @param {Date or Number} params.masterTimeout - Specify timeout for connection to master
* @param {String} params.index - The name of the index
*/
api.indices.prototype.create = ca({
@ -28637,9 +28637,9 @@ api.indices.prototype.create = ca({
* Perform a [indices.delete](http://www.elasticsearch.org/guide/reference/api/admin-indices-delete-index/) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {Date|Number} params.timeout - Explicit operation timeout
* @param {Date|Number} params.masterTimeout - Specify timeout for connection to master
* @param {String|ArrayOfStrings|Boolean} params.index - A comma-separated list of indices to delete; use `_all` or empty string to delete all indices
* @param {Date or Number} params.timeout - Explicit operation timeout
* @param {Date or Number} params.masterTimeout - Specify timeout for connection to master
* @param {String or String[] or Boolean} params.index - A comma-separated list of indices to delete; use `_all` or empty string to delete all indices
*/
api.indices.prototype['delete'] = ca({
methods: [
@ -28674,8 +28674,8 @@ api.indices.prototype['delete'] = ca({
* Perform a [indices.deleteAlias](http://www.elasticsearch.org/guide/reference/api/admin-indices-aliases/) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {Date|Number} params.timeout - Explicit timestamp for the document
* @param {Date|Number} params.masterTimeout - Specify timeout for connection to master
* @param {Date or Number} params.timeout - Explicit timestamp for the document
* @param {Date or Number} params.masterTimeout - Specify timeout for connection to master
* @param {String} params.index - The name of the index with an alias
* @param {String} params.name - The name of the alias to be deleted
*/
@ -28712,8 +28712,8 @@ api.indices.prototype.deleteAlias = ca({
* Perform a [indices.deleteMapping](http://www.elasticsearch.org/guide/reference/api/admin-indices-delete-mapping/) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {Date|Number} params.masterTimeout - Specify timeout for connection to master
* @param {String|ArrayOfStrings|Boolean} params.index - A comma-separated list of index names; use `_all` for all indices
* @param {Date or Number} params.masterTimeout - Specify timeout for connection to master
* @param {String or String[] or Boolean} params.index - A comma-separated list of index names; use `_all` for all indices
* @param {String} params.type - The name of the document type to delete
*/
api.indices.prototype.deleteMapping = ca({
@ -28746,8 +28746,8 @@ api.indices.prototype.deleteMapping = ca({
* Perform a [indices.deleteTemplate](http://www.elasticsearch.org/guide/reference/api/admin-indices-templates/) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {Date|Number} params.timeout - Explicit operation timeout
* @param {Date|Number} params.masterTimeout - Specify timeout for connection to master
* @param {Date or Number} params.timeout - Explicit operation timeout
* @param {Date or Number} params.masterTimeout - Specify timeout for connection to master
* @param {String} params.name - The name of the template
*/
api.indices.prototype.deleteTemplate = ca({
@ -28780,10 +28780,10 @@ api.indices.prototype.deleteTemplate = ca({
* Perform a [indices.deleteWarmer](http://www.elasticsearch.org/guide/reference/api/admin-indices-warmers/) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {Date|Number} params.masterTimeout - Specify timeout for connection to master
* @param {String|ArrayOfStrings|Boolean} params.index - A comma-separated list of index names to register warmer for; use `_all` or empty string to perform the operation on all indices
* @param {Date or Number} params.masterTimeout - Specify timeout for connection to master
* @param {String or String[] or Boolean} params.index - A comma-separated list of index names to register warmer for; use `_all` or empty string to perform the operation on all indices
* @param {String} params.name - The name of the warmer (supports wildcards); leave empty to delete all warmers
* @param {String|ArrayOfStrings|Boolean} params.type - A comma-separated list of document types to register warmer for; use `_all` or empty string to perform the operation on all types
* @param {String or String[] or Boolean} params.type - A comma-separated list of document types to register warmer for; use `_all` or empty string to perform the operation on all types
*/
api.indices.prototype.deleteWarmer = ca({
methods: [
@ -28837,7 +28837,7 @@ api.indices.prototype.deleteWarmer = ca({
* Perform a [indices.exists](http://www.elasticsearch.org/guide/reference/api/admin-indices-indices-exists/) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {String|ArrayOfStrings|Boolean} params.index - A comma-separated list of indices to check
* @param {String or String[] or Boolean} params.index - A comma-separated list of indices to check
*/
api.indices.prototype.exists = ca({
methods: [
@ -28863,8 +28863,8 @@ api.indices.prototype.exists = ca({
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {String} [params.ignoreIndices=none] - When performed on multiple indices, allows to ignore `missing` ones
* @param {String|ArrayOfStrings|Boolean} params.index - A comma-separated list of index names to filter aliases
* @param {String|ArrayOfStrings|Boolean} params.name - A comma-separated list of alias names to return
* @param {String or String[] or Boolean} params.index - A comma-separated list of index names to filter aliases
* @param {String or String[] or Boolean} params.name - A comma-separated list of alias names to return
*/
api.indices.prototype.existsAlias = ca({
methods: [
@ -28911,8 +28911,8 @@ api.indices.prototype.existsAlias = ca({
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {String} [params.ignoreIndices=none] - When performed on multiple indices, allows to ignore `missing` ones
* @param {String|ArrayOfStrings|Boolean} params.index - A comma-separated list of index names; use `_all` to check the types across all indices
* @param {String|ArrayOfStrings|Boolean} params.type - A comma-separated list of document types to check
* @param {String or String[] or Boolean} params.index - A comma-separated list of index names; use `_all` to check the types across all indices
* @param {String or String[] or Boolean} params.type - A comma-separated list of document types to check
*/
api.indices.prototype.existsType = ca({
methods: [
@ -28954,7 +28954,7 @@ api.indices.prototype.existsType = ca({
* @param {Boolean} params.full - TODO: ?
* @param {String} [params.ignoreIndices=none] - When performed on multiple indices, allows to ignore `missing` ones
* @param {Boolean} params.refresh - Refresh the index after performing the operation
* @param {String|ArrayOfStrings|Boolean} params.index - A comma-separated list of index names; use `_all` or empty string for all indices
* @param {String or String[] or Boolean} params.index - A comma-separated list of index names; use `_all` or empty string for all indices
*/
api.indices.prototype.flush = ca({
methods: [
@ -29002,8 +29002,8 @@ api.indices.prototype.flush = ca({
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {String} [params.ignoreIndices=none] - When performed on multiple indices, allows to ignore `missing` ones
* @param {String|ArrayOfStrings|Boolean} params.index - A comma-separated list of index names to filter aliases
* @param {String|ArrayOfStrings|Boolean} params.name - A comma-separated list of alias names to return
* @param {String or String[] or Boolean} params.index - A comma-separated list of index names to filter aliases
* @param {String or String[] or Boolean} params.name - A comma-separated list of alias names to return
*/
api.indices.prototype.getAlias = ca({
methods: [
@ -29048,8 +29048,8 @@ api.indices.prototype.getAlias = ca({
* Perform a [indices.getAliases](http://www.elasticsearch.org/guide/reference/api/admin-indices-aliases/) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {Date|Number} params.timeout - Explicit operation timeout
* @param {String|ArrayOfStrings|Boolean} params.index - A comma-separated list of index names to filter aliases
* @param {Date or Number} params.timeout - Explicit operation timeout
* @param {String or String[] or Boolean} params.index - A comma-separated list of index names to filter aliases
*/
api.indices.prototype.getAliases = ca({
methods: [
@ -29081,9 +29081,9 @@ api.indices.prototype.getAliases = ca({
*
* @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
* @param {String|ArrayOfStrings|Boolean} params.index - A comma-separated list of index names
* @param {String|ArrayOfStrings|Boolean} params.type - A comma-separated list of document types
* @param {String|ArrayOfStrings|Boolean} params.field - A comma-separated list of fields
* @param {String or String[] or Boolean} params.index - A comma-separated list of index names
* @param {String or String[] or Boolean} params.type - A comma-separated list of document types
* @param {String or String[] or Boolean} params.field - A comma-separated list of fields
*/
api.indices.prototype.getFieldMapping = ca({
methods: [
@ -29137,8 +29137,8 @@ api.indices.prototype.getFieldMapping = ca({
* Perform a [indices.getMapping](http://www.elasticsearch.org/guide/reference/api/admin-indices-get-mapping/) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {String|ArrayOfStrings|Boolean} params.index - A comma-separated list of index names
* @param {String|ArrayOfStrings|Boolean} params.type - A comma-separated list of document types
* @param {String or String[] or Boolean} params.index - A comma-separated list of index names
* @param {String or String[] or Boolean} params.type - A comma-separated list of document types
*/
api.indices.prototype.getMapping = ca({
methods: [
@ -29176,7 +29176,7 @@ api.indices.prototype.getMapping = ca({
* Perform a [indices.getSettings](http://www.elasticsearch.org/guide/reference/api/admin-indices-get-settings/) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {String|ArrayOfStrings|Boolean} params.index - A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
* @param {String or String[] or Boolean} params.index - A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
*/
api.indices.prototype.getSettings = ca({
methods: [
@ -29230,9 +29230,9 @@ api.indices.prototype.getTemplate = ca({
* Perform a [indices.getWarmer](http://www.elasticsearch.org/guide/reference/api/admin-indices-warmers/) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {String|ArrayOfStrings|Boolean} params.index - A comma-separated list of index names to restrict the operation; use `_all` to perform the operation on all indices
* @param {String or String[] or Boolean} params.index - A comma-separated list of index names to restrict the operation; use `_all` to perform the operation on all indices
* @param {String} params.name - The name of the warmer (supports wildcards); leave empty to get all warmers
* @param {String|ArrayOfStrings|Boolean} params.type - A comma-separated list of document types to restrict the operation; leave empty to perform the operation on all types
* @param {String or String[] or Boolean} params.type - A comma-separated list of document types to restrict the operation; leave empty to perform the operation on all types
*/
api.indices.prototype.getWarmer = ca({
methods: [
@ -29281,8 +29281,8 @@ api.indices.prototype.getWarmer = ca({
* Perform a [indices.open](http://www.elasticsearch.org/guide/reference/api/admin-indices-open-close/) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {Date|Number} params.timeout - Explicit operation timeout
* @param {Date|Number} params.masterTimeout - Specify timeout for connection to master
* @param {Date or Number} params.timeout - Explicit operation timeout
* @param {Date or Number} params.masterTimeout - Specify timeout for connection to master
* @param {String} params.index - The name of the index
*/
api.indices.prototype.open = ca({
@ -29322,7 +29322,7 @@ api.indices.prototype.open = ca({
* @param {*} params.operationThreading - TODO: ?
* @param {Boolean} params.refresh - Specify whether the index should be refreshed after performing the operation (default: true)
* @param {Boolean} params.waitForMerge - Specify whether the request should block until the merge process is finished (default: true)
* @param {String|ArrayOfStrings|Boolean} params.index - A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
* @param {String or String[] or Boolean} params.index - A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
*/
api.indices.prototype.optimize = ca({
methods: [
@ -29381,8 +29381,8 @@ api.indices.prototype.optimize = ca({
* Perform a [indices.putAlias](http://www.elasticsearch.org/guide/reference/api/admin-indices-aliases/) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {Date|Number} params.timeout - Explicit timestamp for the document
* @param {Date|Number} params.masterTimeout - Specify timeout for connection to master
* @param {Date or Number} params.timeout - Explicit timestamp for the document
* @param {Date or Number} params.masterTimeout - Specify timeout for connection to master
* @param {String} params.index - The name of the index with an alias
* @param {String} params.name - The name of the alias to be created or updated
*/
@ -29439,9 +29439,9 @@ api.indices.prototype.putAlias = ca({
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {Boolean} params.ignoreConflicts - Specify whether to ignore conflicts while updating the mapping (default: false)
* @param {Date|Number} params.timeout - Explicit operation timeout
* @param {Date|Number} params.masterTimeout - Specify timeout for connection to master
* @param {String|ArrayOfStrings|Boolean} params.index - A comma-separated list of index names; use `_all` to perform the operation on all indices
* @param {Date or Number} params.timeout - Explicit operation timeout
* @param {Date or Number} params.masterTimeout - Specify timeout for connection to master
* @param {String or String[] or Boolean} params.index - A comma-separated list of index names; use `_all` to perform the operation on all indices
* @param {String} params.type - The name of the document type
*/
api.indices.prototype.putMapping = ca({
@ -29482,8 +29482,8 @@ api.indices.prototype.putMapping = ca({
* Perform a [indices.putSettings](http://www.elasticsearch.org/guide/reference/api/admin-indices-update-settings/) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {Date|Number} params.masterTimeout - Specify timeout for connection to master
* @param {String|ArrayOfStrings|Boolean} params.index - A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
* @param {Date or Number} params.masterTimeout - Specify timeout for connection to master
* @param {String or String[] or Boolean} params.index - A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
*/
api.indices.prototype.putSettings = ca({
methods: [
@ -29516,8 +29516,8 @@ api.indices.prototype.putSettings = ca({
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {Number} params.order - The order for this template when merging multiple matching ones (higher numbers are merged later, overriding the lower numbers)
* @param {Date|Number} params.timeout - Explicit operation timeout
* @param {Date|Number} params.masterTimeout - Specify timeout for connection to master
* @param {Date or Number} params.timeout - Explicit operation timeout
* @param {Date or Number} params.masterTimeout - Specify timeout for connection to master
* @param {String} params.name - The name of the template
*/
api.indices.prototype.putTemplate = ca({
@ -29554,10 +29554,10 @@ api.indices.prototype.putTemplate = ca({
* Perform a [indices.putWarmer](http://www.elasticsearch.org/guide/reference/api/admin-indices-warmers/) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {Date|Number} params.masterTimeout - Specify timeout for connection to master
* @param {String|ArrayOfStrings|Boolean} params.index - A comma-separated list of index names to register the warmer for; use `_all` or empty string to perform the operation on all indices
* @param {Date or Number} params.masterTimeout - Specify timeout for connection to master
* @param {String or String[] or Boolean} params.index - A comma-separated list of index names to register the warmer for; use `_all` or empty string to perform the operation on all indices
* @param {String} params.name - The name of the warmer
* @param {String|ArrayOfStrings|Boolean} params.type - A comma-separated list of document types to register the warmer for; leave empty to perform the operation on all types
* @param {String or String[] or Boolean} params.type - A comma-separated list of document types to register the warmer for; leave empty to perform the operation on all types
*/
api.indices.prototype.putWarmer = ca({
methods: [
@ -29605,7 +29605,7 @@ api.indices.prototype.putWarmer = ca({
* @param {Object} params - An object with parameters used to carry out this action
* @param {String} [params.ignoreIndices=none] - When performed on multiple indices, allows to ignore `missing` ones
* @param {*} params.operationThreading - TODO: ?
* @param {String|ArrayOfStrings|Boolean} params.index - A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
* @param {String or String[] or Boolean} params.index - A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
*/
api.indices.prototype.refresh = ca({
methods: [
@ -29648,7 +29648,7 @@ api.indices.prototype.refresh = ca({
* @param {Object} params - An object with parameters used to carry out this action
* @param {String} [params.ignoreIndices=none] - When performed on multiple indices, allows to ignore `missing` ones
* @param {*} params.operationThreading - TODO: ?
* @param {String|ArrayOfStrings|Boolean} params.index - A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
* @param {String or String[] or Boolean} params.index - A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
*/
api.indices.prototype.segments = ca({
methods: [
@ -29689,7 +29689,7 @@ api.indices.prototype.segments = ca({
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {String} [params.ignoreIndices=none] - When performed on multiple indices, allows to ignore `missing` ones
* @param {String|ArrayOfStrings|Boolean} params.index - A comma-separated list of index names; use `_all` or empty string for all indices
* @param {String or String[] or Boolean} params.index - A comma-separated list of index names; use `_all` or empty string for all indices
*/
api.indices.prototype.snapshotIndex = ca({
methods: [
@ -29729,11 +29729,11 @@ api.indices.prototype.snapshotIndex = ca({
* @param {Boolean} params.all - Return all available information
* @param {Boolean} params.clear - Reset the default level of detail
* @param {Boolean} params.completion - Return information about completion suggester stats
* @param {String|ArrayOfStrings|Boolean} params.completionFields - A comma-separated list of fields for `completion` metric (supports wildcards)
* @param {String or String[] or Boolean} params.completionFields - A comma-separated list of fields for `completion` metric (supports wildcards)
* @param {Boolean} params.docs - Return information about indexed and deleted documents
* @param {Boolean} params.fielddata - Return information about field data
* @param {String|ArrayOfStrings|Boolean} params.fielddataFields - A comma-separated list of fields for `fielddata` metric (supports wildcards)
* @param {String|ArrayOfStrings|Boolean} params.fields - A comma-separated list of fields to return detailed information for, when returning the `search` statistics
* @param {String or String[] or Boolean} params.fielddataFields - A comma-separated list of fields for `fielddata` metric (supports wildcards)
* @param {String or String[] or Boolean} params.fields - A comma-separated list of fields to return detailed information for, when returning the `search` statistics
* @param {Boolean} params.filterCache - Return information about filter cache
* @param {Boolean} params.flush - Return information about flush operations
* @param {Boolean} params.get - Return information about get operations
@ -29746,10 +29746,10 @@ api.indices.prototype.snapshotIndex = ca({
* @param {Boolean} params.search - Return information about search operations; use the `groups` parameter to include information for specific search groups
* @param {Boolean} params.store - Return information about the size of the index
* @param {Boolean} params.warmer - Return information about warmers
* @param {String|ArrayOfStrings|Boolean} params.index - A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
* @param {String|ArrayOfStrings|Boolean} params.indexingTypes - A comma-separated list of document types to include in the `indexing` statistics
* @param {String or String[] or Boolean} params.index - A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
* @param {String or String[] or Boolean} params.indexingTypes - A comma-separated list of document types to include in the `indexing` statistics
* @param {String} params.metricFamily - Limit the information returned to a specific metric
* @param {String|ArrayOfStrings|Boolean} params.searchGroups - A comma-separated list of search groups to include in the `search` statistics
* @param {String or String[] or Boolean} params.searchGroups - A comma-separated list of search groups to include in the `search` statistics
*/
api.indices.prototype.stats = ca({
methods: [
@ -29851,7 +29851,7 @@ api.indices.prototype.stats = ca({
* @param {*} params.operationThreading - TODO: ?
* @param {Boolean} params.recovery - Return information about shard recovery
* @param {Boolean} params.snapshot - TODO: ?
* @param {String|ArrayOfStrings|Boolean} params.index - A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
* @param {String or String[] or Boolean} params.index - A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
*/
api.indices.prototype.status = ca({
methods: [
@ -29897,9 +29897,9 @@ api.indices.prototype.status = ca({
* Perform a [indices.updateAliases](http://www.elasticsearch.org/guide/reference/api/admin-indices-aliases/) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {Date|Number} params.timeout - Request timeout
* @param {Date|Number} params.masterTimeout - Specify timeout for connection to master
* @param {String|ArrayOfStrings|Boolean} params.index - A comma-separated list of index names to filter aliases
* @param {Date or Number} params.timeout - Request timeout
* @param {Date or Number} params.masterTimeout - Specify timeout for connection to master
* @param {String or String[] or Boolean} params.index - A comma-separated list of index names to filter aliases
*/
api.indices.prototype.updateAliases = ca({
methods: [
@ -29931,8 +29931,8 @@ api.indices.prototype.updateAliases = ca({
* @param {*} params.operationThreading - TODO: ?
* @param {String} params.source - The URL-encoded query definition (instead of using the request body)
* @param {String} params.q - Query in the Lucene query string syntax
* @param {String|ArrayOfStrings|Boolean} params.index - A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices
* @param {String|ArrayOfStrings|Boolean} params.type - A comma-separated list of document types to restrict the operation; leave empty to perform the operation on all types
* @param {String or String[] or Boolean} params.index - A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices
* @param {String or String[] or Boolean} params.type - A comma-separated list of document types to restrict the operation; leave empty to perform the operation on all types
*/
api.indices.prototype.validateQuery = ca({
methods: [
@ -30012,13 +30012,13 @@ api.info = ca({
* Perform a [mget](http://elasticsearch.org/guide/reference/api/multi-get/) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {String|ArrayOfStrings|Boolean} params.fields - A comma-separated list of fields to return in the response
* @param {String or String[] or Boolean} params.fields - A comma-separated list of fields to return in the response
* @param {String} params.preference - Specify the node or shard the operation should be performed on (default: random)
* @param {Boolean} params.realtime - Specify whether to perform the operation in realtime or search mode
* @param {Boolean} params.refresh - Refresh the shard containing the document before performing the operation
* @param {String|ArrayOfStrings|Boolean} params.source - True or false to return the _source field or not, or a list of fields to return
* @param {String|ArrayOfStrings|Boolean} params.sourceExclude - A list of fields to exclude from the returned _source field
* @param {String|ArrayOfStrings|Boolean} params.sourceInclude - A list of fields to extract and return from the _source field
* @param {String or String[] or Boolean} params.source - True or false to return the _source field or not, or a list of fields to return
* @param {String or String[] or Boolean} params.sourceExclude - A list of fields to exclude from the returned _source field
* @param {String or String[] or Boolean} params.sourceInclude - A list of fields to extract and return from the _source field
* @param {String} params.index - The name of the index
* @param {String} params.type - The type of the document
*/
@ -30091,18 +30091,18 @@ api.mget = ca({
* @param {Number} params.minDocFreq - The word occurrence frequency as count: words with lower occurrence in the corpus will be ignored
* @param {Number} params.minTermFreq - The term frequency as percent: terms with lower occurence in the source document will be ignored
* @param {Number} params.minWordLen - The minimum length of the word: shorter words will be ignored
* @param {String|ArrayOfStrings|Boolean} params.mltFields - Specific fields to perform the query against
* @param {String or String[] or Boolean} params.mltFields - Specific fields to perform the query against
* @param {Number} params.percentTermsToMatch - How many terms have to match in order to consider the document a match (default: 0.3)
* @param {String} params.routing - Specific routing value
* @param {Number} params.searchFrom - The offset from which to return results
* @param {String|ArrayOfStrings|Boolean} params.searchIndices - A comma-separated list of indices to perform the query against (default: the index containing the document)
* @param {String or String[] or Boolean} params.searchIndices - A comma-separated list of indices to perform the query against (default: the index containing the document)
* @param {String} params.searchQueryHint - The search query hint
* @param {String} params.searchScroll - A scroll search request definition
* @param {Number} params.searchSize - The number of documents to return (default: 10)
* @param {String} params.searchSource - A specific search request definition (instead of using the request body)
* @param {String} params.searchType - Specific search type (eg. `dfs_then_fetch`, `count`, etc)
* @param {String|ArrayOfStrings|Boolean} params.searchTypes - A comma-separated list of types to perform the query against (default: the same type as the document)
* @param {String|ArrayOfStrings|Boolean} params.stopWords - A list of stop words to be ignored
* @param {String or String[] or Boolean} params.searchTypes - A comma-separated list of types to perform the query against (default: the same type as the document)
* @param {String or String[] or Boolean} params.stopWords - A list of stop words to be ignored
* @param {String} params.id - The document ID
* @param {String} params.index - The name of the index
* @param {String} params.type - The type of the document (use `_all` to fetch the first document matching the ID across all types)
@ -30213,8 +30213,8 @@ api.mlt = ca({
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {String} params.searchType - Search operation type
* @param {String|ArrayOfStrings|Boolean} params.index - A comma-separated list of index names to use as default
* @param {String|ArrayOfStrings|Boolean} params.type - A comma-separated list of document types to use as default
* @param {String or String[] or Boolean} params.index - A comma-separated list of index names to use as default
* @param {String or String[] or Boolean} params.type - A comma-separated list of document types to use as default
*/
api.msearch = ca({
methods: [
@ -30344,31 +30344,31 @@ api.scroll = ca({
* @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.explain - Specify whether to return detailed information about score computation as part of a hit
* @param {String|ArrayOfStrings|Boolean} params.fields - A comma-separated list of fields to return as part of a hit
* @param {String or String[] or Boolean} params.fields - A comma-separated list of fields to return as part of a hit
* @param {Number} params.from - Starting offset (default: 0)
* @param {String} [params.ignoreIndices=none] - When performed on multiple indices, allows to ignore `missing` ones
* @param {String|ArrayOfStrings|Boolean} params.indicesBoost - Comma-separated list of index boosts
* @param {String or String[] or Boolean} params.indicesBoost - Comma-separated list of index boosts
* @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} params.preference - Specify the node or shard the operation should be performed on (default: random)
* @param {String} params.q - Query in the Lucene query string syntax
* @param {String|ArrayOfStrings|Boolean} params.routing - A comma-separated list of specific routing values
* @param {String or String[] or Boolean} params.routing - A comma-separated list of specific routing values
* @param {Duration} params.scroll - Specify how long a consistent view of the index should be maintained for scrolled search
* @param {String} params.searchType - Search operation type
* @param {Number} params.size - Number of hits to return (default: 10)
* @param {String|ArrayOfStrings|Boolean} params.sort - A comma-separated list of <field>:<direction> pairs
* @param {String|ArrayOfStrings|Boolean} params.source - True or false to return the _source field or not, or a list of fields to return
* @param {String|ArrayOfStrings|Boolean} params.sourceExclude - A list of fields to exclude from the returned _source field
* @param {String|ArrayOfStrings|Boolean} params.sourceInclude - A list of fields to extract and return from the _source field
* @param {String|ArrayOfStrings|Boolean} params.stats - Specific 'tag' of the request for logging and statistical purposes
* @param {String or String[] or Boolean} params.sort - A comma-separated list of <field>:<direction> pairs
* @param {String or String[] or Boolean} params.source - True or false to return the _source field or not, or a list of fields to return
* @param {String or String[] or Boolean} params.sourceExclude - A list of fields to exclude from the returned _source field
* @param {String or String[] or Boolean} params.sourceInclude - A list of fields to extract and return from the _source field
* @param {String or String[] or Boolean} params.stats - Specific 'tag' of the request for logging and statistical purposes
* @param {String} params.suggestField - Specify which field to use for suggestions
* @param {String} [params.suggestMode=missing] - Specify suggest mode
* @param {Number} params.suggestSize - How many suggestions to return in response
* @param {Text} params.suggestText - The source text for which the suggestions should be returned
* @param {Date|Number} params.timeout - Explicit operation timeout
* @param {Date or Number} params.timeout - Explicit operation timeout
* @param {Boolean} params.version - Specify whether to return document version as part of a hit
* @param {String|ArrayOfStrings|Boolean} [params.index=_all] - A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
* @param {String|ArrayOfStrings|Boolean} params.type - A comma-separated list of document types to search; leave empty to perform the operation on all types
* @param {String or String[] or Boolean} [params.index=_all] - A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
* @param {String or String[] or Boolean} params.type - A comma-separated list of document types to search; leave empty to perform the operation on all types
*/
api.search = ca({
methods: [
@ -30534,7 +30534,7 @@ api.search = ca({
* @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.source - The URL-encoded request definition (instead of using request body)
* @param {String|ArrayOfStrings|Boolean} params.index - A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices
* @param {String or String[] or Boolean} params.index - A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices
*/
api.suggest = ca({
methods: [
@ -30582,7 +30582,7 @@ api.suggest = ca({
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {String} params.consistency - Explicit write consistency setting for the operation
* @param {String|ArrayOfStrings|Boolean} params.fields - A comma-separated list of fields to return in the response
* @param {String or String[] or Boolean} params.fields - A comma-separated list of fields to return in the response
* @param {String} params.lang - The script language (default: mvel)
* @param {String} params.parent - ID of the parent document
* @param {String} params.percolate - Perform percolation during the operation; use specific registered query name, attribute, or wildcard
@ -30591,8 +30591,8 @@ api.suggest = ca({
* @param {Number} params.retryOnConflict - Specify how many times should the operation be retried when a conflict occurs (default: 0)
* @param {String} params.routing - Specific routing value
* @param {*} params.script - The URL-encoded script definition (instead of using request body)
* @param {Date|Number} params.timeout - Explicit operation timeout
* @param {Date|Number} params.timestamp - Explicit timestamp for the document
* @param {Date or Number} params.timeout - Explicit operation timeout
* @param {Date or Number} params.timestamp - Explicit timestamp for the document
* @param {Duration} params.ttl - Expiration time for the document
* @param {Number} params.version - Explicit version number for concurrency control
* @param {String} params.versionType - Specific version type