Skip to main content

​
prefect.settings.models.server.services

​
Classes

​
ServicesBaseSetting

Methods:

​
settings_customise_sources 

settings_customise_sources(cls, settings_cls: type[BaseSettings], init_settings: PydanticBaseSettingsSource, env_settings: PydanticBaseSettingsSource, dotenv_settings: PydanticBaseSettingsSource, file_secret_settings: PydanticBaseSettingsSource) -> tuple[PydanticBaseSettingsSource, ...]
Define an order for Prefect settings sources. The order of the returned callables decides the priority of inputs; first item is the highest priority. See https://docs.pydantic.dev/latest/concepts/pydantic_settings/#customise-settings-sources

​
to_environment_variables 

to_environment_variables(self, exclude_unset: bool = False, include_secrets: bool = True, include_aliases: bool = False) -> dict[str, str]
Convert the settings object to a dictionary of environment variables.

​
ServerServicesCancellationCleanupSettings

Settings for controlling the cancellation cleanup service

​
ServerServicesDBVacuumSettings

Settings for controlling the database vacuum service Methods:

​
enabled_vacuum_types 

enabled_vacuum_types(self) -> set[str]
Resolve enabled to a concrete set of vacuum type strings. Handles legacy boolean values:
  • True → {"events", "flow_runs"}
  • False → {"events"} (preserves old default)
  • None → set()

​
ServerServicesEventPersisterSettings

Settings for controlling the event persister service

​
ServerServicesEventLoggerSettings

Settings for controlling the event logger service

​
ServerServicesForemanSettings

Settings for controlling the foreman service

​
ServerServicesLateRunsSettings

Settings for controlling the late runs service

​
ServerServicesSchedulerSettings

Settings for controlling the scheduler service

​
ServerServicesPauseExpirationsSettings

Settings for controlling the pause expiration service

​
ServerServicesRepossessorSettings

Settings for controlling the repossessor service

​
ServerServicesTaskRunRecorderSettings

Settings for controlling the task run recorder service

​
ServerServicesTriggersSettings

Settings for controlling the triggers service

​
ServerServicesSettings

Settings for controlling server services Methods:

​
settings_customise_sources 

settings_customise_sources(cls, settings_cls: type[BaseSettings], init_settings: PydanticBaseSettingsSource, env_settings: PydanticBaseSettingsSource, dotenv_settings: PydanticBaseSettingsSource, file_secret_settings: PydanticBaseSettingsSource) -> tuple[PydanticBaseSettingsSource, ...]
Define an order for Prefect settings sources. The order of the returned callables decides the priority of inputs; first item is the highest priority. See https://docs.pydantic.dev/latest/concepts/pydantic_settings/#customise-settings-sources

​
to_environment_variables 

to_environment_variables(self, exclude_unset: bool = False, include_secrets: bool = True, include_aliases: bool = False) -> dict[str, str]
Convert the settings object to a dictionary of environment variables.