models

Versioned portable backup contracts.

class bedrock_server_manager.backups.models.Record

model_config = {'extra': 'forbid', 'frozen': True, 'strict': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class bedrock_server_manager.backups.models.ServerSettingsExport(*, schema_version: Literal[1] = 1, autostart: bool, autoupdate: bool, target_version: str, custom: dict[str, ~pydantic.types.JsonValue]=<factory>)

model_config = {'extra': 'forbid', 'frozen': True, 'strict': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class bedrock_server_manager.backups.models.BackupFile(*, path: str, component: Literal['server_directory', 'world', 'server.properties', 'allowlist.json', 'permissions.json', 'script_config', 'bsm_settings', 'behavior_packs', 'resource_packs', 'development_behavior_packs', 'development_resource_packs'], size: Annotated[int, Ge(ge=0)], executable: bool = False, sha256: Annotated[str, _PydanticGeneralMetadata(pattern='^[a-f0-9]{64}$')])

model_config = {'extra': 'forbid', 'frozen': True, 'strict': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class bedrock_server_manager.backups.models.BackupManifest(*, source_platform: str | None = None, source_architecture: str | None = None, mode: ~typing.Literal['world', 'selected', 'full'] | None = None, selected_components: list[~typing.Literal['server_directory', 'world', 'server.properties', 'allowlist.json', 'permissions.json', 'script_config', 'bsm_settings', 'behavior_packs', 'resource_packs', 'development_behavior_packs', 'development_resource_packs']] | None = None, format: ~typing.Literal['bsmbackup'] = 'bsmbackup', format_version: ~typing.Literal[1] = 1, backup_id: ~uuid.UUID, created_at: ~datetime.datetime, capture_started_at: ~datetime.datetime, capture_finished_at: ~datetime.datetime, bsm_version: str, bedrock_version: str, source_server: str, source_world: str, capture_method: ~typing.Literal['offline', 'live'], reason: ~typing.Literal['manual', 'pre_start', 'pre_update', 'pre_restore', 'scheduled'] = 'manual', components: dict[~typing.Literal['server_directory', 'world', 'server.properties', 'allowlist.json', 'permissions.json', 'script_config', 'bsm_settings', 'behavior_packs', 'resource_packs', 'development_behavior_packs', 'development_resource_packs'], ~typing.Literal['included', 'absent']], files: list[~bedrock_server_manager.backups.models.BackupFile], directories: list[str] = <factory>, warnings: list[str] = <factory>)

model_config = {'extra': 'forbid', 'frozen': True, 'strict': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class bedrock_server_manager.backups.models.BackupHeader(*, format: Literal['bsmbackup'] = 'bsmbackup', container_version: Literal[1] = 1, encrypted: bool = False, key_id: str | None = None)

model_config = {'extra': 'forbid', 'frozen': True, 'strict': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class bedrock_server_manager.backups.models.BackupVerification(*, verified_at: str | None = None, status: Literal['unverified', 'verified', 'failed'] = 'unverified', error: str | None = None)

model_config = {'extra': 'forbid', 'frozen': True, 'strict': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class bedrock_server_manager.backups.models.BackupCopy(*, status: Literal['pending', 'completed', 'failed', 'pruned'], completed_at: str | None = None, error: str | None = None, attempts: int = 0, next_retry_at: str | None = None)

model_config = {'extra': 'forbid', 'frozen': True, 'strict': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class bedrock_server_manager.backups.models.BackupSummary(*, backup_id: str, filename: str, created_at: str | None = None, drill: dict[str, ~pydantic.types.JsonValue] | None=None, size: int, encrypted: bool, key_id: str | None = None, verification: BackupVerification = <factory>, stage_durations_ms: dict[str, float]=<factory>, pinned: bool = False, protected_until: str | None = None, purpose: str | None = None, copies: dict[str, ~bedrock_server_manager.backups.models.BackupCopy]=<factory>, label: str = '', notes: str = '', origin: Literal['captured', 'imported']='captured', manifest: BackupManifest | None = None, error: str | None = None)

model_config = {'extra': 'forbid', 'frozen': True, 'strict': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class bedrock_server_manager.backups.models.RestoreFileChange(*, component: Literal['server_directory', 'world', 'server.properties', 'allowlist.json', 'permissions.json', 'script_config', 'bsm_settings', 'behavior_packs', 'resource_packs', 'development_behavior_packs', 'development_resource_packs'], path: str, action: Literal['added', 'replaced', 'removed'])

model_config = {'extra': 'forbid', 'frozen': True, 'strict': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class bedrock_server_manager.backups.models.RestoreValueChange(*, component: Literal['server_directory', 'world', 'server.properties', 'allowlist.json', 'permissions.json', 'script_config', 'bsm_settings', 'behavior_packs', 'resource_packs', 'development_behavior_packs', 'development_resource_packs'], key: str, before: str | None, after: str | None)

model_config = {'extra': 'forbid', 'frozen': True, 'strict': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class bedrock_server_manager.backups.models.RestoreVolume(*, roles: list[str], required_bytes: int, available_bytes: int, sufficient: bool)

model_config = {'extra': 'forbid', 'frozen': True, 'strict': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class bedrock_server_manager.backups.models.RestorePlan(*, backup_id: str, token: str, components: list[~typing.Literal['server_directory', 'world', 'server.properties', 'allowlist.json', 'permissions.json', 'script_config', 'bsm_settings', 'behavior_packs', 'resource_packs', 'development_behavior_packs', 'development_resource_packs']], destinations: dict[~typing.Literal['server_directory', 'world', 'server.properties', 'allowlist.json', 'permissions.json', 'script_config', 'bsm_settings', 'behavior_packs', 'resource_packs', 'development_behavior_packs', 'development_resource_packs'], str], warnings: list[str], changes: list[~bedrock_server_manager.backups.models.RestoreFileChange] = <factory>, changes_truncated: bool = False, change_counts: dict[str, int] = <factory>, setting_changes: list[~bedrock_server_manager.backups.models.RestoreValueChange] = <factory>, safety_backup: bool = True, required_bytes: int, volumes: list[~bedrock_server_manager.backups.models.RestoreVolume] = <factory>, sufficient_space: bool = True, dry_run: bool = False, checked_files: int = 0)

model_config = {'extra': 'forbid', 'frozen': True, 'strict': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class bedrock_server_manager.backups.models.RestoreResult(*, safety_backup_id: str | None = None, restored: list[Literal['server_directory', 'world', 'server.properties', 'allowlist.json', 'permissions.json', 'script_config', 'bsm_settings', 'behavior_packs', 'resource_packs', 'development_behavior_packs', 'development_resource_packs']], committed: bool = True, restarted: bool = False, restart_error: str | None = None, cleanup_warning: str | None = None)

model_config = {'extra': 'forbid', 'frozen': True, 'strict': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class bedrock_server_manager.backups.models.RestoreRecoveryState(*, active: bool, committed: bool | None = None, error: str | None = None)

model_config = {'extra': 'forbid', 'frozen': True, 'strict': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class bedrock_server_manager.backups.models.BackupHealth(*, count: int, total_bytes: int, last_success_at: str | None = None, last_verified_at: str | None = None, last_failure_at: str | None = None, last_error: str | None = None, unverified_count: int = 0, failed_count: int = 0, missing_key_ids: list[str] = <factory>, older_key_ids: list[str] = <factory>, destination_failures: int = 0, schedule: dict[str, ~pydantic.types.JsonValue] | None=None, verification_interval_hours: int, readiness: Literal['ready', 'attention', 'unavailable']='unavailable', readiness_reasons: list[str] = <factory>, recovery_backup_id: str | None = None, drill: dict[str, ~pydantic.types.JsonValue] | None=None, destinations: dict[str, ~pydantic.types.JsonValue]=<factory>, alerts: list[dict[str, ~pydantic.types.JsonValue]]=<factory>)

model_config = {'extra': 'forbid', 'frozen': True, 'strict': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class bedrock_server_manager.backups.models.DestinationCleanupPlan(*, destination: str, token: str, delete: list[str], retain: list[str], reclaim_bytes: int, available_bytes: int, warnings: list[str] = <factory>, applied: bool = False)

model_config = {'extra': 'forbid', 'frozen': True, 'strict': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class bedrock_server_manager.backups.models.RecoveryReportReview(*, recorded_at: str, archive_reference: str, components: list[Literal['server_directory', 'world', 'server.properties', 'allowlist.json', 'permissions.json', 'script_config', 'bsm_settings', 'behavior_packs', 'resource_packs', 'development_behavior_packs', 'development_resource_packs']], dry_run: bool, checked_files: int, change_counts: dict[str, int], sufficient_space: bool, volumes: list[RestoreVolume])

model_config = {'extra': 'forbid', 'frozen': True, 'strict': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class bedrock_server_manager.backups.models.RecoveryReportOutcome(*, recorded_at: str, archive_reference: str, status: Literal['completed', 'failed', 'cancelled'], committed: bool | None = None, components: list[Literal['server_directory', 'world', 'server.properties', 'allowlist.json', 'permissions.json', 'script_config', 'bsm_settings', 'behavior_packs', 'resource_packs', 'development_behavior_packs', 'development_resource_packs']], restarted: bool = False, restart_failed: bool = False, cleanup_needed: bool = False)

model_config = {'extra': 'forbid', 'frozen': True, 'strict': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class bedrock_server_manager.backups.models.RecoveryReportArchive(*, archive_reference: str, encrypted: bool, key_available: bool, verification_status: Literal['unverified', 'verified', 'failed'], verified_at: str | None = None, copies_completed: int, copies_failed: int)

model_config = {'extra': 'forbid', 'frozen': True, 'strict': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class bedrock_server_manager.backups.models.RecoveryReportDrill(*, archive_reference: str, status: Literal['passed', 'failed', 'running'], checked_at: str | None = None, checked_files: int = 0)

model_config = {'extra': 'forbid', 'frozen': True, 'strict': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class bedrock_server_manager.backups.models.RecoveryReport(*, report_version: Literal[1] = 1, generated_at: str, readiness: Literal['ready', 'attention', 'unavailable'], archive_count: int, archives_omitted: int, missing_key_count: int, destination_failures: int, recovery_pending: bool, archives: list[RecoveryReportArchive], last_review: RecoveryReportReview | None = None, last_restore: RecoveryReportOutcome | None = None, last_drill: RecoveryReportDrill | None = None)

model_config = {'extra': 'forbid', 'frozen': True, 'strict': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

bedrock_server_manager.backups.models.validate_selection_options(value)

Validate explicit content overrides before a background task is accepted.