diff --git a/docs/authentication.asciidoc b/docs/authentication.asciidoc index 8a69cb404..bf75e5644 100644 --- a/docs/authentication.asciidoc +++ b/docs/authentication.asciidoc @@ -1,8 +1,8 @@ -= Authentication +== Authentication This document contains code snippets to show you how to connect to various Elasticsearch providers. -== Basic Auth +=== Basic Auth You can provide your credentials in the node(s) URL. @@ -29,7 +29,7 @@ const client = new Client({ }) ---- -== SSL configuration +=== SSL configuration Without any additional configuration you can specify `https://` node urls, but the certificates used to sign these requests will not verified (`rejectUnauthorized: false`). To turn on certificate verification you must specify an `ssl` object either in the top level config or in each host config object and set `rejectUnauthorized: true`. The ssl config object can contain many of the same configuration options that https://nodejs.org/api/tls.html#tls_tls_connect_options_callback[tls.connect()] accepts. @@ -45,7 +45,7 @@ const client = new Client({ }) ---- -== Elastic Cloud +=== Elastic Cloud If you are using https://www.elastic.co/cloud[Elastic Cloud], the client offers a easy way to connect to it via the `cloud` option. + You must pass the Cloud ID that you can find in the cloud console, then your username and password. diff --git a/docs/breaking-changes.asciidoc b/docs/breaking-changes.asciidoc index 3170fd922..724f6ed56 100644 --- a/docs/breaking-changes.asciidoc +++ b/docs/breaking-changes.asciidoc @@ -1,4 +1,4 @@ -= Breaking changes coming from the old client +== Breaking changes coming from the old client If you were already using the previous version of this client --i.e. the one you used to install with `npm install elasticsearch`-- you will encounter some breaking changes. diff --git a/docs/child.asciidoc b/docs/child.asciidoc index 74ba23185..2c58b013f 100644 --- a/docs/child.asciidoc +++ b/docs/child.asciidoc @@ -1,4 +1,4 @@ -= Creating a child client +== Creating a child client There are some use cases where you may need multiple instances of the client. You can easily do that by calling `new Client()` as many times as you need, but you will lose all the benefits of using one single client, such as the long living connections and the connection pool handling. + To avoid this problem the client offers a `child` API, which returns a new client instance that shares the connection pool with the parent client. + diff --git a/docs/configuration.asciidoc b/docs/configuration.asciidoc index 5392cec24..60bca53cd 100644 --- a/docs/configuration.asciidoc +++ b/docs/configuration.asciidoc @@ -1,4 +1,4 @@ -= Client configuration +== Client configuration The client is designed to be easily configured as you see fit for your needs, following you can see all the possible basic options that you can use to configure it. @@ -14,7 +14,7 @@ const client = new Client({ }) ---- -== Basic options +=== Basic options [cols=2*] |=== |`node` or `nodes` @@ -72,7 +72,7 @@ _Default:_ `false` |`resurrectStrategy` |`string` - Configure the node resurrection strategy. + -_Options:_ `'ping'`, `'optimistic'`, `'none'` + +_Options:_ `'ping'`, `'optimistic'`, `'none'` + _Default:_ `'ping'` |`suggestCompression` @@ -122,7 +122,7 @@ function nodeSelector (connections) { ---- |=== -== Advanced configuration +=== Advanced configuration If you need to customize the client behavior heavily, you are in the right place! + The client allows you to customize the following internals: diff --git a/docs/examples/asStream.asciidoc b/docs/examples/asStream.asciidoc index 00929bab0..648f2cd06 100644 --- a/docs/examples/asStream.asciidoc +++ b/docs/examples/asStream.asciidoc @@ -1,3 +1,4 @@ +[[as_stream_examples]] == asStream Instead of getting the parsed body back, you will get the raw Node.js stream of data. diff --git a/docs/examples/bulk.asciidoc b/docs/examples/bulk.asciidoc index 93c5397c1..b7de4d37f 100644 --- a/docs/examples/bulk.asciidoc +++ b/docs/examples/bulk.asciidoc @@ -1,4 +1,5 @@ -= Bulk +[[bulk_examples]] +== Bulk The `bulk` API makes it possible to perform many index/delete operations in a single API call. + This can greatly increase the indexing speed. diff --git a/docs/examples/exists.asciidoc b/docs/examples/exists.asciidoc index 4c64287a3..dc8b42871 100644 --- a/docs/examples/exists.asciidoc +++ b/docs/examples/exists.asciidoc @@ -1,4 +1,5 @@ -= Exists +[[exists_examples]] +== Exists Check that the document `/game-of-thrones/1` exists. diff --git a/docs/examples/get.asciidoc b/docs/examples/get.asciidoc index b978bc8ce..c2fd5a61d 100644 --- a/docs/examples/get.asciidoc +++ b/docs/examples/get.asciidoc @@ -1,4 +1,5 @@ -= Get +[[get_examples]] +== Get The get API allows to get a typed JSON document from the index based on its id. + The following example gets a JSON document from an index called `game-of-thrones`, under a type called `_doc`, with id valued `'1'`. diff --git a/docs/examples/ignore.asciidoc b/docs/examples/ignore.asciidoc index d4b5a9af1..d747daae7 100644 --- a/docs/examples/ignore.asciidoc +++ b/docs/examples/ignore.asciidoc @@ -1,3 +1,4 @@ +[[ignore_examples]] == Ignore HTTP status codes which should not be considered errors for this request. diff --git a/docs/examples/index.asciidoc b/docs/examples/index.asciidoc new file mode 100644 index 000000000..747a068c6 --- /dev/null +++ b/docs/examples/index.asciidoc @@ -0,0 +1,28 @@ +[[examples]] += Examples + +Following you can find some examples on how to use the client. + +* Use of the <> parameter; +* Executing a <> request; +* Executing a <> request; +* Executing a <> request; +* Use of the <> parameter; +* Executing a <> request; +* How do I <>? +* Executing a <> request; +* I need <>; +* How to use the <> method; +* How to use <>; + +include::asStream.asciidoc[] +include::bulk.asciidoc[] +include::exists.asciidoc[] +include::get.asciidoc[] +include::ignore.asciidoc[] +include::msearch.asciidoc[] +include::scroll.asciidoc[] +include::search.asciidoc[] +include::suggest.asciidoc[] +include::transport.request.asciidoc[] +include::typescript.asciidoc[] diff --git a/docs/examples/msearch.asciidoc b/docs/examples/msearch.asciidoc index 5915dc77d..9dbdec1ff 100644 --- a/docs/examples/msearch.asciidoc +++ b/docs/examples/msearch.asciidoc @@ -1,4 +1,5 @@ -= MSearch +[[msearch_examples]] +== MSearch The multi search API allows to execute several search requests within the same API. diff --git a/docs/examples/scroll.asciidoc b/docs/examples/scroll.asciidoc index 90ade2fb6..d07b7449f 100644 --- a/docs/examples/scroll.asciidoc +++ b/docs/examples/scroll.asciidoc @@ -1,4 +1,5 @@ -= Scroll +[[scroll_examples]] +== Scroll While a search request returns a single “page” of results, the scroll API can be used to retrieve large numbers of results (or even all results) from a single search request, in much the same way as you would use a cursor on a traditional database. diff --git a/docs/examples/search.asciidoc b/docs/examples/search.asciidoc index 794efc1e5..62420024a 100644 --- a/docs/examples/search.asciidoc +++ b/docs/examples/search.asciidoc @@ -1,4 +1,5 @@ -= Search +[[search_examples]] +== Search The `search` API allows you to execute a search query and get back search hits that match the query. + The query can either be provided using a simple https://www.elastic.co/guide/en/elasticsearch/reference/6.6/search-uri-request.html[query string as a parameter], or using a https://www.elastic.co/guide/en/elasticsearch/reference/6.6/search-request-body.html[request body]. diff --git a/docs/examples/suggest.asciidoc b/docs/examples/suggest.asciidoc index d691d8344..d252f6803 100644 --- a/docs/examples/suggest.asciidoc +++ b/docs/examples/suggest.asciidoc @@ -1,4 +1,5 @@ -= Suggest +[[suggest_examples]] +== Suggest The suggest feature suggests similar looking terms based on a provided text by using a suggester. _Parts of the suggest feature are still under development._ diff --git a/docs/examples/transport.request.asciidoc b/docs/examples/transport.request.asciidoc index f89514b50..8689a7363 100644 --- a/docs/examples/transport.request.asciidoc +++ b/docs/examples/transport.request.asciidoc @@ -1,4 +1,5 @@ -= transport.request +[[transport_request_examples]] +== transport.request It can happen that you need to communicate with Elasticsearch by using an API that is not supported by the client, to mitigate this issue you can directly call `client.transport.request`, which is the internal utility that the client uses to communicate with Elasticsearch when you use an API method. diff --git a/docs/examples/typescript.asciidoc b/docs/examples/typescript.asciidoc index b3df28b74..40e211f4b 100644 --- a/docs/examples/typescript.asciidoc +++ b/docs/examples/typescript.asciidoc @@ -1,4 +1,5 @@ -= Typescript +[[typescript_examples]] +== Typescript The client offers a first-class support for TypeScript, since it ships the type definitions for every exposed API. diff --git a/docs/extend.asciidoc b/docs/extend.asciidoc index c80c8bd3f..0c246e53a 100644 --- a/docs/extend.asciidoc +++ b/docs/extend.asciidoc @@ -1,4 +1,4 @@ -= Extend the client +== Extend the client Sometimes you need to reuse the same logic, or you want to build a custom API to allow you simplify your code. + The easiest way to achieve that is by extending the client. diff --git a/docs/index.asciidoc b/docs/index.asciidoc index 2c4d7fb87..9995ab490 100644 --- a/docs/index.asciidoc +++ b/docs/index.asciidoc @@ -1,51 +1,12 @@ = @elastic/elasticsearch -The official Node.js client for Elasticsearch. - -== Features -* One-to-one mapping with REST API. -* Generalized, pluggable architecture. -* Configurable, automatic discovery of cluster nodes. -* Persistent, Keep-Alive connections. -* Load balancing (with pluggable selection strategy) across all available nodes. -* TypeScript support out of the box. - -== Install -[source,sh] ----- -npm install @elastic/elasticsearch ----- -By default the latest version of the module will be installed, which is the same version of the current release of Elasticsearch. + -If you need to work with older versions of Elasticsearch, you should install the same version of the client as well. + -For example, if you are using Elasticsearch `v6.5.4`, you will need the client `v6`, and you can easily do that with `npm install @elastic/elasticsearch@6`. - -== Usage -[source,js] ----- -const { Client } = require('@elastic/elasticsearch') -const client = new Client({ node: 'http://localhost:9200' }) - -// promise API -const result = await client.search({ - index: 'my-index', - body: { foo: 'bar' } -}) - -// callback API -client.search({ - index: 'my-index', - body: { foo: 'bar' } -}, (err, result) => { - if (err) console.log(err) -}) ----- - -== Reference -* Client configuration -* Client usage -* API methods -* TypeScript support -* Extend the client -* Breaking changes from old client -* Authentication -* Child client +include::introduction.asciidoc[] +include::usage.asciidoc[] +include::configuration.asciidoc[] +include::reference.asciidoc[] +include::breaking-changes.asciidoc[] +include::authentication.asciidoc[] +include::child.asciidoc[] +include::extend.asciidoc[] +include::typescript.asciidoc[] +include::examples/index.asciidoc[] diff --git a/docs/introduction.asciidoc b/docs/introduction.asciidoc new file mode 100644 index 000000000..5f0a2e73a --- /dev/null +++ b/docs/introduction.asciidoc @@ -0,0 +1,52 @@ +== Introduction + +The official Node.js client for Elasticsearch. + +=== Features +* One-to-one mapping with REST API. +* Generalized, pluggable architecture. +* Configurable, automatic discovery of cluster nodes. +* Persistent, Keep-Alive connections. +* Load balancing (with pluggable selection strategy) across all available nodes. +* TypeScript support out of the box. + +=== Install +[source,sh] +---- +npm install @elastic/elasticsearch +---- + +=== Compatibility + +The library is compatible with all Elasticsearch versions since 5.x, but you should use the same major version of the Elasticsearch instance that you are using. +---- +# Elasticsearch 7.x +@elastic/elasticsearch@7 + +# Elasticsearch 6.x +@elastic/elasticsearch@6 + +# Elasticsearch 5.x +@elastic/elasticsearch@5 +---- + +=== Usage +[source,js] +---- +const { Client } = require('@elastic/elasticsearch') +const client = new Client({ node: 'http://localhost:9200' }) + +// promise API +const result = await client.search({ + index: 'my-index', + body: { foo: 'bar' } +}) + +// callback API +client.search({ + index: 'my-index', + body: { foo: 'bar' } +}, (err, result) => { + if (err) console.log(err) +}) +---- \ No newline at end of file diff --git a/docs/reference.asciidoc b/docs/reference.asciidoc index 83354c848..d1f22e108 100644 --- a/docs/reference.asciidoc +++ b/docs/reference.asciidoc @@ -1,4 +1,11 @@ -= API Reference +== API Reference + +//////// + +This documentation is generated by running: +node scripts/run.js --tag v7.0.0-beta + +//////// === Common parameters Parameters that are accepted by all API endpoints. @@ -70,6 +77,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-bulk.html |`object` - The operation definition and data (action-data pairs), separated by newlines |=== + === cat.aliases [source,js] ---- @@ -103,6 +111,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-alias.html |`boolean` - Verbose mode. Display column headers |=== + === cat.allocation [source,js] ---- @@ -139,6 +148,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-allocation.htm |`boolean` - Verbose mode. Display column headers |=== + === cat.count [source,js] ---- @@ -172,6 +182,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-count.html |`boolean` - Verbose mode. Display column headers |=== + === cat.fielddata [source,js] ---- @@ -211,6 +222,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-fielddata.html |`string, string[]` - A comma-separated list of fields to return in the output |=== + === cat.health [source,js] ---- @@ -239,12 +251,13 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-health.html |`ts` |`boolean` - Set to false to disable timestamping + - _Default:_ `true` +_Default:_ `true` |`v` |`boolean` - Verbose mode. Display column headers |=== + === cat.help [source,js] ---- @@ -260,6 +273,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/cat.html |`string, string[]` - Comma-separated list of column names or column aliases to sort by |=== + === cat.indices [source,js] ---- @@ -302,6 +316,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-indices.html |`boolean` - Verbose mode. Display column headers |=== + === cat.master [source,js] ---- @@ -332,6 +347,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-master.html |`boolean` - Verbose mode. Display column headers |=== + === cat.nodeattrs [source,js] ---- @@ -362,6 +378,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodeattrs.html |`boolean` - Verbose mode. Display column headers |=== + === cat.nodes [source,js] ---- @@ -395,6 +412,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodes.html |`boolean` - Verbose mode. Display column headers |=== + === cat.pendingTasks [source,js] ---- @@ -425,6 +443,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-pending-tasks. |`boolean` - Verbose mode. Display column headers |=== + === cat.plugins [source,js] ---- @@ -455,6 +474,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-plugins.html |`boolean` - Verbose mode. Display column headers |=== + === cat.recovery [source,js] ---- @@ -488,6 +508,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-recovery.html |`boolean` - Verbose mode. Display column headers |=== + === cat.repositories [source,js] ---- @@ -518,6 +539,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-repositories.h |`boolean` - Verbose mode. Display column headers |=== + === cat.segments [source,js] ---- @@ -548,6 +570,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-segments.html |`boolean` - Verbose mode. Display column headers |=== + === cat.shards [source,js] ---- @@ -584,6 +607,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-shards.html |`boolean` - Verbose mode. Display column headers |=== + === cat.snapshots [source,js] ---- @@ -617,6 +641,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-snapshots.html |`boolean` - Verbose mode. Display column headers |=== + === cat.tasks [source,js] ---- @@ -653,6 +678,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html |`boolean` - Verbose mode. Display column headers |=== + === cat.templates [source,js] ---- @@ -686,6 +712,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-templates.html |`boolean` - Verbose mode. Display column headers |=== + === cat.threadPool [source,js] ---- @@ -722,6 +749,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-thread-pool.ht |`boolean` - Verbose mode. Display column headers |=== + === clearScroll [source,js] ---- @@ -737,6 +765,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/search-request-scr |`object` - A comma-separated list of scroll IDs to clear if none was specified via the scroll_id parameter |=== + === cluster.allocationExplain [source,js] ---- @@ -755,6 +784,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-allocation |`object` - The index, shard, and primary flag to explain. Empty means 'explain the first unassigned shard' |=== + === cluster.getSettings [source,js] ---- @@ -776,6 +806,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-update-set |`boolean` - Whether to return all default clusters setting. |=== + === cluster.health [source,js] ---- @@ -789,7 +820,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-health.htm |`level` |`'cluster', 'indices', 'shards'` - Specify the level of detail for returned information + - _Default:_ `cluster` +_Default:_ `cluster` |`local` |`boolean` - Return local information, do not retrieve the state from master node (default: false) @@ -819,6 +850,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-health.htm |`'green', 'yellow', 'red'` - Wait until cluster is in a specific state |=== + === cluster.pendingTasks [source,js] ---- @@ -834,6 +866,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-pending.ht |`string` - Specify timeout for connection to master |=== + === cluster.putSettings [source,js] ---- @@ -855,15 +888,15 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-update-set |`object` - The settings to be updated. Can be either `transient` or `persistent` (survives cluster restart). |=== + === cluster.remoteInfo [source,js] ---- client.cluster.remoteInfo([params] [, options] [, callback]) ---- http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-remote-info.html -[cols=2*] -|=== -|=== + + === cluster.reroute [source,js] ---- @@ -894,6 +927,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-reroute.ht |`object` - The definition of `commands` to perform (`move`, `cancel`, `allocate`) |=== + === cluster.state [source,js] ---- @@ -931,9 +965,10 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-state.html |`expand_wildcards` or `expandWildcards` |`'open', 'closed', 'none', 'all'` - Whether to expand wildcard expression to concrete indices that are open, closed or both. + - _Default:_ `open` +_Default:_ `open` |=== + === cluster.stats [source,js] ---- @@ -952,6 +987,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-stats.html |`string` - Explicit operation timeout |=== + === count [source,js] ---- @@ -977,7 +1013,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/search-count.html |`expand_wildcards` or `expandWildcards` |`'open', 'closed', 'none', 'all'` - Whether to expand wildcard expression to concrete indices that are open, closed or both. + - _Default:_ `open` +_Default:_ `open` |`min_score` or `minScore` |`number` - Include only documents with a specific `_score` value in the result @@ -999,7 +1035,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/search-count.html |`default_operator` or `defaultOperator` |`'AND', 'OR'` - The default operator for query string query (AND or OR) + - _Default:_ `OR` +_Default:_ `OR` |`df` |`string` - The field to use as default where no field prefix is given in the query string @@ -1014,6 +1050,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/search-count.html |`object` - A query to restrict the results specified with the Query DSL (optional) |=== + === create [source,js] ---- @@ -1059,6 +1096,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html |`object` - The document |=== + === delete [source,js] ---- @@ -1104,6 +1142,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete.html |`'internal', 'external', 'external_gte', 'force'` - Specific version type |=== + === deleteByQuery [source,js] ---- @@ -1126,7 +1165,7 @@ https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete-by-qu |`default_operator` or `defaultOperator` |`'AND', 'OR'` - The default operator for query string query (AND or OR) + - _Default:_ `OR` +_Default:_ `OR` |`df` |`string` - The field to use as default where no field prefix is given in the query string @@ -1142,11 +1181,11 @@ https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete-by-qu |`conflicts` |`'abort', 'proceed'` - What to do when the delete by query hits version conflicts? + - _Default:_ `abort` +_Default:_ `abort` |`expand_wildcards` or `expandWildcards` |`'open', 'closed', 'none', 'all'` - Whether to expand wildcard expression to concrete indices that are open, closed or both. + - _Default:_ `open` +_Default:_ `open` |`lenient` |`boolean` - Specify whether format-based query failures (such as providing text to a numeric field) should be ignored @@ -1201,7 +1240,7 @@ https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete-by-qu |`timeout` |`string` - Time each individual bulk request should wait for shards that are unavailable. + - _Default:_ `1m` +_Default:_ `1m` |`wait_for_active_shards` or `waitForActiveShards` |`string` - Sets the number of shard copies that must be active before proceeding with the delete by query operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1) @@ -1211,19 +1250,20 @@ https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete-by-qu |`wait_for_completion` or `waitForCompletion` |`boolean` - Should the request should block until the delete by query is complete. + - _Default:_ `true` +_Default:_ `true` |`requests_per_second` or `requestsPerSecond` |`number` - The throttle for this request in sub-requests per second. -1 means no throttle. |`slices` |`number` - The number of slices this task should be divided into. Defaults to 1 meaning the task isn't sliced into subtasks. + - _Default:_ `1` +_Default:_ `1` |`body` |`object` - The search definition using the Query DSL |=== + === deleteByQueryRethrottle [source,js] ---- @@ -1239,6 +1279,7 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-delete-by-q |`number` - The throttle to set on this request in floating sub-requests per second. -1 means set no throttle. |=== + === deleteScript [source,js] ---- @@ -1257,6 +1298,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting. |`string` - Specify timeout for connection to master |=== + === exists [source,js] ---- @@ -1308,6 +1350,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html |`'internal', 'external', 'external_gte', 'force'` - Specific version type |=== + === existsSource [source,js] ---- @@ -1356,6 +1399,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html |`'internal', 'external', 'external_gte', 'force'` - Specific version type |=== + === explain [source,js] ---- @@ -1381,7 +1425,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/search-explain.htm |`default_operator` or `defaultOperator` |`'AND', 'OR'` - The default operator for query string query (AND or OR) + - _Default:_ `OR` +_Default:_ `OR` |`df` |`string` - The default field for query string query (default: _all) @@ -1417,6 +1461,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/search-explain.htm |`object` - The query definition using the Query DSL |=== + === fieldCaps [source,js] ---- @@ -1439,12 +1484,13 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/search-field-caps. |`expand_wildcards` or `expandWildcards` |`'open', 'closed', 'none', 'all'` - Whether to expand wildcard expression to concrete indices that are open, closed or both. + - _Default:_ `open` +_Default:_ `open` |`body` |`object` - Field json objects containing an array of field names |=== + === get [source,js] ---- @@ -1502,6 +1548,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html |`'internal', 'external', 'external_gte', 'force'` - Specific version type |=== + === getScript [source,js] ---- @@ -1517,6 +1564,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting. |`string` - Specify timeout for connection to master |=== + === getSource [source,js] ---- @@ -1565,6 +1613,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html |`'internal', 'external', 'external_gte', 'force'` - Specific version type |=== + === index [source,js] ---- @@ -1587,7 +1636,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html |`op_type` or `opType` |`'index', 'create'` - Explicit operation type + - _Default:_ `index` +_Default:_ `index` |`parent` |`string` - ID of the parent document @@ -1620,6 +1669,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html |`object` - The document |=== + === indices.analyze [source,js] ---- @@ -1638,6 +1688,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-analyze.ht |`object` - Define analyzer/tokenizer parameters and the text on which the analysis should be performed |=== + === indices.clearCache [source,js] ---- @@ -1669,7 +1720,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-clearcache |`expand_wildcards` or `expandWildcards` |`'open', 'closed', 'none', 'all'` - Whether to expand wildcard expression to concrete indices that are open, closed or both. + - _Default:_ `open` +_Default:_ `open` |`index` |`string, string[]` - A comma-separated list of index name to limit the operation @@ -1681,6 +1732,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-clearcache |`boolean` - Clear request cache |=== + === indices.close [source,js] ---- @@ -1706,9 +1758,10 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-open-close |`expand_wildcards` or `expandWildcards` |`'open', 'closed', 'none', 'all'` - Whether to expand wildcard expression to concrete indices that are open, closed or both. + - _Default:_ `open` +_Default:_ `open` |=== + === indices.create [source,js] ---- @@ -1736,6 +1789,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-create-ind |`object` - The configuration for the index (`settings` and `mappings`) |=== + === indices.delete [source,js] ---- @@ -1761,9 +1815,10 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-delete-ind |`expand_wildcards` or `expandWildcards` |`'open', 'closed', 'none', 'all'` - Whether wildcard expressions should get expanded to open or closed indices (default: open) + - _Default:_ `open` +_Default:_ `open` |=== + === indices.deleteAlias [source,js] ---- @@ -1785,6 +1840,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.ht |`string` - Specify timeout for connection to master |=== + === indices.deleteTemplate [source,js] ---- @@ -1803,6 +1859,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates. |`string` - Specify timeout for connection to master |=== + === indices.exists [source,js] ---- @@ -1825,7 +1882,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-exists.htm |`expand_wildcards` or `expandWildcards` |`'open', 'closed', 'none', 'all'` - Whether wildcard expressions should get expanded to open or closed indices (default: open) + - _Default:_ `open` +_Default:_ `open` |`flat_settings` or `flatSettings` |`boolean` - Return settings in flat format (default: false) @@ -1834,6 +1891,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-exists.htm |`boolean` - Whether to return all default setting for each of the indices. |=== + === indices.existsAlias [source,js] ---- @@ -1856,12 +1914,13 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.ht |`expand_wildcards` or `expandWildcards` |`'open', 'closed', 'none', 'all'` - Whether to expand wildcard expression to concrete indices that are open, closed or both. + - _Default:_ `all` +_Default:_ `all` |`local` |`boolean` - Return local information, do not retrieve the state from master node (default: false) |=== + === indices.existsTemplate [source,js] ---- @@ -1883,6 +1942,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates. |`boolean` - Return local information, do not retrieve the state from master node (default: false) |=== + === indices.existsType [source,js] ---- @@ -1905,12 +1965,13 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-types-exis |`expand_wildcards` or `expandWildcards` |`'open', 'closed', 'none', 'all'` - Whether to expand wildcard expression to concrete indices that are open, closed or both. + - _Default:_ `open` +_Default:_ `open` |`local` |`boolean` - Return local information, do not retrieve the state from master node (default: false) |=== + === indices.flush [source,js] ---- @@ -1936,9 +1997,10 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-flush.html |`expand_wildcards` or `expandWildcards` |`'open', 'closed', 'none', 'all'` - Whether to expand wildcard expression to concrete indices that are open, closed or both. + - _Default:_ `open` +_Default:_ `open` |=== + === indices.flushSynced [source,js] ---- @@ -1958,9 +2020,10 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-synced-flu |`expand_wildcards` or `expandWildcards` |`'open', 'closed', 'none', 'all'` - Whether to expand wildcard expression to concrete indices that are open, closed or both. + - _Default:_ `open` +_Default:_ `open` |=== + === indices.forcemerge [source,js] ---- @@ -1983,7 +2046,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-forcemerge |`expand_wildcards` or `expandWildcards` |`'open', 'closed', 'none', 'all'` - Whether to expand wildcard expression to concrete indices that are open, closed or both. + - _Default:_ `open` +_Default:_ `open` |`max_num_segments` or `maxNumSegments` |`number` - The number of segments the index should be merged into (default: dynamic) @@ -1992,6 +2055,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-forcemerge |`boolean` - Specify whether the operation should only expunge deleted documents |=== + === indices.get [source,js] ---- @@ -2014,7 +2078,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-index. |`expand_wildcards` or `expandWildcards` |`'open', 'closed', 'none', 'all'` - Whether wildcard expressions should get expanded to open or closed indices (default: open) + - _Default:_ `open` +_Default:_ `open` |`flat_settings` or `flatSettings` |`boolean` - Return settings in flat format (default: false) @@ -2026,6 +2090,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-index. |`string` - Specify timeout for connection to master |=== + === indices.getAlias [source,js] ---- @@ -2048,12 +2113,13 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.ht |`expand_wildcards` or `expandWildcards` |`'open', 'closed', 'none', 'all'` - Whether to expand wildcard expression to concrete indices that are open, closed or both. + - _Default:_ `all` +_Default:_ `all` |`local` |`boolean` - Return local information, do not retrieve the state from master node (default: false) |=== + === indices.getFieldMapping [source,js] ---- @@ -2082,12 +2148,13 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-field- |`expand_wildcards` or `expandWildcards` |`'open', 'closed', 'none', 'all'` - Whether to expand wildcard expression to concrete indices that are open, closed or both. + - _Default:_ `open` +_Default:_ `open` |`local` |`boolean` - Return local information, do not retrieve the state from master node (default: false) |=== + === indices.getMapping [source,js] ---- @@ -2110,7 +2177,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-mappin |`expand_wildcards` or `expandWildcards` |`'open', 'closed', 'none', 'all'` - Whether to expand wildcard expression to concrete indices that are open, closed or both. + - _Default:_ `open` +_Default:_ `open` |`master_timeout` or `masterTimeout` |`string` - Specify timeout for connection to master @@ -2119,6 +2186,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-mappin |`boolean` - Return local information, do not retrieve the state from master node (default: false) |=== + === indices.getSettings [source,js] ---- @@ -2144,7 +2212,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-settin |`expand_wildcards` or `expandWildcards` |`'open', 'closed', 'none', 'all'` - Whether to expand wildcard expression to concrete indices that are open, closed or both. + - _Default:_ `open,closed` +_Default:_ `open,closed` |`flat_settings` or `flatSettings` |`boolean` - Return settings in flat format (default: false) @@ -2156,6 +2224,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-settin |`boolean` - Whether to return all default setting for each of the indices. |=== + === indices.getTemplate [source,js] ---- @@ -2177,6 +2246,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates. |`boolean` - Return local information, do not retrieve the state from master node (default: false) |=== + === indices.getUpgrade [source,js] ---- @@ -2196,9 +2266,10 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-upgrade.ht |`expand_wildcards` or `expandWildcards` |`'open', 'closed', 'none', 'all'` - Whether to expand wildcard expression to concrete indices that are open, closed or both. + - _Default:_ `open` +_Default:_ `open` |=== + === indices.open [source,js] ---- @@ -2224,12 +2295,13 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-open-close |`expand_wildcards` or `expandWildcards` |`'open', 'closed', 'none', 'all'` - Whether to expand wildcard expression to concrete indices that are open, closed or both. + - _Default:_ `closed` +_Default:_ `closed` |`wait_for_active_shards` or `waitForActiveShards` |`string` - Sets the number of active shards to wait for before the operation returns. |=== + === indices.putAlias [source,js] ---- @@ -2254,6 +2326,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.ht |`object` - The settings for the alias, such as `routing` or `filter` |=== + === indices.putMapping [source,js] ---- @@ -2282,7 +2355,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-put-mappin |`expand_wildcards` or `expandWildcards` |`'open', 'closed', 'none', 'all'` - Whether to expand wildcard expression to concrete indices that are open, closed or both. + - _Default:_ `open` +_Default:_ `open` |`update_all_types` or `updateAllTypes` |`boolean` - Whether to update the mapping for all fields with the same name across all types or not @@ -2291,6 +2364,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-put-mappin |`object` - The mapping definition |=== + === indices.putSettings [source,js] ---- @@ -2319,7 +2393,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-update-set |`expand_wildcards` or `expandWildcards` |`'open', 'closed', 'none', 'all'` - Whether to expand wildcard expression to concrete indices that are open, closed or both. + - _Default:_ `open` +_Default:_ `open` |`flat_settings` or `flatSettings` |`boolean` - Return settings in flat format (default: false) @@ -2328,6 +2402,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-update-set |`object` - The index settings to be updated |=== + === indices.putTemplate [source,js] ---- @@ -2358,6 +2433,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates. |`object` - The template definition |=== + === indices.recovery [source,js] ---- @@ -2376,6 +2452,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-recovery.h |`boolean` - Display only those recoveries that are currently on-going |=== + === indices.refresh [source,js] ---- @@ -2395,9 +2472,10 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-refresh.ht |`expand_wildcards` or `expandWildcards` |`'open', 'closed', 'none', 'all'` - Whether to expand wildcard expression to concrete indices that are open, closed or both. + - _Default:_ `open` +_Default:_ `open` |=== + === indices.rollover [source,js] ---- @@ -2428,6 +2506,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-rollover-i |`object` - The conditions that needs to be met for executing rollover |=== + === indices.segments [source,js] ---- @@ -2447,12 +2526,13 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-segments.h |`expand_wildcards` or `expandWildcards` |`'open', 'closed', 'none', 'all'` - Whether to expand wildcard expression to concrete indices that are open, closed or both. + - _Default:_ `open` +_Default:_ `open` |`verbose` |`boolean` - Includes detailed memory usage by Lucene. |=== + === indices.shardStores [source,js] ---- @@ -2475,9 +2555,10 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-shards-sto |`expand_wildcards` or `expandWildcards` |`'open', 'closed', 'none', 'all'` - Whether to expand wildcard expression to concrete indices that are open, closed or both. + - _Default:_ `open` +_Default:_ `open` |=== + === indices.shrink [source,js] ---- @@ -2508,6 +2589,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-shrink-ind |`object` - The configuration for the target index (`settings` and `aliases`) |=== + === indices.split [source,js] ---- @@ -2538,6 +2620,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-split-inde |`object` - The configuration for the target index (`settings` and `aliases`) |=== + === indices.stats [source,js] ---- @@ -2566,7 +2649,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-stats.html |`level` |`'cluster', 'indices', 'shards'` - Return stats aggregated at cluster, index or shard level + - _Default:_ `indices` +_Default:_ `indices` |`types` |`string, string[]` - A comma-separated list of document types for the `indexing` index metric @@ -2575,6 +2658,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-stats.html |`boolean` - Whether to report the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested) |=== + === indices.updateAliases [source,js] ---- @@ -2593,6 +2677,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.ht |`object` - The definition of `actions` to perform |=== + === indices.upgrade [source,js] ---- @@ -2609,7 +2694,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-upgrade.ht |`expand_wildcards` or `expandWildcards` |`'open', 'closed', 'none', 'all'` - Whether to expand wildcard expression to concrete indices that are open, closed or both. + - _Default:_ `open` +_Default:_ `open` |`ignore_unavailable` or `ignoreUnavailable` |`boolean` - Whether specified concrete indices should be ignored when unavailable (missing or closed) @@ -2621,6 +2706,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-upgrade.ht |`boolean` - If true, only ancient (an older Lucene major release) segments will be upgraded |=== + === indices.validateQuery [source,js] ---- @@ -2646,7 +2732,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/search-validate.ht |`expand_wildcards` or `expandWildcards` |`'open', 'closed', 'none', 'all'` - Whether to expand wildcard expression to concrete indices that are open, closed or both. + - _Default:_ `open` +_Default:_ `open` |`q` |`string` - Query in the Lucene query string syntax @@ -2659,7 +2745,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/search-validate.ht |`default_operator` or `defaultOperator` |`'AND', 'OR'` - The default operator for query string query (AND or OR) + - _Default:_ `OR` +_Default:_ `OR` |`df` |`string` - The field to use as default where no field prefix is given in the query string @@ -2677,15 +2763,15 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/search-validate.ht |`object` - The query definition specified with the Query DSL |=== + === info [source,js] ---- client.info([params] [, options] [, callback]) ---- http://www.elastic.co/guide/ -[cols=2*] -|=== -|=== + + === ingest.deletePipeline [source,js] ---- @@ -2704,6 +2790,7 @@ https://www.elastic.co/guide/en/elasticsearch/plugins/master/ingest.html |`string` - Explicit operation timeout |=== + === ingest.getPipeline [source,js] ---- @@ -2719,15 +2806,15 @@ https://www.elastic.co/guide/en/elasticsearch/plugins/master/ingest.html |`string` - Explicit operation timeout for connection to master node |=== + === ingest.processorGrok [source,js] ---- client.ingest.processorGrok([params] [, options] [, callback]) ---- https://www.elastic.co/guide/en/elasticsearch/plugins/master/ingest.html -[cols=2*] -|=== -|=== + + === ingest.putPipeline [source,js] ---- @@ -2749,6 +2836,7 @@ https://www.elastic.co/guide/en/elasticsearch/plugins/master/ingest.html |`object` - The ingest definition |=== + === ingest.simulate [source,js] ---- @@ -2767,6 +2855,7 @@ https://www.elastic.co/guide/en/elasticsearch/plugins/master/ingest.html |`object` - The simulate definition |=== + === mget [source,js] ---- @@ -2809,6 +2898,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-get.htm |`object` - Document identifiers; can be either `docs` (containing full document information) or `ids` (when index and type is provided in the URL. |=== + === msearch [source,js] ---- @@ -2834,19 +2924,28 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/search-multi-searc |`pre_filter_shard_size` or `preFilterShardSize` |`number` - A threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on it's rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint. + - _Default:_ `128` +_Default:_ `128` |`max_concurrent_shard_requests` or `maxConcurrentShardRequests` |`number` - The number of concurrent shard requests each sub search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests + - _Default:_ `The default grows with the number of nodes in the cluster but is at most 256.` +_Default:_ `The default grows with the number of nodes in the cluster but is at most 256.` |`rest_total_hits_as_int` or `restTotalHitsAsInt` +<<<<<<< HEAD |`boolean` - This parameter is ignored in this version. It is used in the next major version to control whether the rest response should render the total.hits as an object or a number +======= +|`boolean` - Indicates whether hits.total should be rendered as an integer or an object in the rest search response + +|`ccs_minimize_roundtrips` or `ccsMinimizeRoundtrips` +|`boolean` - Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution + +_Default:_ `true` +>>>>>>> ad6f56c... Doc updates (#791) |`body` |`object` - The request definitions (metadata-search request definition pairs), separated by newlines |=== + === msearchTemplate [source,js] ---- @@ -2871,12 +2970,21 @@ http://www.elastic.co/guide/en/elasticsearch/reference/current/search-multi-sear |`number` - Controls the maximum number of concurrent searches the multi search api will execute |`rest_total_hits_as_int` or `restTotalHitsAsInt` +<<<<<<< HEAD |`boolean` - This parameter is ignored in this version. It is used in the next major version to control whether the rest response should render the total.hits as an object or a number +======= +|`boolean` - Indicates whether hits.total should be rendered as an integer or an object in the rest search response + +|`ccs_minimize_roundtrips` or `ccsMinimizeRoundtrips` +|`boolean` - Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution + +_Default:_ `true` +>>>>>>> ad6f56c... Doc updates (#791) |`body` |`object` - The request definitions (metadata-search request definition pairs), separated by newlines |=== + === mtermvectors [source,js] ---- @@ -2899,22 +3007,22 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-termvec |`field_statistics` or `fieldStatistics` |`boolean` - Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs". + - _Default:_ `true` +_Default:_ `true` |`fields` |`string, string[]` - A comma-separated list of fields to return. Applies to all returned documents unless otherwise specified in body "params" or "docs". |`offsets` |`boolean` - Specifies if term offsets should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs". + - _Default:_ `true` +_Default:_ `true` |`positions` |`boolean` - Specifies if term positions should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs". + - _Default:_ `true` +_Default:_ `true` |`payloads` |`boolean` - Specifies if term payloads should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs". + - _Default:_ `true` +_Default:_ `true` |`preference` |`string` - Specify the node or shard the operation should be performed on (default: random) .Applies to all returned documents unless otherwise specified in body "params" or "docs". @@ -2938,6 +3046,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-termvec |`object` - Define ids, documents, parameters or a list of parameters per document here. You must at least provide a list of document ids. See documentation. |=== + === nodes.hotThreads [source,js] ---- @@ -2968,6 +3077,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-hot- |`string` - Explicit operation timeout |=== + === nodes.info [source,js] ---- @@ -2989,6 +3099,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-info |`string` - Explicit operation timeout |=== + === nodes.reloadSecureSettings [source,js] ---- @@ -3004,6 +3115,7 @@ https://www.elastic.co/guide/en/elasticsearch/reference/6.x/secure-settings.html |`string` - Explicit operation timeout |=== + === nodes.stats [source,js] ---- @@ -3035,7 +3147,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-stat |`level` |`'indices', 'node', 'shards'` - Return indices stats aggregated at index, node or shard level + - _Default:_ `node` +_Default:_ `node` |`types` |`string, string[]` - A comma-separated list of document types for the `indexing` index metric @@ -3047,6 +3159,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-stat |`boolean` - Whether to report the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested) |=== + === nodes.usage [source,js] ---- @@ -3065,15 +3178,15 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-usag |`string` - Explicit operation timeout |=== + === ping [source,js] ---- client.ping([params] [, options] [, callback]) ---- http://www.elastic.co/guide/ -[cols=2*] -|=== -|=== + + === putScript [source,js] ---- @@ -3101,6 +3214,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting. |`object` - The document |=== + === rankEval [source,js] ---- @@ -3120,12 +3234,13 @@ https://www.elastic.co/guide/en/elasticsearch/reference/master/search-rank-eval. |`expand_wildcards` or `expandWildcards` |`'open', 'closed', 'none', 'all'` - Whether to expand wildcard expression to concrete indices that are open, closed or both. + - _Default:_ `open` +_Default:_ `open` |`body` |`object` - The ranking evaluation search definition, including search requests, document ratings and ranking metric definition. |=== + === reindex [source,js] ---- @@ -3139,26 +3254,27 @@ https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-reindex.html |`timeout` |`string` - Time each individual bulk request should wait for shards that are unavailable. + - _Default:_ `1m` +_Default:_ `1m` |`wait_for_active_shards` or `waitForActiveShards` |`string` - Sets the number of shard copies that must be active before proceeding with the reindex operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1) |`wait_for_completion` or `waitForCompletion` |`boolean` - Should the request should block until the reindex is complete. + - _Default:_ `true` +_Default:_ `true` |`requests_per_second` or `requestsPerSecond` |`number` - The throttle to set on this request in sub-requests per second. -1 means no throttle. |`slices` |`number` - The number of slices this task should be divided into. Defaults to 1 meaning the task isn't sliced into subtasks. + - _Default:_ `1` +_Default:_ `1` |`body` |`object` - The search definition using the Query DSL and the prototype for the index request. |=== + === reindexRethrottle [source,js] ---- @@ -3174,6 +3290,7 @@ https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-reindex.html |`number` - The throttle to set on this request in floating sub-requests per second. -1 means set no throttle. |=== + === renderSearchTemplate [source,js] ---- @@ -3189,6 +3306,7 @@ http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-temp |`object` - The search definition template and its params |=== + === scriptsPainlessExecute [source,js] ---- @@ -3201,6 +3319,7 @@ https://www.elastic.co/guide/en/elasticsearch/painless/master/painless-execute-a |`object` - The script to execute |=== + === scroll [source,js] ---- @@ -3225,6 +3344,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/search-request-scr |`object` - The scroll ID if not passed by URL or query parameter. |=== + === search [source,js] ---- @@ -3245,9 +3365,16 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/search-search.html |`analyze_wildcard` or `analyzeWildcard` |`boolean` - Specify whether wildcard and prefix queries should be analyzed (default: false) +<<<<<<< HEAD +======= +|`ccs_minimize_roundtrips` or `ccsMinimizeRoundtrips` +|`boolean` - Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution + +_Default:_ `true` + +>>>>>>> ad6f56c... Doc updates (#791) |`default_operator` or `defaultOperator` |`'AND', 'OR'` - The default operator for query string query (AND or OR) + - _Default:_ `OR` +_Default:_ `OR` |`df` |`string` - The field to use as default where no field prefix is given in the query string @@ -3275,7 +3402,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/search-search.html |`expand_wildcards` or `expandWildcards` |`'open', 'closed', 'none', 'all'` - Whether to expand wildcard expression to concrete indices that are open, closed or both. + - _Default:_ `open` +_Default:_ `open` |`lenient` |`boolean` - Specify whether format-based query failures (such as providing text to a numeric field) should be ignored @@ -3321,7 +3448,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/search-search.html |`suggest_mode` or `suggestMode` |`'missing', 'popular', 'always'` - Specify suggest mode + - _Default:_ `missing` +_Default:_ `missing` |`suggest_size` or `suggestSize` |`number` - How many suggestions to return in response @@ -3340,7 +3467,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/search-search.html |`allow_partial_search_results` or `allowPartialSearchResults` |`boolean` - Indicate if an error should be returned if there is a partial search failure or timeout + - _Default:_ `true` +_Default:_ `true` |`typed_keys` or `typedKeys` |`boolean` - Specify whether aggregation and suggester names should be prefixed by their respective types in the response @@ -3353,15 +3480,20 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/search-search.html |`batched_reduce_size` or `batchedReduceSize` |`number` - The number of shard results that should be reduced at once on the coordinating node. This value should be used as a protection mechanism to reduce the memory overhead per search request if the potential number of shards in the request can be large. + - _Default:_ `512` +_Default:_ `512` |`max_concurrent_shard_requests` or `maxConcurrentShardRequests` +<<<<<<< HEAD |`number` - The number of concurrent shard requests this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests + _Default:_ `The default grows with the number of nodes in the cluster but is at most 256.` +======= +|`number` - The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests + +_Default:_ `The default is 5.` +>>>>>>> ad6f56c... Doc updates (#791) |`pre_filter_shard_size` or `preFilterShardSize` |`number` - A threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on it's rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint. + - _Default:_ `128` +_Default:_ `128` |`rest_total_hits_as_int` or `restTotalHitsAsInt` |`boolean` - This parameter is ignored in this version. It is used in the next major version to control whether the rest response should render the total.hits as an object or a number @@ -3370,6 +3502,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/search-search.html |`object` - The search definition using the Query DSL |=== + === searchShards [source,js] ---- @@ -3398,9 +3531,10 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/search-shards.html |`expand_wildcards` or `expandWildcards` |`'open', 'closed', 'none', 'all'` - Whether to expand wildcard expression to concrete indices that are open, closed or both. + - _Default:_ `open` +_Default:_ `open` |=== + === searchTemplate [source,js] ---- @@ -3426,7 +3560,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.h |`expand_wildcards` or `expandWildcards` |`'open', 'closed', 'none', 'all'` - Whether to expand wildcard expression to concrete indices that are open, closed or both. + - _Default:_ `open` +_Default:_ `open` |`preference` |`string` - Specify the node or shard the operation should be performed on (default: random) @@ -3450,12 +3584,21 @@ http://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.h |`boolean` - Specify whether aggregation and suggester names should be prefixed by their respective types in the response |`rest_total_hits_as_int` or `restTotalHitsAsInt` +<<<<<<< HEAD |`boolean` - This parameter is ignored in this version. It is used in the next major version to control whether the rest response should render the total.hits as an object or a number +======= +|`boolean` - Indicates whether hits.total should be rendered as an integer or an object in the rest search response + +|`ccs_minimize_roundtrips` or `ccsMinimizeRoundtrips` +|`boolean` - Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution + +_Default:_ `true` +>>>>>>> ad6f56c... Doc updates (#791) |`body` |`object` - The search definition template and its params |=== + === snapshot.create [source,js] ---- @@ -3480,6 +3623,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots. |`object` - The snapshot definition |=== + === snapshot.createRepository [source,js] ---- @@ -3504,6 +3648,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots. |`object` - The repository definition |=== + === snapshot.delete [source,js] ---- @@ -3522,6 +3667,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots. |`string` - Explicit operation timeout for connection to master node |=== + === snapshot.deleteRepository [source,js] ---- @@ -3540,6 +3686,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots. |`string` - Explicit operation timeout |=== + === snapshot.get [source,js] ---- @@ -3564,6 +3711,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots. |`boolean` - Whether to show verbose snapshot info or only show the basic info found in the repository index blob |=== + === snapshot.getRepository [source,js] ---- @@ -3582,6 +3730,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots. |`boolean` - Return local information, do not retrieve the state from master node (default: false) |=== + === snapshot.restore [source,js] ---- @@ -3606,6 +3755,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots. |`object` - Details of what to restore |=== + === snapshot.status [source,js] ---- @@ -3627,6 +3777,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots. |`boolean` - Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown |=== + === snapshot.verifyRepository [source,js] ---- @@ -3645,6 +3796,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots. |`string` - Explicit operation timeout |=== + === tasks.cancel [source,js] ---- @@ -3666,6 +3818,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html |`string` - Cancel tasks with specified parent task id (node_id:task_number). Set to -1 to cancel all. |=== + === tasks.get [source,js] ---- @@ -3684,6 +3837,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html |`string` - Explicit operation timeout |=== + === tasks.list [source,js] ---- @@ -3709,12 +3863,13 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html |`group_by` or `groupBy` |`'nodes', 'parents', 'none'` - Group tasks by nodes or parent/child relationships + - _Default:_ `nodes` +_Default:_ `nodes` |`timeout` |`string` - Explicit operation timeout |=== + === termvectors [source,js] ---- @@ -3737,22 +3892,22 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-termvectors.h |`field_statistics` or `fieldStatistics` |`boolean` - Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned. + - _Default:_ `true` +_Default:_ `true` |`fields` |`string, string[]` - A comma-separated list of fields to return. |`offsets` |`boolean` - Specifies if term offsets should be returned. + - _Default:_ `true` +_Default:_ `true` |`positions` |`boolean` - Specifies if term positions should be returned. + - _Default:_ `true` +_Default:_ `true` |`payloads` |`boolean` - Specifies if term payloads should be returned. + - _Default:_ `true` +_Default:_ `true` |`preference` |`string` - Specify the node or shard the operation should be performed on (default: random). @@ -3776,6 +3931,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-termvectors.h |`object` - Define parameters and or supply a document to get termvectors for. See documentation. |=== + === update [source,js] ---- @@ -3836,6 +3992,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update.html |`object` - The request definition requires either `script` or partial `doc` |=== + === updateByQuery [source,js] ---- @@ -3858,7 +4015,7 @@ https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update-by-qu |`default_operator` or `defaultOperator` |`'AND', 'OR'` - The default operator for query string query (AND or OR) + - _Default:_ `OR` +_Default:_ `OR` |`df` |`string` - The field to use as default where no field prefix is given in the query string @@ -3874,11 +4031,11 @@ https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update-by-qu |`conflicts` |`'abort', 'proceed'` - What to do when the update by query hits version conflicts? + - _Default:_ `abort` +_Default:_ `abort` |`expand_wildcards` or `expandWildcards` |`'open', 'closed', 'none', 'all'` - Whether to expand wildcard expression to concrete indices that are open, closed or both. + - _Default:_ `open` +_Default:_ `open` |`lenient` |`boolean` - Specify whether format-based query failures (such as providing text to a numeric field) should be ignored @@ -3939,7 +4096,7 @@ https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update-by-qu |`timeout` |`string` - Time each individual bulk request should wait for shards that are unavailable. + - _Default:_ `1m` +_Default:_ `1m` |`wait_for_active_shards` or `waitForActiveShards` |`string` - Sets the number of shard copies that must be active before proceeding with the update by query operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1) @@ -3949,19 +4106,20 @@ https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update-by-qu |`wait_for_completion` or `waitForCompletion` |`boolean` - Should the request should block until the update by query operation is complete. + - _Default:_ `true` +_Default:_ `true` |`requests_per_second` or `requestsPerSecond` |`number` - The throttle to set on this request in sub-requests per second. -1 means no throttle. |`slices` |`number` - The number of slices this task should be divided into. Defaults to 1 meaning the task isn't sliced into subtasks. + - _Default:_ `1` +_Default:_ `1` |`body` |`object` - The search definition using the Query DSL |=== + === updateByQueryRethrottle [source,js] ---- @@ -3977,6 +4135,7 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-update-by-q |`number` - The throttle to set on this request in floating sub-requests per second. -1 means set no throttle. |=== + === ccr.deleteAutoFollowPattern [source,js] ---- @@ -3989,6 +4148,7 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-delete-auto- |`string` - The name of the auto follow pattern. |=== + === ccr.follow [source,js] ---- @@ -4000,10 +4160,34 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-put-follow.h |`index` |`string` - The name of the follower index +<<<<<<< HEAD +======= +|`wait_for_active_shards` or `waitForActiveShards` +|`string` - Sets the number of shard copies that must be active before returning. Defaults to 0. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1) + +_Default:_ `0` + +>>>>>>> ad6f56c... Doc updates (#791) |`body` |`object` - The name of the leader index and other optional ccr related parameters |=== +<<<<<<< HEAD +======= + +=== ccr.followInfo +[source,js] +---- +client.ccr.followInfo([params] [, options] [, callback]) +---- +https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-follow-info.html +[cols=2*] +|=== +|`index` +|`string, string[]` - A comma-separated list of index patterns; use `_all` to perform the operation on all indices + +|=== + +>>>>>>> ad6f56c... Doc updates (#791) === ccr.followStats [source,js] ---- @@ -4016,6 +4200,7 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-follow-s |`string, string[]` - A comma-separated list of index patterns; use `_all` to perform the operation on all indices |=== + === ccr.getAutoFollowPattern [source,js] ---- @@ -4028,6 +4213,7 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-auto-fol |`string` - The name of the auto follow pattern. |=== + === ccr.pauseFollow [source,js] ---- @@ -4040,6 +4226,7 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-post-pause-f |`string` - The name of the follower index that should pause following its leader index. |=== + === ccr.putAutoFollowPattern [source,js] ---- @@ -4055,6 +4242,7 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-put-auto-fol |`object` - The specification of the auto follow pattern |=== + === ccr.resumeFollow [source,js] ---- @@ -4070,15 +4258,15 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-post-resume- |`object` - The name of the leader index and other optional ccr related parameters |=== + === ccr.stats [source,js] ---- client.ccr.stats([params] [, options] [, callback]) ---- https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-stats.html -[cols=2*] -|=== -|=== + + === ccr.unfollow [source,js] ---- @@ -4091,6 +4279,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/current |`string` - The name of the follower index that should be turned into a regular index. |=== + === ilm.deleteLifecycle [source,js] ---- @@ -4103,6 +4292,7 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-delete-lifec |`string` - The name of the index lifecycle policy |=== + === ilm.explainLifecycle [source,js] ---- @@ -4116,9 +4306,10 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-explain-life |`human` |`boolean` - Return data such as dates in a human readable format + - _Default:_ `false` +_Default:_ `false` |=== + === ilm.getLifecycle [source,js] ---- @@ -4131,15 +4322,15 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-get-lifecycl |`string` - The name of the index lifecycle policy |=== + === ilm.getStatus [source,js] ---- client.ilm.getStatus([params] [, options] [, callback]) ---- https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-get-status.html -[cols=2*] -|=== -|=== + + === ilm.moveToStep [source,js] ---- @@ -4155,6 +4346,7 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-move-to-step |`object` - The new lifecycle step to move to |=== + === ilm.putLifecycle [source,js] ---- @@ -4170,6 +4362,7 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-put-lifecycl |`object` - The lifecycle policy definition to register |=== + === ilm.removePolicy [source,js] ---- @@ -4182,6 +4375,7 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-remove-polic |`string` - The name of the index to remove policy on |=== + === ilm.retry [source,js] ---- @@ -4194,24 +4388,23 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-retry-policy |`string` - The name of the indices (comma-separated) whose failed lifecycle step is to be retry |=== + === ilm.start [source,js] ---- client.ilm.start([params] [, options] [, callback]) ---- https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-start.html -[cols=2*] -|=== -|=== + + === ilm.stop [source,js] ---- client.ilm.stop([params] [, options] [, callback]) ---- https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-stop.html -[cols=2*] -|=== -|=== + + === indices.freeze [source,js] ---- @@ -4237,12 +4430,13 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/frozen.html |`expand_wildcards` or `expandWildcards` |`'open', 'closed', 'none', 'all'` - Whether to expand wildcard expression to concrete indices that are open, closed or both. + - _Default:_ `closed` +_Default:_ `closed` |`wait_for_active_shards` or `waitForActiveShards` |`string` - Sets the number of active shards to wait for before the operation returns. |=== + === indices.unfreeze [source,js] ---- @@ -4268,12 +4462,13 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/frozen.html |`expand_wildcards` or `expandWildcards` |`'open', 'closed', 'none', 'all'` - Whether to expand wildcard expression to concrete indices that are open, closed or both. + - _Default:_ `closed` +_Default:_ `closed` |`wait_for_active_shards` or `waitForActiveShards` |`string` - Sets the number of active shards to wait for before the operation returns. |=== +<<<<<<< HEAD === xpack.graph.explore [source,js] ---- @@ -4442,6 +4637,10 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-up |=== === xpack.ml.closeJob +======= + +=== ml.closeJob +>>>>>>> ad6f56c... Doc updates (#791) [source,js] ---- client.xpack.ml.closeJob([params] [, options] [, callback]) @@ -4462,7 +4661,12 @@ http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-close-job.html |`string` - Controls the time to wait until a job has closed. Default to 30 minutes |=== +<<<<<<< HEAD === xpack.ml.deleteCalendar +======= + +=== ml.deleteCalendar +>>>>>>> ad6f56c... Doc updates (#791) [source,js] ---- client.xpack.ml.deleteCalendar([params] [, options] [, callback]) @@ -4474,7 +4678,12 @@ client.xpack.ml.deleteCalendar([params] [, options] [, callback]) |`string` - The ID of the calendar to delete |=== +<<<<<<< HEAD === xpack.ml.deleteCalendarEvent +======= + +=== ml.deleteCalendarEvent +>>>>>>> ad6f56c... Doc updates (#791) [source,js] ---- client.xpack.ml.deleteCalendarEvent([params] [, options] [, callback]) @@ -4489,7 +4698,12 @@ client.xpack.ml.deleteCalendarEvent([params] [, options] [, callback]) |`string` - The ID of the event to remove from the calendar |=== +<<<<<<< HEAD === xpack.ml.deleteCalendarJob +======= + +=== ml.deleteCalendarJob +>>>>>>> ad6f56c... Doc updates (#791) [source,js] ---- client.xpack.ml.deleteCalendarJob([params] [, options] [, callback]) @@ -4504,7 +4718,12 @@ client.xpack.ml.deleteCalendarJob([params] [, options] [, callback]) |`string` - The ID of the job to remove from the calendar |=== +<<<<<<< HEAD === xpack.ml.deleteDatafeed +======= + +=== ml.deleteDatafeed +>>>>>>> ad6f56c... Doc updates (#791) [source,js] ---- client.xpack.ml.deleteDatafeed([params] [, options] [, callback]) @@ -4519,16 +4738,27 @@ http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-datafee |`boolean` - True if the datafeed should be forcefully deleted |=== +<<<<<<< HEAD === xpack.ml.deleteExpiredData +======= + +=== ml.deleteExpiredData +>>>>>>> ad6f56c... Doc updates (#791) [source,js] ---- client.xpack.ml.deleteExpiredData([params] [, options] [, callback]) ---- +<<<<<<< HEAD [cols=2*] |=== |=== === xpack.ml.deleteFilter +======= + + +=== ml.deleteFilter +>>>>>>> ad6f56c... Doc updates (#791) [source,js] ---- client.xpack.ml.deleteFilter([params] [, options] [, callback]) @@ -4540,7 +4770,12 @@ client.xpack.ml.deleteFilter([params] [, options] [, callback]) |`string` - The ID of the filter to delete |=== +<<<<<<< HEAD === xpack.ml.deleteForecast +======= + +=== ml.deleteForecast +>>>>>>> ad6f56c... Doc updates (#791) [source,js] ---- client.xpack.ml.deleteForecast([params] [, options] [, callback]) @@ -4561,7 +4796,12 @@ http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-forecas |`string` - Controls the time to wait until the forecast(s) are deleted. Default to 30 seconds |=== +<<<<<<< HEAD === xpack.ml.deleteJob +======= + +=== ml.deleteJob +>>>>>>> ad6f56c... Doc updates (#791) [source,js] ---- client.xpack.ml.deleteJob([params] [, options] [, callback]) @@ -4577,10 +4817,15 @@ http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-job.htm |`wait_for_completion` or `waitForCompletion` |`boolean` - Should this request wait until the operation has completed before returning + - _Default:_ `true` +_Default:_ `true` |=== +<<<<<<< HEAD === xpack.ml.deleteModelSnapshot +======= + +=== ml.deleteModelSnapshot +>>>>>>> ad6f56c... Doc updates (#791) [source,js] ---- client.xpack.ml.deleteModelSnapshot([params] [, options] [, callback]) @@ -4595,7 +4840,12 @@ http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-snapsho |`string` - The ID of the snapshot to delete |=== +<<<<<<< HEAD === xpack.ml.findFileStructure +======= + +=== ml.findFileStructure +>>>>>>> ad6f56c... Doc updates (#791) [source,js] ---- client.xpack.ml.findFileStructure([params] [, options] [, callback]) @@ -4605,11 +4855,11 @@ http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-file-structure |=== |`lines_to_sample` or `linesToSample` |`number` - How many lines of the file should be included in the analysis + - _Default:_ `1000` +_Default:_ `1000` |`timeout` |`string` - Timeout after which the analysis will be aborted + - _Default:_ `25s` +_Default:_ `25s` |`charset` |`string` - Optional parameter to specify the character set of the file @@ -4648,7 +4898,12 @@ http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-file-structure |`object` - The contents of the file to be analyzed |=== +<<<<<<< HEAD === xpack.ml.flushJob +======= + +=== ml.flushJob +>>>>>>> ad6f56c... Doc updates (#791) [source,js] ---- client.xpack.ml.flushJob([params] [, options] [, callback]) @@ -4678,7 +4933,12 @@ http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-flush-job.html |`object` - Flush parameters |=== +<<<<<<< HEAD === xpack.ml.forecast +======= + +=== ml.forecast +>>>>>>> ad6f56c... Doc updates (#791) [source,js] ---- client.xpack.ml.forecast([params] [, options] [, callback]) @@ -4696,7 +4956,12 @@ client.xpack.ml.forecast([params] [, options] [, callback]) |`string` - The time interval after which the forecast expires. Expired forecasts will be deleted at the first opportunity. |=== +<<<<<<< HEAD === xpack.ml.getBuckets +======= + +=== ml.getBuckets +>>>>>>> ad6f56c... Doc updates (#791) [source,js] ---- client.xpack.ml.getBuckets([params] [, options] [, callback]) @@ -4741,7 +5006,12 @@ http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-bucket.htm |`object` - Bucket selection details if not provided in URI |=== +<<<<<<< HEAD === xpack.ml.getCalendarEvents +======= + +=== ml.getCalendarEvents +>>>>>>> ad6f56c... Doc updates (#791) [source,js] ---- client.xpack.ml.getCalendarEvents([params] [, options] [, callback]) @@ -4768,7 +5038,12 @@ client.xpack.ml.getCalendarEvents([params] [, options] [, callback]) |`number` - Specifies a max number of events to get |=== +<<<<<<< HEAD === xpack.ml.getCalendars +======= + +=== ml.getCalendars +>>>>>>> ad6f56c... Doc updates (#791) [source,js] ---- client.xpack.ml.getCalendars([params] [, options] [, callback]) @@ -4786,7 +5061,12 @@ client.xpack.ml.getCalendars([params] [, options] [, callback]) |`number` - specifies a max number of calendars to get |=== +<<<<<<< HEAD === xpack.ml.getCategories +======= + +=== ml.getCategories +>>>>>>> ad6f56c... Doc updates (#791) [source,js] ---- client.xpack.ml.getCategories([params] [, options] [, callback]) @@ -4810,7 +5090,12 @@ http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-category.h |`object` - Category selection details if not provided in URI |=== +<<<<<<< HEAD === xpack.ml.getDatafeedStats +======= + +=== ml.getDatafeedStats +>>>>>>> ad6f56c... Doc updates (#791) [source,js] ---- client.xpack.ml.getDatafeedStats([params] [, options] [, callback]) @@ -4825,7 +5110,12 @@ http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed-s |`boolean` - Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified) |=== +<<<<<<< HEAD === xpack.ml.getDatafeeds +======= + +=== ml.getDatafeeds +>>>>>>> ad6f56c... Doc updates (#791) [source,js] ---- client.xpack.ml.getDatafeeds([params] [, options] [, callback]) @@ -4840,7 +5130,12 @@ http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed.h |`boolean` - Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified) |=== +<<<<<<< HEAD === xpack.ml.getFilters +======= + +=== ml.getFilters +>>>>>>> ad6f56c... Doc updates (#791) [source,js] ---- client.xpack.ml.getFilters([params] [, options] [, callback]) @@ -4858,7 +5153,12 @@ client.xpack.ml.getFilters([params] [, options] [, callback]) |`number` - specifies a max number of filters to get |=== +<<<<<<< HEAD === xpack.ml.getInfluencers +======= + +=== ml.getInfluencers +>>>>>>> ad6f56c... Doc updates (#791) [source,js] ---- client.xpack.ml.getInfluencers([params] [, options] [, callback]) @@ -4897,7 +5197,12 @@ http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-influencer |`object` - Influencer selection criteria |=== +<<<<<<< HEAD === xpack.ml.getJobStats +======= + +=== ml.getJobStats +>>>>>>> ad6f56c... Doc updates (#791) [source,js] ---- client.xpack.ml.getJobStats([params] [, options] [, callback]) @@ -4912,7 +5217,12 @@ http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job-stats. |`boolean` - Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified) |=== +<<<<<<< HEAD === xpack.ml.getJobs +======= + +=== ml.getJobs +>>>>>>> ad6f56c... Doc updates (#791) [source,js] ---- client.xpack.ml.getJobs([params] [, options] [, callback]) @@ -4927,7 +5237,12 @@ http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job.html |`boolean` - Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified) |=== +<<<<<<< HEAD === xpack.ml.getModelSnapshots +======= + +=== ml.getModelSnapshots +>>>>>>> ad6f56c... Doc updates (#791) [source,js] ---- client.xpack.ml.getModelSnapshots([params] [, options] [, callback]) @@ -4963,7 +5278,12 @@ http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-snapshot.h |`object` - Model snapshot selection criteria |=== +<<<<<<< HEAD === xpack.ml.getOverallBuckets +======= + +=== ml.getOverallBuckets +>>>>>>> ad6f56c... Doc updates (#791) [source,js] ---- client.xpack.ml.getOverallBuckets([params] [, options] [, callback]) @@ -4999,7 +5319,12 @@ http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-overall-bu |`object` - Overall bucket selection details if not provided in URI |=== +<<<<<<< HEAD === xpack.ml.getRecords +======= + +=== ml.getRecords +>>>>>>> ad6f56c... Doc updates (#791) [source,js] ---- client.xpack.ml.getRecords([params] [, options] [, callback]) @@ -5038,16 +5363,27 @@ http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-record.htm |`object` - Record selection criteria |=== +<<<<<<< HEAD === xpack.ml.info +======= + +=== ml.info +>>>>>>> ad6f56c... Doc updates (#791) [source,js] ---- client.xpack.ml.info([params] [, options] [, callback]) ---- +<<<<<<< HEAD [cols=2*] |=== |=== === xpack.ml.openJob +======= + + +=== ml.openJob +>>>>>>> ad6f56c... Doc updates (#791) [source,js] ---- client.xpack.ml.openJob([params] [, options] [, callback]) @@ -5065,7 +5401,12 @@ http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-open-job.html |`string` - Controls the time to wait until a job has opened. Default to 30 minutes |=== +<<<<<<< HEAD === xpack.ml.postCalendarEvents +======= + +=== ml.postCalendarEvents +>>>>>>> ad6f56c... Doc updates (#791) [source,js] ---- client.xpack.ml.postCalendarEvents([params] [, options] [, callback]) @@ -5080,7 +5421,12 @@ client.xpack.ml.postCalendarEvents([params] [, options] [, callback]) |`object` - A list of events |=== +<<<<<<< HEAD === xpack.ml.postData +======= + +=== ml.postData +>>>>>>> ad6f56c... Doc updates (#791) [source,js] ---- client.xpack.ml.postData([params] [, options] [, callback]) @@ -5101,7 +5447,12 @@ http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-post-data.html |`object` - The data to process |=== +<<<<<<< HEAD === xpack.ml.previewDatafeed +======= + +=== ml.previewDatafeed +>>>>>>> ad6f56c... Doc updates (#791) [source,js] ---- client.xpack.ml.previewDatafeed([params] [, options] [, callback]) @@ -5113,7 +5464,12 @@ http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-preview-datafe |`string` - The ID of the datafeed to preview |=== +<<<<<<< HEAD === xpack.ml.putCalendar +======= + +=== ml.putCalendar +>>>>>>> ad6f56c... Doc updates (#791) [source,js] ---- client.xpack.ml.putCalendar([params] [, options] [, callback]) @@ -5128,7 +5484,12 @@ client.xpack.ml.putCalendar([params] [, options] [, callback]) |`object` - The calendar details |=== +<<<<<<< HEAD === xpack.ml.putCalendarJob +======= + +=== ml.putCalendarJob +>>>>>>> ad6f56c... Doc updates (#791) [source,js] ---- client.xpack.ml.putCalendarJob([params] [, options] [, callback]) @@ -5143,7 +5504,12 @@ client.xpack.ml.putCalendarJob([params] [, options] [, callback]) |`string` - The ID of the job to add to the calendar |=== +<<<<<<< HEAD === xpack.ml.putDatafeed +======= + +=== ml.putDatafeed +>>>>>>> ad6f56c... Doc updates (#791) [source,js] ---- client.xpack.ml.putDatafeed([params] [, options] [, callback]) @@ -5158,7 +5524,12 @@ http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-datafeed.h |`object` - The datafeed config |=== +<<<<<<< HEAD === xpack.ml.putFilter +======= + +=== ml.putFilter +>>>>>>> ad6f56c... Doc updates (#791) [source,js] ---- client.xpack.ml.putFilter([params] [, options] [, callback]) @@ -5173,7 +5544,12 @@ client.xpack.ml.putFilter([params] [, options] [, callback]) |`object` - The filter details |=== +<<<<<<< HEAD === xpack.ml.putJob +======= + +=== ml.putJob +>>>>>>> ad6f56c... Doc updates (#791) [source,js] ---- client.xpack.ml.putJob([params] [, options] [, callback]) @@ -5188,7 +5564,12 @@ http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-job.html |`object` - The job |=== +<<<<<<< HEAD === xpack.ml.revertModelSnapshot +======= + +=== ml.revertModelSnapshot +>>>>>>> ad6f56c... Doc updates (#791) [source,js] ---- client.xpack.ml.revertModelSnapshot([params] [, options] [, callback]) @@ -5209,7 +5590,28 @@ http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-revert-snapsho |`object` - Reversion options |=== +<<<<<<< HEAD === xpack.ml.startDatafeed +======= + +=== ml.setUpgradeMode +[source,js] +---- +client.ml.setUpgradeMode([params] [, options] [, callback]) +---- +http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-set-upgrade-mode.html +[cols=2*] +|=== +|`enabled` +|`boolean` - Whether to enable upgrade_mode ML setting or not. Defaults to false. + +|`timeout` +|`string` - Controls the time to wait before action times out. Defaults to 30 seconds + +|=== + +=== ml.startDatafeed +>>>>>>> ad6f56c... Doc updates (#791) [source,js] ---- client.xpack.ml.startDatafeed([params] [, options] [, callback]) @@ -5233,7 +5635,12 @@ http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-start-datafeed |`object` - The start datafeed parameters |=== +<<<<<<< HEAD === xpack.ml.stopDatafeed +======= + +=== ml.stopDatafeed +>>>>>>> ad6f56c... Doc updates (#791) [source,js] ---- client.xpack.ml.stopDatafeed([params] [, options] [, callback]) @@ -5254,7 +5661,12 @@ http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-stop-datafeed. |`string` - Controls the time to wait until a datafeed has stopped. Default to 20 seconds |=== +<<<<<<< HEAD === xpack.ml.updateDatafeed +======= + +=== ml.updateDatafeed +>>>>>>> ad6f56c... Doc updates (#791) [source,js] ---- client.xpack.ml.updateDatafeed([params] [, options] [, callback]) @@ -5269,7 +5681,12 @@ http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-datafee |`object` - The datafeed update settings |=== +<<<<<<< HEAD === xpack.ml.updateFilter +======= + +=== ml.updateFilter +>>>>>>> ad6f56c... Doc updates (#791) [source,js] ---- client.xpack.ml.updateFilter([params] [, options] [, callback]) @@ -5284,7 +5701,12 @@ client.xpack.ml.updateFilter([params] [, options] [, callback]) |`object` - The filter update |=== +<<<<<<< HEAD === xpack.ml.updateJob +======= + +=== ml.updateJob +>>>>>>> ad6f56c... Doc updates (#791) [source,js] ---- client.xpack.ml.updateJob([params] [, options] [, callback]) @@ -5299,7 +5721,12 @@ http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-job.htm |`object` - The job update settings |=== +<<<<<<< HEAD === xpack.ml.updateModelSnapshot +======= + +=== ml.updateModelSnapshot +>>>>>>> ad6f56c... Doc updates (#791) [source,js] ---- client.xpack.ml.updateModelSnapshot([params] [, options] [, callback]) @@ -5317,7 +5744,12 @@ http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-snapsho |`object` - The model snapshot properties to update |=== +<<<<<<< HEAD === xpack.ml.validate +======= + +=== ml.validate +>>>>>>> ad6f56c... Doc updates (#791) [source,js] ---- client.xpack.ml.validate([params] [, options] [, callback]) @@ -5329,7 +5761,12 @@ client.xpack.ml.validate([params] [, options] [, callback]) |`object` - The job config |=== +<<<<<<< HEAD === xpack.ml.validateDetector +======= + +=== ml.validateDetector +>>>>>>> ad6f56c... Doc updates (#791) [source,js] ---- client.xpack.ml.validateDetector([params] [, options] [, callback]) @@ -5341,7 +5778,12 @@ client.xpack.ml.validateDetector([params] [, options] [, callback]) |`object` - The detector |=== +<<<<<<< HEAD === xpack.monitoring.bulk +======= + +=== monitoring.bulk +>>>>>>> ad6f56c... Doc updates (#791) [source,js] ---- client.xpack.monitoring.bulk([params] [, options] [, callback]) @@ -5365,11 +5807,17 @@ http://www.elastic.co/guide/en/monitoring/current/appendix-api-bulk.html |`object` - The operation definition and data (action-data pairs), separated by newlines |=== +<<<<<<< HEAD === xpack.rollup.deleteJob +======= + +=== security.authenticate +>>>>>>> ad6f56c... Doc updates (#791) [source,js] ---- client.xpack.rollup.deleteJob([params] [, options] [, callback]) ---- +<<<<<<< HEAD [cols=2*] |=== @@ -5378,6 +5826,12 @@ client.xpack.rollup.deleteJob([params] [, options] [, callback]) |=== === xpack.rollup.getJobs +======= +https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-authenticate.html + + +=== security.changePassword +>>>>>>> ad6f56c... Doc updates (#791) [source,js] ---- client.xpack.rollup.getJobs([params] [, options] [, callback]) @@ -5389,7 +5843,12 @@ client.xpack.rollup.getJobs([params] [, options] [, callback]) |`string` - The ID of the job(s) to fetch. Accepts glob patterns, or left blank for all jobs |=== +<<<<<<< HEAD === xpack.rollup.getRollupCaps +======= + +=== security.clearCachedRealms +>>>>>>> ad6f56c... Doc updates (#791) [source,js] ---- client.xpack.rollup.getRollupCaps([params] [, options] [, callback]) @@ -5401,7 +5860,12 @@ client.xpack.rollup.getRollupCaps([params] [, options] [, callback]) |`string` - The ID of the index to check rollup capabilities on, or left blank for all jobs |=== +<<<<<<< HEAD === xpack.rollup.getRollupIndexCaps +======= + +=== security.clearCachedRoles +>>>>>>> ad6f56c... Doc updates (#791) [source,js] ---- client.xpack.rollup.getRollupIndexCaps([params] [, options] [, callback]) @@ -5413,7 +5877,12 @@ client.xpack.rollup.getRollupIndexCaps([params] [, options] [, callback]) |`string` - The rollup index or index pattern to obtain rollup capabilities from. |=== +<<<<<<< HEAD === xpack.rollup.putJob +======= + +=== security.createApiKey +>>>>>>> ad6f56c... Doc updates (#791) [source,js] ---- client.xpack.rollup.putJob([params] [, options] [, callback]) @@ -5521,7 +5990,12 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-cle |`string, string[]` - Comma-separated list of usernames to clear from the cache |=== +<<<<<<< HEAD === xpack.security.clearCachedRoles +======= + +=== security.deletePrivileges +>>>>>>> ad6f56c... Doc updates (#791) [source,js] ---- client.xpack.security.clearCachedRoles([params] [, options] [, callback]) @@ -5551,7 +6025,12 @@ TODO |`'true', 'false', 'wait_for'` - If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. |=== +<<<<<<< HEAD === xpack.security.deleteRole +======= + +=== security.deleteRole +>>>>>>> ad6f56c... Doc updates (#791) [source,js] ---- client.xpack.security.deleteRole([params] [, options] [, callback]) @@ -5566,7 +6045,12 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-del |`'true', 'false', 'wait_for'` - If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. |=== +<<<<<<< HEAD === xpack.security.deleteRoleMapping +======= + +=== security.deleteRoleMapping +>>>>>>> ad6f56c... Doc updates (#791) [source,js] ---- client.xpack.security.deleteRoleMapping([params] [, options] [, callback]) @@ -5581,7 +6065,12 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-del |`'true', 'false', 'wait_for'` - If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. |=== +<<<<<<< HEAD === xpack.security.deleteUser +======= + +=== security.deleteUser +>>>>>>> ad6f56c... Doc updates (#791) [source,js] ---- client.xpack.security.deleteUser([params] [, options] [, callback]) @@ -5596,7 +6085,12 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-del |`'true', 'false', 'wait_for'` - If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. |=== +<<<<<<< HEAD === xpack.security.disableUser +======= + +=== security.disableUser +>>>>>>> ad6f56c... Doc updates (#791) [source,js] ---- client.xpack.security.disableUser([params] [, options] [, callback]) @@ -5611,7 +6105,12 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-dis |`'true', 'false', 'wait_for'` - If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. |=== +<<<<<<< HEAD === xpack.security.enableUser +======= + +=== security.enableUser +>>>>>>> ad6f56c... Doc updates (#791) [source,js] ---- client.xpack.security.enableUser([params] [, options] [, callback]) @@ -5626,7 +6125,34 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-ena |`'true', 'false', 'wait_for'` - If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. |=== +<<<<<<< HEAD === xpack.security.getPrivileges +======= + +=== security.getApiKey +[source,js] +---- +client.security.getApiKey([params] [, options] [, callback]) +---- +https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-api-key.html +[cols=2*] +|=== +|`id` +|`string` - API key id of the API key to be retrieved + +|`name` +|`string` - API key name of the API key to be retrieved + +|`username` +|`string` - user name of the user who created this API key to be retrieved + +|`realm_name` or `realmName` +|`string` - realm name of the user who created this API key to be retrieved + +|=== + +=== security.getPrivileges +>>>>>>> ad6f56c... Doc updates (#791) [source,js] ---- client.xpack.security.getPrivileges([params] [, options] [, callback]) @@ -5641,7 +6167,12 @@ TODO |`string` - Privilege name |=== +<<<<<<< HEAD === xpack.security.getRole +======= + +=== security.getRole +>>>>>>> ad6f56c... Doc updates (#791) [source,js] ---- client.xpack.security.getRole([params] [, options] [, callback]) @@ -5653,7 +6184,12 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get |`string` - Role name |=== +<<<<<<< HEAD === xpack.security.getRoleMapping +======= + +=== security.getRoleMapping +>>>>>>> ad6f56c... Doc updates (#791) [source,js] ---- client.xpack.security.getRoleMapping([params] [, options] [, callback]) @@ -5665,7 +6201,12 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get |`string` - Role-Mapping name |=== +<<<<<<< HEAD === xpack.security.getToken +======= + +=== security.getToken +>>>>>>> ad6f56c... Doc updates (#791) [source,js] ---- client.xpack.security.getToken([params] [, options] [, callback]) @@ -5677,7 +6218,12 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get |`object` - The token request to get |=== +<<<<<<< HEAD === xpack.security.getUser +======= + +=== security.getUser +>>>>>>> ad6f56c... Doc updates (#791) [source,js] ---- client.xpack.security.getUser([params] [, options] [, callback]) @@ -5689,16 +6235,27 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get |`string, string[]` - A comma-separated list of usernames |=== +<<<<<<< HEAD === xpack.security.getUserPrivileges +======= + +=== security.getUserPrivileges +>>>>>>> ad6f56c... Doc updates (#791) [source,js] ---- client.xpack.security.getUserPrivileges([params] [, options] [, callback]) ---- https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-user-privileges.html +<<<<<<< HEAD [cols=2*] |=== |=== === xpack.security.hasPrivileges +======= + + +=== security.hasPrivileges +>>>>>>> ad6f56c... Doc updates (#791) [source,js] ---- client.xpack.security.hasPrivileges([params] [, options] [, callback]) @@ -5713,10 +6270,31 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-has |`object` - The privileges to test |=== +<<<<<<< HEAD === xpack.security.invalidateToken [source,js] ---- client.xpack.security.invalidateToken([params] [, options] [, callback]) +======= + +=== security.invalidateApiKey +[source,js] +---- +client.security.invalidateApiKey([params] [, options] [, callback]) +---- +https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-invalidate-api-key.html +[cols=2*] +|=== +|`body` +|`object` - The api key request to invalidate API key(s) + +|=== + +=== security.invalidateToken +[source,js] +---- +client.security.invalidateToken([params] [, options] [, callback]) +>>>>>>> ad6f56c... Doc updates (#791) ---- https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-invalidate-token.html [cols=2*] @@ -5725,7 +6303,12 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-inv |`object` - The token to invalidate |=== +<<<<<<< HEAD === xpack.security.putPrivileges +======= + +=== security.putPrivileges +>>>>>>> ad6f56c... Doc updates (#791) [source,js] ---- client.xpack.security.putPrivileges([params] [, options] [, callback]) @@ -5740,7 +6323,12 @@ TODO |`object` - The privilege(s) to add |=== +<<<<<<< HEAD === xpack.security.putRole +======= + +=== security.putRole +>>>>>>> ad6f56c... Doc updates (#791) [source,js] ---- client.xpack.security.putRole([params] [, options] [, callback]) @@ -5758,7 +6346,12 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put |`object` - The role to add |=== +<<<<<<< HEAD === xpack.security.putRoleMapping +======= + +=== security.putRoleMapping +>>>>>>> ad6f56c... Doc updates (#791) [source,js] ---- client.xpack.security.putRoleMapping([params] [, options] [, callback]) @@ -5776,7 +6369,12 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put |`object` - The role to add |=== +<<<<<<< HEAD === xpack.security.putUser +======= + +=== security.putUser +>>>>>>> ad6f56c... Doc updates (#791) [source,js] ---- client.xpack.security.putUser([params] [, options] [, callback]) @@ -5794,6 +6392,316 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put |`object` - The user to add |=== +<<<<<<< HEAD +======= + +=== ssl.certificates +[source,js] +---- +client.ssl.certificates([params] [, options] [, callback]) +---- +https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-ssl.html + + +=== xpack.graph.explore +[source,js] +---- +client.xpack.graph.explore([params] [, options] [, callback]) +---- +https://www.elastic.co/guide/en/elasticsearch/reference/current/graph-explore-api.html +[cols=2*] +|=== +|`index` +|`string, string[]` - A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices + +|`type` +|`string, string[]` - A comma-separated list of document types to search; leave empty to perform the operation on all types + +|`routing` +|`string` - Specific routing value + +|`timeout` +|`string` - Explicit operation timeout + +|`body` +|`object` - Graph Query DSL + +|=== + +=== xpack.info +[source,js] +---- +client.xpack.info([params] [, options] [, callback]) +---- +https://www.elastic.co/guide/en/elasticsearch/reference/current/info-api.html +[cols=2*] +|=== +|`categories` +|`string, string[]` - Comma-separated list of info categories. Can be any of: build, license, features + +|=== + +=== xpack.license.delete +[source,js] +---- +client.xpack.license.delete([params] [, options] [, callback]) +---- +https://www.elastic.co/guide/en/x-pack/current/license-management.html + + +=== xpack.license.get +[source,js] +---- +client.xpack.license.get([params] [, options] [, callback]) +---- +https://www.elastic.co/guide/en/x-pack/current/license-management.html +[cols=2*] +|=== +|`local` +|`boolean` - Return local information, do not retrieve the state from master node (default: false) + +|=== + +=== xpack.license.getBasicStatus +[source,js] +---- +client.xpack.license.getBasicStatus([params] [, options] [, callback]) +---- +https://www.elastic.co/guide/en/x-pack/current/license-management.html + + +=== xpack.license.getTrialStatus +[source,js] +---- +client.xpack.license.getTrialStatus([params] [, options] [, callback]) +---- +https://www.elastic.co/guide/en/x-pack/current/license-management.html + + +=== xpack.license.post +[source,js] +---- +client.xpack.license.post([params] [, options] [, callback]) +---- +https://www.elastic.co/guide/en/x-pack/current/license-management.html +[cols=2*] +|=== +|`acknowledge` +|`boolean` - whether the user has acknowledged acknowledge messages (default: false) + +|`body` +|`object` - licenses to be installed + +|=== + +=== xpack.license.postStartBasic +[source,js] +---- +client.xpack.license.postStartBasic([params] [, options] [, callback]) +---- +https://www.elastic.co/guide/en/x-pack/current/license-management.html +[cols=2*] +|=== +|`acknowledge` +|`boolean` - whether the user has acknowledged acknowledge messages (default: false) + +|=== + +=== xpack.license.postStartTrial +[source,js] +---- +client.xpack.license.postStartTrial([params] [, options] [, callback]) +---- +https://www.elastic.co/guide/en/x-pack/current/license-management.html +[cols=2*] +|=== +|`type` +|`string` - The type of trial license to generate (default: "trial") + +|`acknowledge` +|`boolean` - whether the user has acknowledged acknowledge messages (default: false) + +|=== + +=== xpack.migration.deprecations +[source,js] +---- +client.xpack.migration.deprecations([params] [, options] [, callback]) +---- +http://www.elastic.co/guide/en/migration/current/migration-api-deprecation.html +[cols=2*] +|=== +|`index` +|`string` - Index pattern + +|=== + +=== xpack.migration.getAssistance +[source,js] +---- +client.xpack.migration.getAssistance([params] [, options] [, callback]) +---- +https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-assistance.html +[cols=2*] +|=== +|`index` +|`string, string[]` - A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices + +|`allow_no_indices` or `allowNoIndices` +|`boolean` - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) + +|`expand_wildcards` or `expandWildcards` +|`'open', 'closed', 'none', 'all'` - Whether to expand wildcard expression to concrete indices that are open, closed or both. + +_Default:_ `open` + +|`ignore_unavailable` or `ignoreUnavailable` +|`boolean` - Whether specified concrete indices should be ignored when unavailable (missing or closed) + +|=== + +=== xpack.migration.upgrade +[source,js] +---- +client.xpack.migration.upgrade([params] [, options] [, callback]) +---- +https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-upgrade.html +[cols=2*] +|=== +|`index` +|`string` - The name of the index + +|`wait_for_completion` or `waitForCompletion` +|`boolean` - Should the request block until the upgrade operation is completed + +_Default:_ `true` + +|=== + +=== xpack.rollup.deleteJob +[source,js] +---- +client.xpack.rollup.deleteJob([params] [, options] [, callback]) +---- + +[cols=2*] +|=== +|`id` +|`string` - The ID of the job to delete + +|=== + +=== xpack.rollup.getJobs +[source,js] +---- +client.xpack.rollup.getJobs([params] [, options] [, callback]) +---- + +[cols=2*] +|=== +|`id` +|`string` - The ID of the job(s) to fetch. Accepts glob patterns, or left blank for all jobs + +|=== + +=== xpack.rollup.getRollupCaps +[source,js] +---- +client.xpack.rollup.getRollupCaps([params] [, options] [, callback]) +---- + +[cols=2*] +|=== +|`id` +|`string` - The ID of the index to check rollup capabilities on, or left blank for all jobs + +|=== + +=== xpack.rollup.getRollupIndexCaps +[source,js] +---- +client.xpack.rollup.getRollupIndexCaps([params] [, options] [, callback]) +---- + +[cols=2*] +|=== +|`index` +|`string` - The rollup index or index pattern to obtain rollup capabilities from. + +|=== + +=== xpack.rollup.putJob +[source,js] +---- +client.xpack.rollup.putJob([params] [, options] [, callback]) +---- + +[cols=2*] +|=== +|`id` +|`string` - The ID of the job to create + +|`body` +|`object` - The job configuration + +|=== + +=== xpack.rollup.rollupSearch +[source,js] +---- +client.xpack.rollup.rollupSearch([params] [, options] [, callback]) +---- + +[cols=2*] +|=== +|`index` +|`string` - The index or index-pattern (containing rollup or regular data) that should be searched + +|`type` +|`string` - The doc type inside the index + +|`typed_keys` or `typedKeys` +|`boolean` - Specify whether aggregation and suggester names should be prefixed by their respective types in the response + +|`rest_total_hits_as_int` or `restTotalHitsAsInt` +|`boolean` - Indicates whether hits.total should be rendered as an integer or an object in the rest search response + +|`body` +|`object` - The search request body + +|=== + +=== xpack.rollup.startJob +[source,js] +---- +client.xpack.rollup.startJob([params] [, options] [, callback]) +---- + +[cols=2*] +|=== +|`id` +|`string` - The ID of the job to start + +|=== + +=== xpack.rollup.stopJob +[source,js] +---- +client.xpack.rollup.stopJob([params] [, options] [, callback]) +---- + +[cols=2*] +|=== +|`id` +|`string` - The ID of the job to stop + +|`wait_for_completion` or `waitForCompletion` +|`boolean` - True if the API should block until the job has fully stopped, false if should be executed async. Defaults to false. + +|`timeout` +|`string` - Block for (at maximum) the specified duration while waiting for the job to stop. Defaults to 30s. + +|=== + +>>>>>>> ad6f56c... Doc updates (#791) === xpack.sql.clearCursor [source,js] ---- @@ -5806,6 +6714,7 @@ Clear SQL cursor |`object` - Specify the cursor value in the `cursor` element to clean the cursor. |=== + === xpack.sql.query [source,js] ---- @@ -5821,6 +6730,7 @@ Execute SQL |`object` - Use the `query` element to start a query. Use the `cursor` element to continue a query. |=== + === xpack.sql.translate [source,js] ---- @@ -5833,6 +6743,7 @@ Translate SQL into Elasticsearch queries |`object` - Specify the query in the `query` element. |=== +<<<<<<< HEAD === xpack.ssl.certificates [source,js] ---- @@ -5842,6 +6753,9 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-ssl [cols=2*] |=== |=== +======= + +>>>>>>> ad6f56c... Doc updates (#791) === xpack.usage [source,js] ---- @@ -5854,6 +6768,7 @@ Retrieve information about xpack features usage |`string` - Specify timeout for watch write operation |=== + === xpack.watcher.ackWatch [source,js] ---- @@ -5872,6 +6787,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-ack-w |`string` - Explicit operation timeout for connection to master node |=== + === xpack.watcher.activateWatch [source,js] ---- @@ -5887,6 +6803,7 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-acti |`string` - Explicit operation timeout for connection to master node |=== + === xpack.watcher.deactivateWatch [source,js] ---- @@ -5902,6 +6819,7 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-deac |`string` - Explicit operation timeout for connection to master node |=== + === xpack.watcher.deleteWatch [source,js] ---- @@ -5917,6 +6835,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-delet |`string` - Explicit operation timeout for connection to master node |=== + === xpack.watcher.executeWatch [source,js] ---- @@ -5935,6 +6854,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-execu |`object` - Execution control |=== + === xpack.watcher.getWatch [source,js] ---- @@ -5947,6 +6867,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-get-w |`string` - Watch ID |=== + === xpack.watcher.putWatch [source,js] ---- @@ -5971,6 +6892,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-put-w |`object` - The watch |=== +<<<<<<< HEAD === xpack.watcher.restart [source,js] ---- @@ -5980,15 +6902,17 @@ http://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-resta [cols=2*] |=== |=== +======= + +>>>>>>> ad6f56c... Doc updates (#791) === xpack.watcher.start [source,js] ---- client.xpack.watcher.start([params] [, options] [, callback]) ---- http://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-start.html -[cols=2*] -|=== -|=== + + === xpack.watcher.stats [source,js] ---- @@ -6007,12 +6931,11 @@ http://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-stats |`boolean` - Emits stack traces of currently running watches |=== + === xpack.watcher.stop [source,js] ---- client.xpack.watcher.stop([params] [, options] [, callback]) ---- http://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-stop.html -[cols=2*] -|=== -|=== \ No newline at end of file + diff --git a/docs/typescript.asciidoc b/docs/typescript.asciidoc index 94148a5cd..85f06d5b6 100644 --- a/docs/typescript.asciidoc +++ b/docs/typescript.asciidoc @@ -1,4 +1,4 @@ -= TypeScript support +== TypeScript support The client offers a first-class support for TypeScript, since it ships the type definitions for every exposed API. @@ -6,7 +6,7 @@ While the client offers type definitions for Request parameters, Request bodies NOTE: If you are using TypeScript you will be required to use _snake_case_ style to define the API parameters instead of _camelCase_. -== How to extend the provided typings? +=== How to extend the provided typings? Extend the provided typings is very straightforward, you should declare a custom `.d.ts` file and then write inside your type extensions, following there is an example of how do it. [source,ts] ---- diff --git a/docs/usage.asciidoc b/docs/usage.asciidoc index 07441e78d..ea0c39649 100644 --- a/docs/usage.asciidoc +++ b/docs/usage.asciidoc @@ -1,4 +1,4 @@ -= Usage +== Usage Use the client is pretty straightforward, it supports all the public APIs of Elasticsearch, and every method exposes the same signature. diff --git a/scripts/utils/generateDocs.js b/scripts/utils/generateDocs.js index b0f34f3f5..49519ad9e 100644 --- a/scripts/utils/generateDocs.js +++ b/scripts/utils/generateDocs.js @@ -22,7 +22,15 @@ const dedent = require('dedent') function generateDocs (common, spec) { - var doc = '= API Reference\n\n' + var doc = dedent` + == API Reference + + //////// + + This documentation is generated by running: + node scripts/run.js --tag v7.0.0-beta + + ////////\n\n` doc += commonParameters(common) spec.forEach(s => { doc += '\n' + generateApiDoc(s) @@ -105,27 +113,29 @@ function generateApiDoc (spec) { ---- client.${camelify(name)}([params] [, options] [, callback]) ---- - ${documentationUrl || ''} - [cols=2*] - |===` + ${documentationUrl || ''}\n` - doc += '\n' + params.reduce((acc, val) => { - const name = isSnakeCased(val.name) && val.name !== camelify(val.name) - ? '`' + val.name + '` or `' + camelify(val.name) + '`' - : '`' + val.name + '`' - acc += dedent` - |${name} - |${'`' + val.type + '`'} - ${val.description}` - if (val.default) { - acc += ` + - _Default:_ ${'`' + val.default + '`'}` - } - return acc + '\n\n' - }, '') + if (params.length !== 0) { + doc += dedent`[cols=2*] + |===\n` + doc += params.reduce((acc, val) => { + const name = isSnakeCased(val.name) && val.name !== camelify(val.name) + ? '`' + val.name + '` or `' + camelify(val.name) + '`' + : '`' + val.name + '`' + acc += dedent` + |${name} + |${'`' + val.type + '`'} - ${val.description}` + if (val.default) { + acc += ` +\n_Default:_ ${'`' + val.default + '`'}` + } + return acc + '\n\n' + }, '') - doc += dedent` - |=== - ` + doc += dedent` + |=== + ` + } + doc += '\n' return doc }