barman.remote_status module

Remote Status module

A Remote Status class implements a standard interface for retrieving and caching the results of a remote component (such as Postgres server, WAL archiver, etc.). It follows the Mixin pattern.

class barman.remote_status.RemoteStatusMixin(*args, **kwargs)View on GitHub

Bases: object

Abstract base class that implements remote status capabilities following the Mixin pattern.

__init__(*args, **kwargs)View on GitHub

Base constructor (Mixin pattern)

_abc_impl = <_abc._abc_data object>

abstract fetch_remote_status()View on GitHub

Retrieve status information from the remote component

The implementation of this method must not raise any exception in case of errors, but should set the missing values to None in the resulting dictionary.

Return type:

dict[str, None|str]

get_remote_status()View on GitHub

Get the status of the remote component

This method does not raise any exception in case of errors, but set the missing values to None in the resulting dictionary.

Return type:

dict[str, None|str]

reset_remote_status()View on GitHub

Reset the cached result