Package io.quarkus.deployment

Interface SnapStartConfig

@ConfigMapping(prefix="quarkus.snapstart") @ConfigRoot(phase=BUILD_TIME) public interface SnapStartConfig
SnapStart

Configure the various optimization to use SnapStart

  • Method Summary

    Modifier and Type
    Method
    Description
    Optional<Boolean>
    enable()
    Deprecated, for removal: This API element is subject to removal in a future version.
    use quarkus.snapstart.enabled instead
    Optional<Boolean>
    enabled()
    Enable/Disable SnapStart integration
    boolean
    fullWarmup()
    Start the full application during the snapshotting process.
    boolean
    generateApplicationClassList()
    When SnapStart is enabled, it generates the application class list, so it can be preloaded.
    boolean
    initializeClasses()
    if preloading classes, specify whether to do static initialization when preloading these classes.
    boolean
    preloadClasses()
    Will do a classpath search for all META-INF/quarkus-preload-classes.txt files These files contain fully qualified classnames that should be loaded in the SnapStart/CRaC beforeCheckpoint() phase.

  • Method Details

    • enabled

      Optional<Boolean> enabled()
      Enable/Disable SnapStart integration

      Default value is dependent on extensions deployed (i.e. when using AWS Lambda extensions, this will be set to true by default)

    • enable

      @Deprecated(since="3.26", forRemoval=true) Optional<Boolean> enable()
      Deprecated, for removal: This API element is subject to removal in a future version.
      use quarkus.snapstart.enabled instead
      Enable/Disable SnapStart integration

      Default value is dependent on extensions deployed (i.e. when using AWS Lambda extensions, this will be set to true by default)

    • preloadClasses

      @WithDefault("true") boolean preloadClasses()
      Will do a classpath search for all META-INF/quarkus-preload-classes.txt files These files contain fully qualified classnames that should be loaded in the SnapStart/CRaC beforeCheckpoint() phase.

    • initializeClasses

      @WithDefault("true") boolean initializeClasses()
      if preloading classes, specify whether to do static initialization when preloading these classes.

    • fullWarmup

      @WithDefault("true") boolean fullWarmup()
      Start the full application during the snapshotting process. In other words, when enabled, it performs Application.start() within SnapStart/CRaC beforeCheckpoint() phase.

    • generateApplicationClassList

      @WithDefault("true") boolean generateApplicationClassList()
      When SnapStart is enabled, it generates the application class list, so it can be preloaded. Only used if preloadClasses() is set to true.