Default Values

Default values used in multiple places in the package

es_wait.defaults.BASE = {'max_exceptions': 10, 'pause': 9.0, 'timeout': 15.0}

The default values for the base Waiter class

es_wait.defaults.CHECK_TYPES = {'cluster_routing': {'relocating_shards': 0}, 'relocation': {'relocating_shards': 0}, 'status': {'status': 'green'}}

The types of health checks that can be performed

es_wait.defaults.DEFAULT_MAX_EXCEPTIONS = 10

The default maximum number of exceptions to allow

es_wait.defaults.DEFAULT_PAUSE = 9.0

The default pause time between checks

es_wait.defaults.EXISTS = {'kind': typing.Literal['index', 'data_stream', 'index_template', 'component_template'], 'max_exceptions': 10, 'pause': 1.5, 'timeout': 15.0, 'types': ['index', 'data_stream', 'index_template', 'component_template']}

The default values for the Exists class

es_wait.defaults.EXISTS_TYPES: List[Literal['index', 'data_stream', 'index_template', 'component_template']] = ['index', 'data_stream', 'index_template', 'component_template']

A list of the types of entities that can be checked for existence

es_wait.defaults.ExistsTypes

The acceptable values for types of entities that can be checked for existence

alias of Literal[‘index’, ‘data_stream’, ‘index_template’, ‘component_template’]

es_wait.defaults.HEALTH = {'max_exceptions': 10, 'pause': 1.5, 'timeout': 15.0, 'types': {'cluster_routing': {'relocating_shards': 0}, 'relocation': {'relocating_shards': 0}, 'status': {'status': 'green'}}}

The default values for the Health class

es_wait.defaults.HEALTH_TYPES = {'cluster_routing': {'relocating_shards': 0}, 'relocation': {'relocating_shards': 0}, 'status': {'status': 'green'}}

The types of health checks that can be performed

class es_wait.defaults.HealthCheckDict

Bases: TypedDict

This is a type hint for the dictionary that is used to check the health of the cluster. It is used in the Health class to determine if the health check is successful.

active_primary_shards: int

active_shards: int

active_shards_percent_as_number: int

cluster_name: str

delayed_unassigned_shards: int

initializing_shards: int

number_of_data_nodes: int

number_of_in_flight_fetch: int

number_of_nodes: int

number_of_pending_tasks: int

relocating_shards: int

status: str

task_max_waiting_in_queue_millis: int

timed_out: bool

unassigned_primary_shards: int

unassigned_shards: int

es_wait.defaults.HealthTypes

The acceptable values for types of health checks

alias of Literal[‘status’, ‘relocation’, ‘cluster_routing’]

es_wait.defaults.ILM = {'max_exceptions': 10, 'pause': 9.0, 'timeout': 7200.0}

The default values for the ILM class

es_wait.defaults.RELOCATE = {'max_exceptions': 10, 'pause': 9.0, 'timeout': 3600.0}

The default values for the Relocate class

es_wait.defaults.RESTORE = {'max_exceptions': 10, 'pause': 9.0, 'timeout': 7200.0}

The default values for the Restore class

es_wait.defaults.SNAPSHOT = {'max_exceptions': 10, 'pause': 9.0, 'timeout': 7200.0}

The default values for the Snapshot class

es_wait.defaults.TASK = {'max_exceptions': 10, 'pause': 9.0, 'timeout': 7200.0}

The default values for the Task class

es_wait.defaults.relocation: HealthCheckDict = {'relocating_shards': 0}

The default value for the HealthCheckDict when type is relocation

es_wait.defaults.status: HealthCheckDict = {'status': 'green'}

The default value for the HealthCheckDict when type is status