Cluster · разработчикам

ConfigView

Снимок доступных значений собственной конфигурации. Унаследованные изменения Document остаются локальными.

Все методы SDK · Типы и ошибки

Получение объекта

config = await app.config.snapshot().load()

Наследует Document. Унаследованные методы: path, dirty, get, parent, set, remove, rename, append, insert, move, sort, increment, reset, accept.

__init__

Создаёт ConfigView. Обычный способ получения объекта показан выше; прямой конструктор не выполняет сетевые запросы.

def __init__(config: Config) -> None: ...

Аргументы

• config: Config, обязательный. Служба собственной конфигурации.

Результат

None. Создаёт ConfigView. Обычный способ получения объекта показан выше; прямой конструктор не выполняет сетевые запросы.

Права

Не требует прав: операция выполняется локально и сама не обращается к ядру. Права понадобятся при отправке, сохранении или чтении через службу.

Ошибки

• Отдельного исключения SDK нет. Действуют обычные ошибки типов Python и ошибки переданных функций, если они используются.

Пример

# Обычный способ получения объекта:
config = await app.config.snapshot().load()

load

Получает values и revision собственной конфигурации и принимает локальный снимок.

async def load() -> Self: ...

Аргументы

Нет.

Результат

Self. Тот же объект после успешной операции. Получает values и revision собственной конфигурации и принимает локальный снимок.

Права

Нужны config.read.

Ошибки

• Ошибки ядра: AccessDenied при нехватке прав или выходе за ограничения, InvalidInput для неверных параметров, InvalidState для недоступного состояния, QuotaExceeded при превышении лимита, Unavailable при недоступной службе. Остальные коды представлены SDKError; см. TYPES.md. Ошибка канала связи вызывает RuntimeError. Действие с неизвестным результатом нельзя автоматически считать невыполненным.

Пример

result = await config.load()

changed

Сравнивает свежую ревизию ядра с сохранённой. Локальные значения и сохранённую ревизию не обновляет.

async def changed() -> bool: ...

Аргументы

Нет.

Результат

bool. Сравнивает свежую ревизию ядра с сохранённой. Локальные значения и сохранённую ревизию не обновляет.

Права

Нужны config.read.

Ошибки

• Ошибки ядра: AccessDenied при нехватке прав или выходе за ограничения, InvalidInput для неверных параметров, InvalidState для недоступного состояния, QuotaExceeded при превышении лимита, Unavailable при недоступной службе. Остальные коды представлены SDKError; см. TYPES.md. Ошибка канала связи вызывает RuntimeError. Действие с неизвестным результатом нельзя автоматически считать невыполненным.

Пример

result = await config.changed()