Snapshot Class

Snapshot

class es_wait.snapshot.Snapshot(client: Elasticsearch, pause: float = 9.0, timeout: float = 7200.0, max_exceptions: int = 10, snapshot: str = '', repository: str = '')

Bases: Waiter

Wait for a snapshot to complete

add_exception(value: Exception) → None

This method appends value the exceptions list.

Parameters:

value (Exception) – An exception to add

announce() → None

This method is called when the Waiter class is initialized. It logs a level 1 debug message using waitstr.

check() → bool

Get the state of the snapshot from snapstate() to determine if the snapshot is complete, and if so, with what status.

If the state is IN_PROGRESS, this method will return False.

For all other states, it calls log_completion() to log the final result. It then returns True.

Getter:

Returns if the check was complete

Type:

bool

client

An Elasticsearch client instance

do_health_report

Only changes to True in certain circumstances

property exception_count_msg: str

This property returns a messgage showing the current number of exceptions raised and the maximum number of exceptions allowed.

Getter:

Returns ‘X exceptions raised out of Y allowed’

Type:

str

property exceptions: list

This property returns a list of exceptions raised during the wait.

Getter:

Returns a list of exceptions raised

Type:

list

exceptions_raised

The number of exceptions raised

log_completion(state: str) → None

Log completion based on state

If the snapshot state is:

Snapshot States & Logs

State	Log Level	Message
SUCCESS	INFO	Snapshot [name] completed with state SUCCESS.
PARTIAL	WARNING	Snapshot [name] completed with state PARTIAL.
FAILED	ERROR	Snapshot [name] completed with state FAILED.
[other]	WARNING	Snapshot [name] completed with state: [other]

Parameters:

state – The snapshot state

max_exceptions

The maximum number of exceptions to allow

pause

The delay between checks for completion

repository

The repository name

snapshot

The snapshot name

property snapstate: Dict

This function calls snapshot.get() to get the current state of the snapshot.

Getter:

Returns the state of the snapshot

Type:

bool

timeout

The number of seconds before giving up. -1 means no timeout.

too_many_exceptions() → None

If the number of exceptions raised is greater than or equal to the maximum number of exceptions allowed, then a ExceptionCount will be raised.

wait(frequency: int = 5) → None

This method is where the actual waiting occurs. Depending on what frequency is set to, you should see non-DEBUG level logs no more than every frequency seconds.

If timeout has been reached without check() returning as True, then a TimeoutError will be raised.

If check() returns False, then the method will wait pause seconds before calling check() again.

Elapsed time will be logged every frequency seconds, when check() is True, or when timeout is reached.

If do_health_report is True, then call client.health_report() and pass the results to utils.health_report().

Parameters:

frequency – The number of seconds between log reports on progress.