|  | 
PathCollection path
No Javadoc found | 
|  | 
String file
No Javadoc found | 
|  | 
Map resources
No Javadoc found | 
|  | 
Set classesToIndex
No Javadoc found | 
| 
io.quarkus.deployment.builditem.AllowJNDIBuildItem
Build item that will allow the use of JNDI by default.   This should only be provided by extensions that rely on JNDI as a core part of the extension (e.g. if LDAP is a core part of what the extension does). |  | 
|  | 
AnnotationProxyProvider provider
No Javadoc found | 
|  | 
String containerImage
No Javadoc found | 
| 
io.quarkus.deployment.pkg.builditem.AppCDSControlPointBuildItem
If this build item is generated, then it means that there is a recorder step that can be used as a point at which the application loading during AppCDS generation can be stopped safely, therefore allowing Quarkus to not have to stop loading the application in the static init phase which is the default approach for AppCDS generation. |  | 
|  | 
Path appCDSDir
Directory where various files needed for AppCDS generation will reside | 
|  | 
Path appCDS
The file containing the generated AppCDS | 
|  | 
ApplicationModel appModel
No Javadoc found | 
|  | 
ApplicationArchive root
No Javadoc foundCollection applicationArchives
No Javadoc foundSet allArchives
No Javadoc found | 
|  | 
String className
No Javadoc found | 
|  | 
Predicate predicate
No Javadoc found | 
|  | 
Index index
No Javadoc found | 
|  | 
String name
No Javadoc foundString version
No Javadoc found | 
|  |  | 
|  | 
Path archiveRoot
No Javadoc foundCollection excludedFromIndexing
No Javadoc foundPathCollection rootDirs
No Javadoc foundPathCollection paths
No Javadoc found | 
|  | 
Path path
No Javadoc foundString type
No Javadoc foundMap metadata
No Javadoc found | 
|  | 
BuildTimeConfigurationReader.ReadResult readResult
No Javadoc foundLaunchMode launchMode
No Javadoc foundDevModeType devModeType
No Javadoc foundClassValue suppliers
No Javadoc found | 
|  |  | 
|  | 
Path outputDirectory
No Javadoc foundString baseName
No Javadoc foundString originalBaseName
No Javadoc foundboolean rebuild
No Javadoc foundProperties buildSystemProps
No Javadoc found | 
| 
io.quarkus.deployment.builditem.BytecodeRecorderConstantDefinitionBuildItem
The definition of a constant that can be injected into recorders via their -annotated constructor. Compared to simply passing the value to a recorder proxy, this build item allows for injecting values into recorders without introducing new dependencies from build steps that use the recorder to build steps that create the constant value. This can be useful in complex dependency graphs. | 
Holder holder
No Javadoc found | 
|  | 
ObjectLoader objectLoader
No Javadoc found | 
|  | 
boolean eager
If this is true it means the class should be loaded eagerly by a thread pool in dev mode on multithreaded systems.   Transformation is expensive, so doing it this way can speed up boot time.String classToTransform
No Javadoc foundBiFunction visitorFunction
No Javadoc foundBiFunction inputTransformer
Function that can be applied to the inout bytes before it is passed into ASM. This should only be used in very specific circumstances. At the moment the only known valid use case is jacoco, which needs access to the unmodified class file bytes.Set requireConstPoolEntry
A set of class names that need to be present in the const pool for the transformation to happen. These need to be in JVM internal format.   The transformation is only applied if at least one of the entries in the const pool is present   Note that this is an optimisation, and if another transformer is transforming the class anyway then this transformer will always be applied.boolean cacheable
No Javadoc foundint classReaderOptions
No Javadoc foundboolean continueOnFailure
No Javadoc foundint priority
No Javadoc found | 
| 
io.quarkus.deployment.builditem.CapabilityBuildItem
Represents a technical capability that can be queried by other extensions.   Build steps can inject  - a convenient build item that holds the set of registered capabilities.   An extension may provide multiple capabilities. But only a single provider of a given capability is allowed in an application. If multiple providers of the same capability are detected during the build of an application, the build will fail with the corresponding error message. By default, capabilities are not displayed to users.   Capabilities should follow the naming conventions of Java packages; e.g. . Capabilities provided by core extensions should be listed in the  interface and their name should always start with the prefix. | 
String name
No Javadoc foundString provider
No Javadoc found | 
| 
io.quarkus.deployment.builditem.ChangedClassesBuildItem
Represents the differences between classes in a dev mode restart. This can be used to avoid repeating work on restart, e.g. re-using old proxy definitions if nothing has changed for a given class. This will not always be present, it must be injected as an optional dependency. This will never be generated if the previous restart was a failure to avoid issues with inconsistent application state. | 
Map changedClassesNewVersion
No Javadoc foundMap changedClassesOldVersion
No Javadoc foundMap deletedClasses
No Javadoc foundMap addedClasses
No Javadoc found | 
| 
io.quarkus.deployment.builditem.CombinedIndexBuildItem
An index of application classes which is built from archives and dependencies that contain a certain marker file. These files include but are not limited to - beans.xml, jandex.idx and config properties. Additional marker files can be declared via . Alternatively, you can index a dependency through . Compared to , this index doesn't contain all CDI-related information. On the other hand, it can contain classes from archives/dependencies that had no CDI component declared within them. The computing index can also be used to index classes on demand. This when is called. Note that this is a mutable index as this will add additional information, so in general this Index should only be used if you actually need it. | 
IndexView index
No Javadoc foundIndexView computingIndex
No Javadoc found | 
|  | 
JavaVersion javaVersion
No Javadoc found | 
|  | 
Class configClass
No Javadoc foundSet types
No Javadoc foundSet generatedClasses
No Javadoc foundString prefix
No Javadoc foundKind kind
No Javadoc foundDotName name
No Javadoc found | 
|  | 
String propertyName
No Javadoc foundString defaultValue
No Javadoc foundString docs
No Javadoc foundString valueTypeName
No Javadoc foundList allowedValues
No Javadoc foundConfigPhase configPhase
No Javadoc found | 
|  | 
Class configClass
No Javadoc foundString prefix
No Javadoc found | 
|  | 
Class configClass
No Javadoc foundString prefix
No Javadoc found | 
|  | 
BuildTimeConfigurationReader.ReadResult readResult
No Javadoc found | 
|  | 
Class valueType
No Javadoc found | 
|  | 
CommandContainer consoleCommand
No Javadoc found | 
|  | 
RuntimeValue bannerSupplier
No Javadoc found | 
|  |  | 
|  | 
ContextHandler contextHandler
No Javadoc found | 
|  | 
ApplicationModel appModel
No Javadoc found | 
| 
io.quarkus.deployment.builditem.CuratedApplicationShutdownBuildItem
Build Item that can be used to queue shutdown tasks that are run when the is closed.   For production applications, this will be at the end of the maven/gradle build. For dev mode applications, this will be when dev mode shuts down. For tests, it will generally be at the end of the test run. However, for continuous testing this will be when the outer dev mode process shuts down. For unit style tests, this will usually be the end of the test. | 
boolean firstRun
No Javadoc foundCopyOnWriteArrayList tasks
No Javadoc foundQuarkusClassLoader baseCl
No Javadoc foundboolean registered
No Javadoc found | 
|  | 
String name
No Javadoc foundMap labels
No Javadoc found | 
|  | 
String name
No Javadoc foundContainerInfo containerInfo
No Javadoc foundMap configs
No Javadoc found | 
| 
io.quarkus.deployment.builditem.DevServicesAdditionalConfigBuildItem
An additional configuration property to set when a dev service sets another, specific configuration property.   Quarkus will make sure the relevant settings are present in both JVM and native modes.   This is used to change the defaults of extension configuration when dev services are in use, for example to enable schema management in the Hibernate ORM extension. | 
DevServicesAdditionalConfigProvider configProvider
No Javadoc foundCollection triggeringKeys
No Javadoc foundString key
No Javadoc foundString value
No Javadoc foundRunnable callbackWhenEnabled
No Javadoc found | 
|  | 
Map config
No Javadoc found | 
| 
io.quarkus.deployment.builditem.DevServicesResultBuildItem
BuildItem for running dev services Combines injected configs to the application with container id (if it exists). Processors are expected to return this build item not only when the dev service first starts, but also if a running dev service already exists. helps to manage the lifecycle of the running dev service | 
String name
No Javadoc foundString containerId
No Javadoc foundMap config
No Javadoc found | 
| 
io.quarkus.deployment.builditem.DevServicesSharedNetworkBuildItem
A marker build item that, if any instances are provided during the build, the containers started by DevServices will use a shared network. This is mainly useful in integration tests where the application container needs to be able to communicate with the services containers |  | 
|  | 
Predicate predicate
No Javadoc found | 
|  | 
Predicate predicate
No Javadoc found | 
|  | 
IsDockerWorking isDockerWorking
No Javadoc foundBoolean cachedStatus
No Javadoc found | 
|  |  | 
|  | 
BiConsumer exceptionHandler
No Javadoc found | 
| 
io.quarkus.deployment.builditem.nativeimage.ExcludeConfigBuildItem
A build item that allows extension to configure the native-image compiler to effectively ignore certain configuration files in specific jars. The  property specifies the name of the jar file or a regular expression that can be used to match multiple jar files. Matching jar files using regular expressions should be done as a last resort. The  property specifies the name of the resource file or a regular expression that can be used to match multiple resource files. For the match to work, the resources need to be part of the matched jar file(s) (see ). Matching resource files using regular expressions should be done as a last resort. See https://github.com/oracle/graal/pull/3179 for more details. | 
String jarFile
No Javadoc foundString resourceName
No Javadoc found | 
|  | 
String groupId
No Javadoc foundString artifactId
No Javadoc foundOptional classifier
No Javadoc found | 
|  | 
ScheduledExecutorService executor
No Javadoc found | 
|  | 
String extension
No Javadoc found | 
| 
io.quarkus.deployment.builditem.FeatureBuildItem
Represents a functionality provided by an extension. The name of the feature gets displayed in the log during application bootstrap.   An extension should provide at most one feature. The name must be unique. If multiple extensions register a feature of the same name the build fails.   The name of the feature should only contain lowercase characters, words are separated by dash ; e.g. . Features provided by core extensions should be listed in the  enum. | 
String name
No Javadoc found | 
|  | 
String className
No Javadoc found | 
|  | 
boolean applicationClass
No Javadoc foundString name
No Javadoc foundbyte[] classData
No Javadoc foundString source
No Javadoc found | 
|  | 
String name
No Javadoc foundbyte[] classData
No Javadoc found | 
|  |  | 
|  | 
String name
No Javadoc foundbyte[] classData
No Javadoc found | 
|  | 
String name
No Javadoc foundbyte[] classData
No Javadoc foundboolean excludeFromDevCL
No Javadoc found | 
| 
io.quarkus.deployment.builditem.HotDeploymentWatchedFileBuildItem
Identifies a file from a that, if modified, may result in a hot redeployment when in the dev mode.   A file may be identified with an exact location or a matching predicate. See  and .   If multiple build items match the same file then the final value of  is computed as a logical OR of all the  values. | 
String location
No Javadoc foundPredicate locationPredicate
No Javadoc foundboolean restartNeeded
No Javadoc found | 
|  | 
IOThreadDetector detector
No Javadoc found | 
|  | 
String groupId
No Javadoc foundString artifactId
No Javadoc foundString classifier
No Javadoc found | 
| 
io.quarkus.deployment.builditem.InitTaskBuildItem
Represents an initialization task for the application. Often extension perform some sort of initialization as part of the application startup. There are cases where we want to externalize the initialization (e.g. in a pipeline). Often the task is run using the same artifact as the application but using a different command or arguments. In the later case it might be deseriable to pass additional environment variable to both the init tasks (to enable init) and the application (to disable the init). | 
String name
No Javadoc foundOptional image
No Javadoc foundList command
No Javadoc foundList arguments
No Javadoc foundMap taskEnvVars
No Javadoc foundMap appEnvVars
No Javadoc foundboolean sharedEnvironment
No Javadoc foundboolean sharedFilesystem
No Javadoc found | 
| 
io.quarkus.deployment.builditem.InitTaskCompletedBuildItem
A symbolic class that represents that an initialization task has been complete. Similar to  but focused on initialization tasks (e.g. db migrations etc) that are run during runtime just before the application startups.   The build item is used, so that we can track when all initialization tasks have been completed. | 
String name
No Javadoc found | 
|  |  | 
|  | 
String moduleName
No Javadoc foundString packageName
No Javadoc foundGraalVM.Version exportAfter
No Javadoc foundGraalVM.Version exportBefore
No Javadoc found | 
|  | 
Path path
No Javadoc foundPath originalArtifact
No Javadoc foundPath libraryDir
No Javadoc foundString type
No Javadoc foundString classifier
No Javadoc found | 
|  | 
String path
No Javadoc found | 
|  | 
List libraryPaths
No Javadoc found | 
|  | 
List className
No Javadoc foundboolean constructors
No Javadoc foundboolean methods
No Javadoc foundboolean fields
No Javadoc found | 
|  | 
String declaringClass
No Javadoc foundString name
No Javadoc found | 
|  | 
String declaringClass
No Javadoc foundString name
No Javadoc foundString[] params
No Javadoc found | 
|  | 
String className
No Javadoc found | 
|  | 
LaunchMode launchMode
No Javadoc foundOptional devModeType
No Javadoc foundboolean auxiliaryApplication
No Javadoc foundOptional auxiliaryDevModeType
No Javadoc foundboolean test
No Javadoc found | 
|  |  | 
|  | 
boolean liveReload
No Javadoc foundSet changedResources
No Javadoc foundMap reloadContext
No Javadoc foundClassChangeInformation changeInformation
No Javadoc found | 
|  | 
String category
No Javadoc foundLevel level
No Javadoc foundboolean setMinLevelDefault
No Javadoc found | 
|  | 
Map content
No Javadoc found | 
|  | 
LogCleanupFilterElement filterElement
No Javadoc found | 
| 
io.quarkus.deployment.builditem.LogConsoleFormatBuildItem
The log console format build item. Producing this item will cause the logging subsystem to disregard its console logging formatting configuration and use the formatter provided instead. If multiple formatters are enabled at run time, a warning message is printed and only one is used. | 
RuntimeValue formatterValue
No Javadoc found | 
| 
io.quarkus.deployment.builditem.LogFileFormatBuildItem
The log file format build item. Producing this item will cause the logging subsystem to disregard its file logging formatting configuration and use the formatter provided instead. If multiple formatters are enabled at runtime, a warning message is printed and only one is used. | 
RuntimeValue formatterValue
No Javadoc found | 
|  | 
RuntimeValue handlerValue
No Javadoc found | 
|  |  | 
| 
io.quarkus.deployment.builditem.LogSyslogFormatBuildItem
The syslog format build item. Producing this item will cause the logging subsystem to disregard its syslog logging formatting configuration and use the formatter provided instead. If multiple formatters are enabled at runtime, a warning message is printed and only one is used. | 
RuntimeValue formatterValue
No Javadoc found | 
|  |  | 
|  | 
BytecodeRecorderImpl bytecodeRecorder
No Javadoc foundString generatedStartupContextClassName
No Javadoc found | 
|  | 
String className
No Javadoc found | 
|  | 
String path
No Javadoc foundMetricsCapability metricsCapability
No Javadoc found | 
|  | 
Consumer factoryConsumer
No Javadoc foundExecutionTime executionTime
No Javadoc found | 
|  | 
RuntimeValue namedHandlersMap
No Javadoc found | 
|  | 
boolean allow
No Javadoc found | 
|  | 
Path path
No Javadoc foundGraalVMVersion graalVMVersion
No Javadoc found | 
|  | 
Set runtimeInitializedClasses
No Javadoc foundSet runtimeReinitializedClasses
No Javadoc foundSet resourceBundles
No Javadoc foundSet proxyDefinitions
No Javadoc foundMap nativeImageSystemProperties
No Javadoc found | 
|  |  | 
|  | 
String qualifiedName
No Javadoc found | 
|  | 
List classes
No Javadoc found | 
|  | 
List resources
No Javadoc found | 
|  | 
String bundleName
No Javadoc foundString moduleName
No Javadoc found | 
|  | 
String path
No Javadoc found | 
| 
io.quarkus.deployment.builditem.nativeimage.NativeImageResourcePatternsBuildItem
A build item that indicates that a set of resource paths defined by regular expression patterns or globs should be included in the native image.   Globs passed to the  methods of the  are transformed to regular expressions internally. See  for the supported glob syntax.   The patterns are passed to the native image builder using . The same mechanism (and regular expression syntax) is used by 's ,  and  (since GraalVM 20.3.0) command line options.   Related build items:   Use  if you need to add a single resource Use  if you need to add a directory of resources  | 
List excludePatterns
No Javadoc foundList includePatterns
No Javadoc found | 
|  | 
NativeImageBuildRunner buildRunner
No Javadoc found | 
|  | 
String securityProvider
No Javadoc found | 
|  | 
Path path
No Javadoc foundPath libraryDir
No Javadoc found | 
|  | 
String key
No Javadoc foundString value
No Javadoc found | 
|  | 
int minFeature
No Javadoc foundint minUpdate
No Javadoc foundString warning
No Javadoc found | 
|  | 
Holder holder
No Javadoc found | 
|  | 
Path outputDirectory
No Javadoc foundString baseName
No Javadoc foundString originalBaseName
No Javadoc foundboolean rebuild
No Javadoc foundProperties buildSystemProperties
No Javadoc foundOptional includedOptionalDependencies
No Javadoc found | 
|  | 
String type
No Javadoc found | 
|  | 
String className
No Javadoc found | 
|  | 
boolean initialize
No Javadoc found | 
| 
io.quarkus.deployment.pkg.builditem.ProcessInheritIODisabledBuildItem
A build item, which indicates that the  will not work for processes launched by build steps and instead the build step will have to explicitly stream the newly launched process' STDOUT/STDERR, if the data generated on the STDOUT/STDERR of the launched process needs to be made available |  | 
|  | 
String className
No Javadoc found | 
|  | 
List closeables
No Javadoc found | 
|  |  | 
|  | 
Class clazz
No Javadoc found | 
|  | 
List className
No Javadoc foundboolean methods
No Javadoc foundboolean fields
No Javadoc foundboolean constructors
No Javadoc foundboolean weak
No Javadoc foundboolean serialization
No Javadoc foundboolean unsafeAllocated
No Javadoc found | 
|  | 
String className
No Javadoc foundString typeReachable
No Javadoc found | 
|  | 
Predicate predicate
No Javadoc found | 
|  | 
String declaringClass
No Javadoc foundString name
No Javadoc found | 
| 
io.quarkus.deployment.builditem.nativeimage.ReflectiveHierarchyBuildItem
Attempts to register a complete type hierarchy for reflection.   This is intended to be used to register types that are going to be serialized, e.g. by Jackson or some other JSON mapper.   This will do 'smart discovery' and in addition to registering the type itself it will also attempt to register the following:   - Superclasses - Component types of collections - Types used in bean properties (if method reflection is enabled) - Field types (if field reflection is enabled)   This discovery is applied recursively, so any additional types that are registered will also have their dependencies discovered | 
Type type
No Javadoc foundIndexView index
No Javadoc foundPredicate ignoreTypePredicate
No Javadoc foundPredicate ignoreFieldPredicate
No Javadoc foundPredicate ignoreMethodPredicate
No Javadoc foundString source
No Javadoc foundboolean serialization
No Javadoc found | 
|  | 
Predicate predicate
No Javadoc found | 
|  | 
String declaringClass
No Javadoc foundString name
No Javadoc foundString[] params
No Javadoc found | 
|  | 
ArtifactKey artifact
No Javadoc foundSet resources
No Javadoc found | 
|  | 
String builderClassName
No Javadoc found | 
|  | 
String key
No Javadoc foundString value
No Javadoc found | 
|  | 
Map objects
No Javadoc found | 
| 
io.quarkus.deployment.builditem.RuntimeApplicationShutdownBuildItem
Build Item that can be used to queue shutdown tasks that are run when the runtime application shuts down. This is similar to  however it applies to tasks on the 'build' side, so if a processor wants to close something after the application has completed this item lets it do this. This has no effect for production applications, and is only useful in dev/test mode. The main use case for this is for shutting down deployment side test utilities at the end of a test run. | 
Runnable closeTask
No Javadoc found | 
|  |  | 
|  | 
String className
No Javadoc found | 
| 
io.quarkus.deployment.builditem.nativeimage.RuntimeInitializedPackageBuildItem
A package that will be initialized at runtime in native mode.   WARNING: this build item should not be used in Quarkus itself and is only provided to simplify the early stages of external extensions development.   For Quarkus development, please take the time to surgically mark individual classes as runtime initialized. | 
String packageName
No Javadoc found | 
|  | 
String className
No Javadoc found | 
|  | 
String serviceInterface
No Javadoc foundList providers
No Javadoc found | 
|  | 
String name
No Javadoc found | 
|  |  | 
|  | 
ShutdownListener shutdownListener
No Javadoc found | 
|  | 
boolean defaultValue
No Javadoc found | 
|  |  | 
|  | 
Optional enableSslNativeConfig
No Javadoc found | 
|  | 
BytecodeRecorderImpl bytecodeRecorder
No Javadoc found | 
|  | 
String builderClassName
No Javadoc found | 
|  | 
RuntimeValue handlerValue
No Javadoc found | 
| 
io.quarkus.deployment.builditem.SuppressNonRuntimeConfigChangedWarningBuildItem
Allows extensions to suppress the runtime warning that Quarkus emits on startup when a non-runtime configuration options is different at runtime than build time. An example usage of this is when a user provides some test value in for a build-time only property and only provides the actual value on the command line when starting Quarkus. In such a case we don't want the value set at build time to be revealed at runtime as it could be sensitive. | 
String configKey
No Javadoc found | 
|  | 
String key
No Javadoc foundString value
No Javadoc found | 
|  | 
String annotationClassName
No Javadoc found | 
|  | 
String testClassName
No Javadoc found | 
|  | 
Predicate predicate
No Javadoc found | 
|  | 
TestListener listener
No Javadoc found | 
|  |  | 
|  | 
ThreadFactory threadFactory
No Javadoc found | 
| 
io.quarkus.deployment.builditem.TransformedClassesBuildItem
The results of applying bytecode transformation to a class. Note that this has also been abused somewhat to also represent removed resources, as the logic is the same, and it avoids have two separate mechanisms that essentially do the same thing. | 
Map transformedClassesByJar
No Javadoc foundMap transformedFilesByJar
No Javadoc found | 
|  | 
String path
No Javadoc found | 
|  | 
String path
No Javadoc found | 
|  |  | 
|  | 
String declaringClass
No Javadoc foundString fieldName
No Javadoc found | 
|  | 
Os os
No Javadoc foundString error
No Javadoc found | 
|  |  | 
|  | 
RuntimeValue handlerValue
No Javadoc found |