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

[docs] label timestamp/duration types differently

Browse Source
This commit is contained in:
spalger
2016-11-16 12:29:56 -07:00
parent 212a2aa9b0
commit 29eb81a52c
33 changed files with 2429 additions and 2428 deletions
Download Patch File Download Diff File Expand all files Collapse all files

194
docs/api_methods.asciidoc
View File

@ -56,7 +56,7 @@ Options:::
`routing`::
`String` -- Specific routing value
`timeout`::
`Date, Number` -- Explicit operation timeout
`DurationString` -- Explicit operation timeout
`type`::
`String` -- Default document type for items which don't provide one
`fields`::
@ -304,11 +304,11 @@ Options:::
`routing`::
`String` -- Specific routing value
`timeout`::
`Date, Number` -- Explicit operation timeout
`DurationString` -- Explicit operation timeout
`timestamp`::
`Date, Number` -- Explicit timestamp for the document
`Timestamp` -- Explicit timestamp for the document
`ttl`::
`Date, Number` -- Expiration time for the document
`DurationString` -- Expiration time for the document
`version`::
`Number` -- Explicit version number for concurrency control
`versionType`::
@ -373,7 +373,7 @@ Options:::
`routing`::
`String` -- Specific routing value
`timeout`::
`Date, Number` -- Explicit operation timeout
`DurationString` -- Explicit operation timeout
`version`::
`Number` -- Explicit version number for concurrency control
`versionType`::
@ -478,7 +478,7 @@ Options:::
`routing`::
`String, String[], Boolean` -- A comma-separated list of specific routing values
`scroll`::
`Date, Number` -- Specify how long a consistent view of the index should be maintained for scrolled search
`DurationString` -- Specify how long a consistent view of the index should be maintained for scrolled search
`searchType`::
`String` -- Search operation type
Options:::
@ -486,7 +486,7 @@ Options:::
* `"dfs_query_then_fetch"`
`searchTimeout`::
`Date, Number` -- Explicit timeout for each search request. Defaults to no timeout.
`DurationString` -- Explicit timeout for each search request. Defaults to no timeout.
`size`::
`Number` -- Number of hits to return (default: 10)
`sort`::
@ -508,7 +508,7 @@ Options:::
`refresh`::
`Boolean` -- Should the effected indexes be refreshed?
`[timeout=1m]`::
`Date, Number` -- Time each individual bulk request should wait for shards that are unavailable.
`DurationString` -- Time each individual bulk request should wait for shards that are unavailable.
`waitForActiveShards`::
`String` -- Sets the number of shard copies that must be active before proceeding with the delete by query operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)
`scrollSize`::
@ -982,11 +982,11 @@ Options:::
`routing`::
`String` -- Specific routing value
`timeout`::
`Date, Number` -- Explicit operation timeout
`DurationString` -- Explicit operation timeout
`timestamp`::
`Date, Number` -- Explicit timestamp for the document
`Timestamp` -- Explicit timestamp for the document
`ttl`::
`Date, Number` -- Expiration time for the document
`DurationString` -- Expiration time for the document
`version`::
`Number` -- Explicit version number for concurrency control
`versionType`::
@ -1494,7 +1494,7 @@ The default method is `POST` and the usual <<api-conventions,params and return v
`refresh`::
`Boolean` -- Should the effected indexes be refreshed?
`[timeout=1m]`::
`Date, Number` -- Time each individual bulk request should wait for shards that are unavailable.
`DurationString` -- Time each individual bulk request should wait for shards that are unavailable.
`waitForActiveShards`::
`String` -- Sets the number of shard copies that must be active before proceeding with the 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)
`waitForCompletion`::
@ -1599,7 +1599,7 @@ client.search({
[horizontal]
`scroll`::
`Date, Number` -- Specify how long a consistent view of the index should be maintained for scrolled search
`DurationString` -- Specify how long a consistent view of the index should be maintained for scrolled search
`scrollId`::
`String` -- The scroll ID
@ -1705,7 +1705,7 @@ Options:::
`routing`::
`String, String[], Boolean` -- A comma-separated list of specific routing values
`scroll`::
`Date, Number` -- Specify how long a consistent view of the index should be maintained for scrolled search
`DurationString` -- Specify how long a consistent view of the index should be maintained for scrolled search
`searchType`::
`String` -- Search operation type
Options:::
@ -1740,7 +1740,7 @@ Options:::
`suggestText`::
`String` -- The source text for which the suggestions should be returned
`timeout`::
`Date, Number` -- Explicit operation timeout
`DurationString` -- Explicit operation timeout
`trackScores`::
`Boolean` -- Whether to calculate and return scores even if they are not used for sorting
`version`::
@ -1832,7 +1832,7 @@ Options:::
`routing`::
`String, String[], Boolean` -- A comma-separated list of specific routing values
`scroll`::
`Date, Number` -- Specify how long a consistent view of the index should be maintained for scrolled search
`DurationString` -- Specify how long a consistent view of the index should be maintained for scrolled search
`searchType`::
`String` -- Search operation type
Options:::
@ -2093,11 +2093,11 @@ Options:::
`routing`::
`String` -- Specific routing value
`timeout`::
`Date, Number` -- Explicit operation timeout
`DurationString` -- Explicit operation timeout
`timestamp`::
`Date, Number` -- Explicit timestamp for the document
`Timestamp` -- Explicit timestamp for the document
`ttl`::
`Date, Number` -- Expiration time for the document
`DurationString` -- Expiration time for the document
`version`::
`Number` -- Explicit version number for concurrency control
`versionType`::
@ -2178,7 +2178,7 @@ Options:::
`routing`::
`String, String[], Boolean` -- A comma-separated list of specific routing values
`scroll`::
`Date, Number` -- Specify how long a consistent view of the index should be maintained for scrolled search
`DurationString` -- Specify how long a consistent view of the index should be maintained for scrolled search
`searchType`::
`String` -- Search operation type
Options:::
@ -2186,7 +2186,7 @@ Options:::
* `"dfs_query_then_fetch"`
`searchTimeout`::
`Date, Number` -- Explicit timeout for each search request. Defaults to no timeout.
`DurationString` -- Explicit timeout for each search request. Defaults to no timeout.
`size`::
`Number` -- Number of hits to return (default: 10)
`sort`::
@ -2210,7 +2210,7 @@ Options:::
`refresh`::
`Boolean` -- Should the effected indexes be refreshed?
`[timeout=1m]`::
`Date, Number` -- Time each individual bulk request should wait for shards that are unavailable.
`DurationString` -- Time each individual bulk request should wait for shards that are unavailable.
`waitForActiveShards`::
`String` -- Sets the number of shard copies that must be active before proceeding with the 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)
`scrollSize`::
@ -2249,7 +2249,7 @@ The default method is `GET` and the usual <<api-conventions,params and return va
`local`::
`Boolean` -- Return local information, do not retrieve the state from master node (default: false)
`masterTimeout`::
`Date, Number` -- Explicit operation timeout for connection to master node
`DurationString` -- Explicit operation timeout for connection to master node
`h`::
`String, String[], Boolean` -- Comma-separated list of column names to display
`help`::
@ -2299,7 +2299,7 @@ Options:::
`local`::
`Boolean` -- Return local information, do not retrieve the state from master node (default: false)
`masterTimeout`::
`Date, Number` -- Explicit operation timeout for connection to master node
`DurationString` -- Explicit operation timeout for connection to master node
`h`::
`String, String[], Boolean` -- Comma-separated list of column names to display
`help`::
@ -2334,7 +2334,7 @@ The default method is `GET` and the usual <<api-conventions,params and return va
`local`::
`Boolean` -- Return local information, do not retrieve the state from master node (default: false)
`masterTimeout`::
`Date, Number` -- Explicit operation timeout for connection to master node
`DurationString` -- Explicit operation timeout for connection to master node
`h`::
`String, String[], Boolean` -- Comma-separated list of column names to display
`help`::
@ -2384,7 +2384,7 @@ Options:::
`local`::
`Boolean` -- Return local information, do not retrieve the state from master node (default: false)
`masterTimeout`::
`Date, Number` -- Explicit operation timeout for connection to master node
`DurationString` -- Explicit operation timeout for connection to master node
`h`::
`String, String[], Boolean` -- Comma-separated list of column names to display
`help`::
@ -2419,7 +2419,7 @@ The default method is `GET` and the usual <<api-conventions,params and return va
`local`::
`Boolean` -- Return local information, do not retrieve the state from master node (default: false)
`masterTimeout`::
`Date, Number` -- Explicit operation timeout for connection to master node
`DurationString` -- Explicit operation timeout for connection to master node
`h`::
`String, String[], Boolean` -- Comma-separated list of column names to display
`help`::
@ -2485,7 +2485,7 @@ Options:::
`local`::
`Boolean` -- Return local information, do not retrieve the state from master node (default: false)
`masterTimeout`::
`Date, Number` -- Explicit operation timeout for connection to master node
`DurationString` -- Explicit operation timeout for connection to master node
`h`::
`String, String[], Boolean` -- Comma-separated list of column names to display
`health`::
@ -2529,7 +2529,7 @@ The default method is `GET` and the usual <<api-conventions,params and return va
`local`::
`Boolean` -- Return local information, do not retrieve the state from master node (default: false)
`masterTimeout`::
`Date, Number` -- Explicit operation timeout for connection to master node
`DurationString` -- Explicit operation timeout for connection to master node
`h`::
`String, String[], Boolean` -- Comma-separated list of column names to display
`help`::
@ -2562,7 +2562,7 @@ The default method is `GET` and the usual <<api-conventions,params and return va
`local`::
`Boolean` -- Return local information, do not retrieve the state from master node (default: false)
`masterTimeout`::
`Date, Number` -- Explicit operation timeout for connection to master node
`DurationString` -- Explicit operation timeout for connection to master node
`h`::
`String, String[], Boolean` -- Comma-separated list of column names to display
`help`::
@ -2597,7 +2597,7 @@ The default method is `GET` and the usual <<api-conventions,params and return va
`local`::
`Boolean` -- Return local information, do not retrieve the state from master node (default: false)
`masterTimeout`::
`Date, Number` -- Explicit operation timeout for connection to master node
`DurationString` -- Explicit operation timeout for connection to master node
`h`::
`String, String[], Boolean` -- Comma-separated list of column names to display
`help`::
@ -2630,7 +2630,7 @@ The default method is `GET` and the usual <<api-conventions,params and return va
`local`::
`Boolean` -- Return local information, do not retrieve the state from master node (default: false)
`masterTimeout`::
`Date, Number` -- Explicit operation timeout for connection to master node
`DurationString` -- Explicit operation timeout for connection to master node
`h`::
`String, String[], Boolean` -- Comma-separated list of column names to display
`help`::
@ -2663,7 +2663,7 @@ The default method is `GET` and the usual <<api-conventions,params and return va
`local`::
`Boolean` -- Return local information, do not retrieve the state from master node (default: false)
`masterTimeout`::
`Date, Number` -- Explicit operation timeout for connection to master node
`DurationString` -- Explicit operation timeout for connection to master node
`h`::
`String, String[], Boolean` -- Comma-separated list of column names to display
`help`::
@ -2709,7 +2709,7 @@ Options:::
* `"pb"`
`masterTimeout`::
`Date, Number` -- Explicit operation timeout for connection to master node
`DurationString` -- Explicit operation timeout for connection to master node
`h`::
`String, String[], Boolean` -- Comma-separated list of column names to display
`help`::
@ -2744,7 +2744,7 @@ The default method is `GET` and the usual <<api-conventions,params and return va
`local`::
`Boolean` -- Return local information, do not retrieve the state from master node
`masterTimeout`::
`Date, Number` -- Explicit operation timeout for connection to master node
`DurationString` -- Explicit operation timeout for connection to master node
`h`::
`String, String[], Boolean` -- Comma-separated list of column names to display
`help`::
@ -2808,7 +2808,7 @@ The default method is `GET` and the usual <<api-conventions,params and return va
`local`::
`Boolean` -- Return local information, do not retrieve the state from master node (default: false)
`masterTimeout`::
`Date, Number` -- Explicit operation timeout for connection to master node
`DurationString` -- Explicit operation timeout for connection to master node
`h`::
`String, String[], Boolean` -- Comma-separated list of column names to display
`help`::
@ -2843,7 +2843,7 @@ The default method is `GET` and the usual <<api-conventions,params and return va
`ignoreUnavailable`::
`Boolean` -- Set to true to ignore unavailable snapshots
`masterTimeout`::
`Date, Number` -- Explicit operation timeout for connection to master node
`DurationString` -- Explicit operation timeout for connection to master node
`h`::
`String, String[], Boolean` -- Comma-separated list of column names to display
`help`::
@ -2927,7 +2927,7 @@ Options:::
`local`::
`Boolean` -- Return local information, do not retrieve the state from master node (default: false)
`masterTimeout`::
`Date, Number` -- Explicit operation timeout for connection to master node
`DurationString` -- Explicit operation timeout for connection to master node
`h`::
`String, String[], Boolean` -- Comma-separated list of column names to display
`help`::
@ -2985,9 +2985,9 @@ The default method is `GET` and the usual <<api-conventions,params and return va
`flatSettings`::
`Boolean` -- Return settings in flat format (default: false)
`masterTimeout`::
`Date, Number` -- Explicit operation timeout for connection to master node
`DurationString` -- Explicit operation timeout for connection to master node
`timeout`::
`Date, Number` -- Explicit operation timeout
`DurationString` -- Explicit operation timeout
`includeDefaults`::
`Boolean` -- Whether to return all default clusters setting.
@ -3021,9 +3021,9 @@ Options:::
`local`::
`Boolean` -- Return local information, do not retrieve the state from master node (default: false)
`masterTimeout`::
`Date, Number` -- Explicit operation timeout for connection to master node
`DurationString` -- Explicit operation timeout for connection to master node
`timeout`::
`Date, Number` -- Explicit operation timeout
`DurationString` -- Explicit operation timeout
`waitForActiveShards`::
`String` -- Wait until the specified number of shards is active
`waitForNodes`::
@ -3073,7 +3073,7 @@ The default method is `GET` and the usual <<api-conventions,params and return va
`local`::
`Boolean` -- Return local information, do not retrieve the state from master node (default: false)
`masterTimeout`::
`Date, Number` -- Specify timeout for connection to master
`DurationString` -- Specify timeout for connection to master
link:#[back to top]
@ -3098,9 +3098,9 @@ The default method is `PUT` and the usual <<api-conventions,params and return va
`flatSettings`::
`Boolean` -- Return settings in flat format (default: false)
`masterTimeout`::
`Date, Number` -- Explicit operation timeout for connection to master node
`DurationString` -- Explicit operation timeout for connection to master node
`timeout`::
`Date, Number` -- Explicit operation timeout
`DurationString` -- Explicit operation timeout
link:#[back to top]
@ -3131,9 +3131,9 @@ The default method is `POST` and the usual <<api-conventions,params and return v
`metric`::
`String, String[], Boolean` -- Limit the information returned to the specified metrics. Defaults to all but metadata
`masterTimeout`::
`Date, Number` -- Explicit operation timeout for connection to master node
`DurationString` -- Explicit operation timeout for connection to master node
`timeout`::
`Date, Number` -- Explicit operation timeout
`DurationString` -- Explicit operation timeout
link:#[back to top]
@ -3158,7 +3158,7 @@ The default method is `GET` and the usual <<api-conventions,params and return va
`local`::
`Boolean` -- Return local information, do not retrieve the state from master node (default: false)
`masterTimeout`::
`Date, Number` -- Specify timeout for connection to master
`DurationString` -- Specify timeout for connection to master
`flatSettings`::
`Boolean` -- Return settings in flat format (default: false)
`ignoreUnavailable`::
@ -3203,7 +3203,7 @@ The default method is `GET` and the usual <<api-conventions,params and return va
`human`::
`Boolean` -- Whether to return time and byte values in human-readable format.
`timeout`::
`Date, Number` -- Explicit operation timeout
`DurationString` -- Explicit operation timeout
`nodeId`::
`String, String[], Boolean` -- A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes
@ -3323,9 +3323,9 @@ The default method is `POST` and the usual <<api-conventions,params and return v
[horizontal]
`timeout`::
`Date, Number` -- Explicit operation timeout
`DurationString` -- Explicit operation timeout
`masterTimeout`::
`Date, Number` -- Specify timeout for connection to master
`DurationString` -- Specify timeout for connection to master
`ignoreUnavailable`::
`Boolean` -- Whether specified concrete indices should be ignored when unavailable (missing or closed)
`allowNoIndices`::
@ -3364,9 +3364,9 @@ The default method is `PUT` and the usual <<api-conventions,params and return va
`waitForActiveShards`::
`String` -- Set the number of active shards to wait for before the operation returns.
`timeout`::
`Date, Number` -- Explicit operation timeout
`DurationString` -- Explicit operation timeout
`masterTimeout`::
`Date, Number` -- Specify timeout for connection to master
`DurationString` -- Specify timeout for connection to master
`updateAllTypes`::
`Boolean` -- Whether to update the mapping for all fields with the same name across all types or not
`index`::
@ -3393,9 +3393,9 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
[horizontal]
`timeout`::
`Date, Number` -- Explicit operation timeout
`DurationString` -- Explicit operation timeout
`masterTimeout`::
`Date, Number` -- Specify timeout for connection to master
`DurationString` -- Specify timeout for connection to master
`index`::
`String, String[], Boolean` -- A comma-separated list of indices to delete; use `_all` or `*` string to delete all indices
@ -3420,9 +3420,9 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
[horizontal]
`timeout`::
`Date, Number` -- Explicit timestamp for the document
`DurationString` -- Explicit timestamp for the document
`masterTimeout`::
`Date, Number` -- Specify timeout for connection to master
`DurationString` -- Specify timeout for connection to master
`index`::
`String, String[], Boolean` -- A comma-separated list of index names (supports wildcards); use `_all` for all indices
`name`::
@ -3449,9 +3449,9 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
[horizontal]
`timeout`::
`Date, Number` -- Explicit operation timeout
`DurationString` -- Explicit operation timeout
`masterTimeout`::
`Date, Number` -- Specify timeout for connection to master
`DurationString` -- Specify timeout for connection to master
`name`::
`String` -- The name of the template
@ -3552,7 +3552,7 @@ The default method is `HEAD` and the usual <<api-conventions,params and return v
[horizontal]
`masterTimeout`::
`Date, Number` -- Explicit operation timeout for connection to master node
`DurationString` -- Explicit operation timeout for connection to master node
`local`::
`Boolean` -- Return local information, do not retrieve the state from master node (default: false)
`name`::
@ -3950,7 +3950,7 @@ The default method is `GET` and the usual <<api-conventions,params and return va
`flatSettings`::
`Boolean` -- Return settings in flat format (default: false)
`masterTimeout`::
`Date, Number` -- Explicit operation timeout for connection to master node
`DurationString` -- Explicit operation timeout for connection to master node
`local`::
`Boolean` -- Return local information, do not retrieve the state from master node (default: false)
`name`::
@ -4014,9 +4014,9 @@ The default method is `POST` and the usual <<api-conventions,params and return v
[horizontal]
`timeout`::
`Date, Number` -- Explicit operation timeout
`DurationString` -- Explicit operation timeout
`masterTimeout`::
`Date, Number` -- Specify timeout for connection to master
`DurationString` -- Specify timeout for connection to master
`ignoreUnavailable`::
`Boolean` -- Whether specified concrete indices should be ignored when unavailable (missing or closed)
`allowNoIndices`::
@ -4053,9 +4053,9 @@ The default method is `PUT` and the usual <<api-conventions,params and return va
[horizontal]
`timeout`::
`Date, Number` -- Explicit timestamp for the document
`DurationString` -- Explicit timestamp for the document
`masterTimeout`::
`Date, Number` -- Specify timeout for connection to master
`DurationString` -- Specify timeout for connection to master
`index`::
`String, String[], Boolean` -- A comma-separated list of index names the alias should point to (supports wildcards); use `_all` to perform the operation on all indices.
`name`::
@ -4082,9 +4082,9 @@ The default method is `PUT` and the usual <<api-conventions,params and return va
[horizontal]
`timeout`::
`Date, Number` -- Explicit operation timeout
`DurationString` -- Explicit operation timeout
`masterTimeout`::
`Date, Number` -- Specify timeout for connection to master
`DurationString` -- Specify timeout for connection to master
`ignoreUnavailable`::
`Boolean` -- Whether specified concrete indices should be ignored when unavailable (missing or closed)
`allowNoIndices`::
@ -4125,7 +4125,7 @@ The default method is `PUT` and the usual <<api-conventions,params and return va
[horizontal]
`masterTimeout`::
`Date, Number` -- Specify timeout for connection to master
`DurationString` -- Specify timeout for connection to master
`preserveExisting`::
`Boolean` -- Whether to update existing settings. If set to `true` existing settings on an index remain unchanged, the default is `false`
`ignoreUnavailable`::
@ -4170,9 +4170,9 @@ The default method is `PUT` and the usual <<api-conventions,params and return va
`create`::
`Boolean` -- Whether the index template should only be added if new or can also replace an existing one
`timeout`::
`Date, Number` -- Explicit operation timeout
`DurationString` -- Explicit operation timeout
`masterTimeout`::
`Date, Number` -- Specify timeout for connection to master
`DurationString` -- Specify timeout for connection to master
`flatSettings`::
`Boolean` -- Return settings in flat format (default: false)
`name`::
@ -4267,11 +4267,11 @@ The default method is `POST` and the usual <<api-conventions,params and return v
[horizontal]
`timeout`::
`Date, Number` -- Explicit operation timeout
`DurationString` -- Explicit operation timeout
`dryRun`::
`Boolean` -- If set to true the rollover action will only be validated but not actually performed even if a condition matches. The default is false
`masterTimeout`::
`Date, Number` -- Specify timeout for connection to master
`DurationString` -- Specify timeout for connection to master
`waitForActiveShards`::
`String` -- Set the number of active shards to wait for on the newly created rollover index before the operation returns.
`alias`::
@ -4380,9 +4380,9 @@ The default method is `POST` and the usual <<api-conventions,params and return v
[horizontal]
`timeout`::
`Date, Number` -- Explicit operation timeout
`DurationString` -- Explicit operation timeout
`masterTimeout`::
`Date, Number` -- Specify timeout for connection to master
`DurationString` -- Specify timeout for connection to master
`waitForActiveShards`::
`String` -- Set the number of active shards to wait for on the shrunken index before the operation returns.
`index`::
@ -4468,9 +4468,9 @@ client.indices.updateAliases({
[horizontal]
`timeout`::
`Date, Number` -- Request timeout
`DurationString` -- Request timeout
`masterTimeout`::
`Date, Number` -- Specify timeout for connection to master
`DurationString` -- Specify timeout for connection to master
link:#[back to top]
@ -4593,9 +4593,9 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
[horizontal]
`masterTimeout`::
`Date, Number` -- Explicit operation timeout for connection to master node
`DurationString` -- Explicit operation timeout for connection to master node
`timeout`::
`Date, Number` -- Explicit operation timeout
`DurationString` -- Explicit operation timeout
`id`::
`String` -- Pipeline ID
@ -4620,7 +4620,7 @@ The default method is `GET` and the usual <<api-conventions,params and return va
[horizontal]
`masterTimeout`::
`Date, Number` -- Explicit operation timeout for connection to master node
`DurationString` -- Explicit operation timeout for connection to master node
`id`::
`String` -- Comma separated list of pipeline ids. Wildcards supported
@ -4645,9 +4645,9 @@ The default method is `PUT` and the usual <<api-conventions,params and return va
[horizontal]
`masterTimeout`::
`Date, Number` -- Explicit operation timeout for connection to master node
`DurationString` -- Explicit operation timeout for connection to master node
`timeout`::
`Date, Number` -- Explicit operation timeout
`DurationString` -- Explicit operation timeout
`id`::
`String` -- Pipeline ID
@ -4697,7 +4697,7 @@ The default method is `GET` and the usual <<api-conventions,params and return va
[horizontal]
`interval`::
`Date, Number` -- The interval for the second sampling of threads
`DurationString` -- The interval for the second sampling of threads
`snapshots`::
`Number` -- Number of samples of thread stacktrace (default: 10)
`threads`::
@ -4712,7 +4712,7 @@ Options:::
* `"block"`
`timeout`::
`Date, Number` -- Explicit operation timeout
`DurationString` -- Explicit operation timeout
`nodeId`::
`String, String[], Boolean` -- A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes
@ -4741,7 +4741,7 @@ The default method is `GET` and the usual <<api-conventions,params and return va
`human`::
`Boolean` -- Whether to return time and byte values in human-readable format.
`timeout`::
`Date, Number` -- Explicit operation timeout
`DurationString` -- Explicit operation timeout
`nodeId`::
`String, String[], Boolean` -- A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes
`metric`::
@ -4787,7 +4787,7 @@ Options:::
`types`::
`String, String[], Boolean` -- A comma-separated list of document types for the `indexing` index metric
`timeout`::
`Date, Number` -- Explicit operation timeout
`DurationString` -- Explicit operation timeout
`metric`::
`String, String[], Boolean` -- Limit the information returned to the specified metrics
`indexMetric`::
@ -4816,7 +4816,7 @@ The default method is `POST` and the usual <<api-conventions,params and return v
[horizontal]
`masterTimeout`::
`Date, Number` -- Explicit operation timeout for connection to master node
`DurationString` -- Explicit operation timeout for connection to master node
`waitForCompletion`::
`Boolean` -- Should this request wait until the operation has completed before returning
`repository`::
@ -4845,9 +4845,9 @@ The default method is `POST` and the usual <<api-conventions,params and return v
[horizontal]
`masterTimeout`::
`Date, Number` -- Explicit operation timeout for connection to master node
`DurationString` -- Explicit operation timeout for connection to master node
`timeout`::
`Date, Number` -- Explicit operation timeout
`DurationString` -- Explicit operation timeout
`verify`::
`Boolean` -- Whether to verify the repository after creation
`repository`::
@ -4874,7 +4874,7 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
[horizontal]
`masterTimeout`::
`Date, Number` -- Explicit operation timeout for connection to master node
`DurationString` -- Explicit operation timeout for connection to master node
`repository`::
`String` -- A repository name
`snapshot`::
@ -4901,9 +4901,9 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
[horizontal]
`masterTimeout`::
`Date, Number` -- Explicit operation timeout for connection to master node
`DurationString` -- Explicit operation timeout for connection to master node
`timeout`::
`Date, Number` -- Explicit operation timeout
`DurationString` -- Explicit operation timeout
`repository`::
`String, String[], Boolean` -- A comma-separated list of repository names
@ -4928,7 +4928,7 @@ The default method is `GET` and the usual <<api-conventions,params and return va
[horizontal]
`masterTimeout`::
`Date, Number` -- Explicit operation timeout for connection to master node
`DurationString` -- Explicit operation timeout for connection to master node
`ignoreUnavailable`::
`Boolean` -- Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown
`repository`::
@ -4957,7 +4957,7 @@ The default method is `GET` and the usual <<api-conventions,params and return va
[horizontal]
`masterTimeout`::
`Date, Number` -- Explicit operation timeout for connection to master node
`DurationString` -- Explicit operation timeout for connection to master node
`local`::
`Boolean` -- Return local information, do not retrieve the state from master node (default: false)
`repository`::
@ -4984,7 +4984,7 @@ The default method is `POST` and the usual <<api-conventions,params and return v
[horizontal]
`masterTimeout`::
`Date, Number` -- Explicit operation timeout for connection to master node
`DurationString` -- Explicit operation timeout for connection to master node
`waitForCompletion`::
`Boolean` -- Should this request wait until the operation has completed before returning
`repository`::
@ -5013,7 +5013,7 @@ The default method is `GET` and the usual <<api-conventions,params and return va
[horizontal]
`masterTimeout`::
`Date, Number` -- Explicit operation timeout for connection to master node
`DurationString` -- Explicit operation timeout for connection to master node
`ignoreUnavailable`::
`Boolean` -- Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown
`repository`::
@ -5042,9 +5042,9 @@ The default method is `POST` and the usual <<api-conventions,params and return v
[horizontal]
`masterTimeout`::
`Date, Number` -- Explicit operation timeout for connection to master node
`DurationString` -- Explicit operation timeout for connection to master node
`timeout`::
`Date, Number` -- Explicit operation timeout
`DurationString` -- Explicit operation timeout
`repository`::
`String` -- A repository name