Loading

wait_interval

Note

This setting is used by the allocation, cluster_routing, reindex, replicas, restore, and snapshot actions.

This setting must be a positive integer between 1 and 30.

This setting specifies how long to wait between checks to see if the action has completed or not. This number should not be larger than the client request_timeout or the timeout_override. As the default client request_timeout value for is 30, this should be uncommon.

The default value for this setting is 9, meaning 9 seconds between checks.

This option is generally used in conjunction with max_wait, which is the maximum amount of time in seconds to wait for the given action to complete.

 action: allocation description: "Apply shard allocation filtering rules to the specified indices" options: key: ... value: ... allocation_type: ... wait_for_completion: False max_wait: 300 wait_interval: 10 filters: - filtertype: ... 
 action: cluster_routing description: "Apply routing rules to the entire cluster" options: routing_type: value: ... setting: enable wait_for_completion: True max_wait: 300 wait_interval: 10 
 actions: 1: description: "Reindex index1 into index2" action: reindex options: wait_interval: 9 max_wait: -1 request_body: source: index: index1 dest: index: index2 filters: - filtertype: none 
 action: replicas description: >- Set the number of replicas per shard for selected indices to 'count' options: count: ... wait_for_completion: True max_wait: 600 wait_interval: 10 filters: - filtertype: ... 
 actions: 1: action: restore description: Restore my_index from my_snapshot in my_repository options: repository: my_repository name: my_snapshot indices: my_index wait_for_completion: True max_wait: 3600 wait_interval: 10 filters: - filtertype: state state: SUCCESS exclude: - filtertype: ... 
 action: snapshot description: >- Snapshot selected indices to 'repository' with the snapshot name or name pattern in 'name'. Use all other options as assigned options: repository: my_repository name: my_snapshot wait_for_completion: True max_wait: 3600 wait_interval: 10 filters: - filtertype: ...