[Transport/request] document all params
(cherry picked from commit c85669a8cc)
This commit is contained in:
@ -5,17 +5,32 @@
|
|||||||
|
|
||||||
==== Params
|
==== Params
|
||||||
[horizontal]
|
[horizontal]
|
||||||
|
`method`::
|
||||||
|
`String` -- The HTTP method to use for this request. All of the API methods have their own default.
|
||||||
|
|
||||||
`path`::
|
`path`::
|
||||||
`String` -- The path/endpoint for the request
|
`String` -- The path/endpoint for the request
|
||||||
|
|
||||||
`query`::
|
`query`::
|
||||||
`String|Object` -- The query string params
|
`String|Object` -- The query string params
|
||||||
|
|
||||||
|
`body`::
|
||||||
|
`String|Object|Array<Object>` -- The request body to be sent to elasticsearch
|
||||||
|
|
||||||
|
`requestTimeout`::
|
||||||
|
`Number` -- The number of milliseconds before this request should "timeout"
|
||||||
|
|
||||||
|
`headers`::
|
||||||
|
`Object<String:String>` -- An object of string keys and values to use as the headers for this request.
|
||||||
|
|
||||||
`ignore`::
|
`ignore`::
|
||||||
`Number, Number[]` -- HTTP status codes which should not be treated as errors
|
`Number, Number[]` -- HTTP status codes which should not be treated as errors
|
||||||
|
|
||||||
`requestTimeout`::
|
`requestTimeout`::
|
||||||
`Number` -- Milliseconds this request has to complete. The default can be set using the client's `requestTimeout:` config parameter.
|
`Number` -- Milliseconds this request has to complete. The default can be set using the client's `requestTimeout:` config parameter.
|
||||||
|
|
||||||
`method`::
|
`castExists`::
|
||||||
`String` -- The HTTP method to use for this request. All of the API methods have their own default.
|
`Boolean` -- This is used by methods like `indices.exists()` to provide a `true`/`false` return value based on the status of the response. When set to `true` 200 responses are converted to `true`, and 404s to `false`. Any other error will still be passed through to the response handler but all other response data is discarded.
|
||||||
|
|
||||||
|
`bulkBody`::
|
||||||
|
`Boolean` -- Set to `true` if the body should be formatted using the newline delimited JSON format used by the `bulk` API.
|
||||||
|
|||||||
Reference in New Issue
Block a user