5353class Response (AttrDict [Any ], Generic [_R ]):
5454 """An Elasticsearch search response.
5555
56- :arg took: (required)
57- :arg timed_out: (required)
58- :arg _shards: (required)
56+ :arg took: (required) The number of milliseconds it took Elasticsearch
57+ to run the request. This value is calculated by measuring the time
58+ elapsed between receipt of a request on the coordinating node and
59+ the time at which the coordinating node is ready to send the
60+ response. It includes: * Communication time between the
61+ coordinating node and data nodes * Time the request spends in the
62+ search thread pool, queued for execution * Actual run time It
63+ does not include: * Time needed to send the request to
64+ Elasticsearch * Time needed to serialize the JSON response * Time
65+ needed to send the response to a client
66+ :arg timed_out: (required) If `true`, the request timed out before
67+ completion; returned results may be partial or empty.
68+ :arg _shards: (required) A count of shards used for the request.
5969 :arg hits: search results
6070 :arg aggregations: aggregation results
6171 :arg _clusters:
@@ -64,7 +74,11 @@ class Response(AttrDict[Any], Generic[_R]):
6474 :arg num_reduce_phases:
6575 :arg profile:
6676 :arg pit_id:
67- :arg _scroll_id:
77+ :arg _scroll_id: The identifier for the search and its search context.
78+ You can use this scroll ID with the scroll API to retrieve the
79+ next batch of search results for the request. This property is
80+ returned only if the `scroll` query parameter is specified in the
81+ request.
6882 :arg suggest:
6983 :arg terminated_early:
7084 """
@@ -303,22 +317,42 @@ def __iter__(self) -> Iterator[AggregateResponseType]: # type: ignore[override]
303317class UpdateByQueryResponse (AttrDict [Any ], Generic [_R ]):
304318 """An Elasticsearch update by query response.
305319
306- :arg batches:
307- :arg failures:
308- :arg noops:
309- :arg deleted:
310- :arg requests_per_second:
311- :arg retries:
320+ :arg batches: The number of scroll responses pulled back by the update
321+ by query.
322+ :arg failures: Array of failures if there were any unrecoverable
323+ errors during the process. If this is non-empty then the request
324+ ended because of those failures. Update by query is implemented
325+ using batches. Any failure causes the entire process to end, but
326+ all failures in the current batch are collected into the array.
327+ You can use the `conflicts` option to prevent reindex from ending
328+ when version conflicts occur.
329+ :arg noops: The number of documents that were ignored because the
330+ script used for the update by query returned a noop value for
331+ `ctx.op`.
332+ :arg deleted: The number of documents that were successfully deleted.
333+ :arg requests_per_second: The number of requests per second
334+ effectively run during the update by query.
335+ :arg retries: The number of retries attempted by update by query.
336+ `bulk` is the number of bulk actions retried. `search` is the
337+ number of search actions retried.
312338 :arg task:
313- :arg timed_out:
314- :arg took:
315- :arg total:
316- :arg updated:
317- :arg version_conflicts:
339+ :arg timed_out: If true, some requests timed out during the update by
340+ query.
341+ :arg took: The number of milliseconds from start to end of the whole
342+ operation.
343+ :arg total: The number of documents that were successfully processed.
344+ :arg updated: The number of documents that were successfully updated.
345+ :arg version_conflicts: The number of version conflicts that the
346+ update by query hit.
318347 :arg throttled:
319- :arg throttled_millis:
348+ :arg throttled_millis: The number of milliseconds the request slept to
349+ conform to `requests_per_second`.
320350 :arg throttled_until:
321- :arg throttled_until_millis:
351+ :arg throttled_until_millis: This field should always be equal to zero
352+ in an _update_by_query response. It only has meaning when using
353+ the task API, where it indicates the next time (in milliseconds
354+ since epoch) a throttled request will be run again in order to
355+ conform to `requests_per_second`.
322356 """
323357
324358 _search : "UpdateByQueryBase[_R]"
0 commit comments