habsi/elasticsearch-js
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Test run of new docs

Browse Source
This commit is contained in:
Josh Mock
2024-11-19 11:04:35 -06:00
parent f33aa8cccd
commit 8210607de0
503 changed files with 37166 additions and 12056 deletions
Download Patch File Download Diff File Expand all files Collapse all files

77
docs/reference-indices-rollover.asciidoc Normal file
View File

@ -0,0 +1,77 @@
[[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
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]
===== `IndicesRolloverRequest`
[source,ts]
----
interface IndicesRolloverRequest extends <<shared-type-request-base, RequestBase>> {
alias: <<shared-type-index-alias, IndexAlias>>
new_index?: <<shared-type-index-name, IndexName>>
dry_run?: boolean
master_timeout?: <<shared-type-duration, Duration>>
timeout?: <<shared-type-duration, Duration>>
wait_for_active_shards?: <<shared-type-wait-for-active-shards, WaitForActiveShards>>
aliases?: Record<<<shared-type-index-name, IndexName>>, IndicesAlias>
conditions?: IndicesRolloverRolloverConditions
mappings?: MappingTypeMapping
settings?: Record<string, any>
}
----
[discrete]
===== `IndicesRolloverResponse`
[source,ts]
----
interface IndicesRolloverResponse {
acknowledged: boolean
conditions: Record<string, boolean>
dry_run: boolean
new_index: string
old_index: string
rolled_over: boolean
shards_acknowledged: boolean
}
----