Skip to content

Commit 6e1c209

Browse files
Auto-generated code for main (#1985)
1 parent 9da7c44 commit 6e1c209

File tree

1 file changed

+23
-17
lines changed

1 file changed

+23
-17
lines changed

docs/reference.asciidoc

Lines changed: 23 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -712,20 +712,23 @@ client.reindex({ dest, source })
712712
==== Arguments
713713

714714
* *Request (object):*
715-
** *`dest` ({ index, op_type, pipeline, routing, version_type })*
716-
** *`source` ({ index, query, remote, size, slice, sort, _source, runtime_mappings })*
717-
** *`conflicts` (Optional, Enum("abort" | "proceed"))*
718-
** *`max_docs` (Optional, number)*
719-
** *`script` (Optional, { lang, options, source } | { id })*
715+
** *`dest` ({ index, op_type, pipeline, routing, version_type })*: The destination you are copying to.
716+
** *`source` ({ index, query, remote, size, slice, sort, _source, runtime_mappings })*: The source you are copying from.
717+
** *`conflicts` (Optional, Enum("abort" | "proceed"))*: Set to proceed to continue reindexing even if there are conflicts.
718+
** *`max_docs` (Optional, number)*: The maximum number of documents to reindex.
719+
** *`script` (Optional, { lang, options, source } | { id })*: The script to run to update the document source or metadata when reindexing.
720720
** *`size` (Optional, number)*
721-
** *`refresh` (Optional, boolean)*: Should the affected indexes be refreshed?
722-
** *`requests_per_second` (Optional, float)*: The throttle to set on this request in sub-requests per second. -1 means no throttle.
723-
** *`scroll` (Optional, string | -1 | 0)*: Control how long to keep the search context alive
724-
** *`slices` (Optional, number | Enum("auto"))*: The number of slices this task should be divided into. Defaults to 1, meaning the task isn't sliced into subtasks. Can be set to `auto`.
725-
** *`timeout` (Optional, string | -1 | 0)*: Time each individual bulk request should wait for shards that are unavailable.
726-
** *`wait_for_active_shards` (Optional, number | Enum("all" | "index-setting"))*: 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)
727-
** *`wait_for_completion` (Optional, boolean)*: Should the request should block until the reindex is complete.
728-
** *`require_alias` (Optional, boolean)*
721+
** *`refresh` (Optional, boolean)*: If `true`, the request refreshes affected shards to make this operation visible to search.
722+
** *`requests_per_second` (Optional, float)*: The throttle for this request in sub-requests per second.
723+
Defaults to no throttle.
724+
** *`scroll` (Optional, string | -1 | 0)*: Specifies how long a consistent view of the index should be maintained for scrolled search.
725+
** *`slices` (Optional, number | Enum("auto"))*: The number of slices this task should be divided into.
726+
Defaults to 1 slice, meaning the task isn’t sliced into subtasks.
727+
** *`timeout` (Optional, string | -1 | 0)*: Period each indexing waits for automatic index creation, dynamic mapping updates, and waiting for active shards.
728+
** *`wait_for_active_shards` (Optional, number | Enum("all" | "index-setting"))*: The number of shard copies that must be active before proceeding with the operation.
729+
Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).
730+
** *`wait_for_completion` (Optional, boolean)*: If `true`, the request blocks until the operation is complete.
731+
** *`require_alias` (Optional, boolean)*: If `true`, the destination must be an index alias.
729732

730733
[discrete]
731734
=== reindex_rethrottle
@@ -4949,8 +4952,9 @@ client.ml.deleteCalendarEvent({ calendar_id, event_id })
49494952
==== Arguments
49504953

49514954
* *Request (object):*
4952-
** *`calendar_id` (string)*: The ID of the calendar to modify
4953-
** *`event_id` (string)*: The ID of the event to remove from the calendar
4955+
** *`calendar_id` (string)*: A string that uniquely identifies a calendar.
4956+
** *`event_id` (string)*: Identifier for the scheduled event.
4957+
You can obtain this identifier by using the get calendar events API.
49544958

49554959
[discrete]
49564960
==== delete_calendar_job
@@ -5363,7 +5367,8 @@ neither the category ID nor the partition_field_value, the API returns
53635367
information about all categories. If you specify only the
53645368
partition_field_value, it returns information about all categories for
53655369
the specified partition.
5366-
** *`page` (Optional, { from, size })*
5370+
** *`page` (Optional, { from, size })*: Configures pagination.
5371+
This parameter has the `from` and `size` properties.
53675372
** *`from` (Optional, number)*: Skips the specified number of categories.
53685373
** *`partition_field_value` (Optional, string)*: Only return categories for the specified partition.
53695374
** *`size` (Optional, number)*: Specifies the maximum number of categories to obtain.
@@ -5526,7 +5531,8 @@ client.ml.getInfluencers({ job_id })
55265531

55275532
* *Request (object):*
55285533
** *`job_id` (string)*: Identifier for the anomaly detection job.
5529-
** *`page` (Optional, { from, size })*
5534+
** *`page` (Optional, { from, size })*: Configures pagination.
5535+
This parameter has the `from` and `size` properties.
55305536
** *`desc` (Optional, boolean)*: If true, the results are sorted in descending order.
55315537
** *`end` (Optional, string | Unit)*: Returns influencers with timestamps earlier than this time.
55325538
The default value means it is unset and results are not limited to

0 commit comments

Comments
 (0)