Files
elasticsearch-js/docs/reference-indices-rollover.asciidoc
2024-12-05 14:46:52 -06:00

89 lines
4.3 KiB
Plaintext

[[reference-indices-rollover]]
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
[discrete]
[[client.indices.rollover]]
=== client.indices.rollover
Roll over to a new index. Creates a new index for a data stream or index alias.
{ref}/indices-rollover-index.html[{es} documentation]
[discrete]
==== Function signature
[source,ts]
----
(IndicesRolloverRequest, options?): Promise<IndicesRolloverResponse>
----
[discrete]
==== Request
[pass]
++++
<pre>
++++
interface IndicesRolloverRequest extends <<RequestBase>> {
alias: <<IndexAlias>>
new_index?: <<IndexName>>
dry_run?: boolean
master_timeout?: <<Duration>>
timeout?: <<Duration>>
wait_for_active_shards?: <<WaitForActiveShards>>
aliases?: Record<<<IndexName>>, <<IndicesAlias>>>
conditions?: IndicesRolloverRolloverConditions
mappings?: <<MappingTypeMapping>>
settings?: Record<string, any>
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
[pass]
++++
<pre>
++++
interface IndicesRolloverResponse {
acknowledged: boolean
conditions: Record<string, boolean>
dry_run: boolean
new_index: string
old_index: string
rolled_over: boolean
shards_acknowledged: boolean
}
[pass]
++++
</pre>
++++