[[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 || || || || || || || =========================================================================================================================== //////// [discrete] === 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 ---- [discrete] ===== `IndicesRolloverRequest` [source,ts] ---- interface IndicesRolloverRequest extends <> { alias: <> new_index?: <> dry_run?: boolean master_timeout?: <> timeout?: <> wait_for_active_shards?: <> aliases?: Record<<>, IndicesAlias> conditions?: IndicesRolloverRolloverConditions mappings?: MappingTypeMapping settings?: Record } ---- [discrete] ===== `IndicesRolloverResponse` [source,ts] ---- interface IndicesRolloverResponse { acknowledged: boolean conditions: Record dry_run: boolean new_index: string old_index: string rolled_over: boolean shards_acknowledged: boolean } ----