Files
elasticsearch-js/docs/reference/api/IndicesShrinkRequest.md
2025-05-28 10:02:30 -05:00

1.6 KiB

IndicesShrinkRequest [interface-IndicesShrinkRequest]

Name Type Description
aliases Record<IndexName, IndicesAlias> The key is the alias name. Index alias names support date math.
body string ({ [key: string]: any; } & { index?: never; target?: never; master_timeout?: never; timeout?: never; wait_for_active_shards?: never; aliases?: never; settings?: never; })
index IndexName Name of the source index to shrink.
master_timeout Duration Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.
querystring { [key: string]: any; } & { index?: never; target?: never; master_timeout?: never; timeout?: never; wait_for_active_shards?: never; aliases?: never; settings?: never; } All values in querystring will be added to the request querystring.
settings Record<string, any> Configuration options for the target index.
target IndexName Name of the target index to create.
timeout Duration Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.
wait_for_active_shards WaitForActiveShards The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index ( number_of_replicas+1).