Build Items

Here you can find a list of Build Items and the extension that provides them:

Core

Class Name Attributes

Class Name	Attributes
`io.quarkus.deployment.builditem.AdditionalApplicationArchiveBuildItem` An additional application archive. This build item can only be consumed, it should not be produced by build steps.	`PathCollection path` No Javadoc found
`io.quarkus.deployment.builditem.AdditionalApplicationArchiveMarkerBuildItem` A marker file that if present indicates that a given archive should be treated as an application archive	`String file` No Javadoc found
`io.quarkus.deployment.builditem.AdditionalBootstrapConfigSourceProviderBuildItem` Build item to use when an additional needs to be registered to the Bootstrap Config setup. This is needed because during Bootstrap Config setup, we don't auto-discover providers but we do want for example the YAML provider to be enabled.	`String providerClassName` No Javadoc found
`io.quarkus.deployment.builditem.AdditionalClassLoaderResourcesBuildItem` No Javadoc found	`Map resources` No Javadoc found
`io.quarkus.deployment.builditem.AdditionalIndexedClassesBuildItem` Allows extensions to add classes to the index available via The classes are loaded by the Deployment ClassLoader	`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).	None
`io.quarkus.deployment.builditem.AnnotationProxyBuildItem` Create annotation proxies that can be used as parameters.	`AnnotationProxyProvider provider` No Javadoc found
`io.quarkus.deployment.pkg.builditem.AppCDSContainerImageBuildItem` Indicates that a specific container image should be used to generate the AppCDS file	`String containerImage` No Javadoc found
`io.quarkus.deployment.pkg.builditem.AppCDSRequestedBuildItem` Build item to indicate to the various steps that AppCDS generation has been requested	`Path appCDSDir` Directory where various files needed for AppCDS generation will reside
`io.quarkus.deployment.pkg.builditem.AppCDSResultBuildItem` A build item containing the result of the AppCDS generation process	`Path appCDS` The file containing the generated AppCDS
`io.quarkus.deployment.builditem.AppModelProviderBuildItem` No Javadoc found	`ApplicationModel appModel` No Javadoc found
`io.quarkus.deployment.builditem.ApplicationArchivesBuildItem` No Javadoc found	`ApplicationArchive root` No Javadoc found `Collection applicationArchives` No Javadoc found `Set allArchives` No Javadoc found
`io.quarkus.deployment.builditem.ApplicationClassNameBuildItem` No Javadoc found	`String className` No Javadoc found
`io.quarkus.deployment.builditem.ApplicationClassPredicateBuildItem` Makes it possible to identify wiring classes generated for classes from additional hot deployment paths.	`Predicate predicate` No Javadoc found
`io.quarkus.deployment.builditem.ApplicationIndexBuildItem` The Jandex index of the application root	`Index index` No Javadoc found
`io.quarkus.deployment.builditem.ApplicationInfoBuildItem` No Javadoc found	`String name` No Javadoc found `String version` No Javadoc found
`io.quarkus.deployment.builditem.ApplicationStartBuildItem` A symbolic class that is produced after the startup event has been fired. At this point it should be safe to open sockets and begin processing requests	None
`io.quarkus.deployment.builditem.ArchiveRootBuildItem` No Javadoc found	`Path archiveRoot` No Javadoc found `Collection excludedFromIndexing` No Javadoc found `PathCollection rootDirs` No Javadoc found `PathCollection paths` No Javadoc found
`io.quarkus.deployment.pkg.builditem.ArtifactResultBuildItem` Represents a runnable artifact, such as an uberjar or thin jar. Most artifacts will also produce a more specialized build item, to allow them to be consumed by other build steps.	`Path path` No Javadoc found `String type` No Javadoc found `Map metadata` No Javadoc found
`io.quarkus.deployment.BooleanSupplierFactoryBuildItem` No Javadoc found	`BuildTimeConfigurationReader.ReadResult readResult` No Javadoc found `LaunchMode launchMode` No Javadoc found `DevModeType devModeType` No Javadoc found `ClassValue suppliers` No Javadoc found
`io.quarkus.deployment.builditem.BootstrapConfigSetupCompleteBuildItem` Marker used by Build Steps that consume bootstrap configuration to ensure that they run after the bootstrap config has been setup	None
`io.quarkus.deployment.pkg.builditem.BuildSystemTargetBuildItem` The build systems target directory. This is used to produce	`Path outputDirectory` No Javadoc found `String baseName` No Javadoc found `boolean rebuild` No Javadoc found `Properties buildSystemProps` No Javadoc found
`io.quarkus.deployment.builditem.BytecodeRecorderObjectLoaderBuildItem`	`ObjectLoader objectLoader` No Javadoc found
`io.quarkus.deployment.builditem.BytecodeTransformerBuildItem` 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 multi threaded systems. Transformation is expensive, so doing it this way can speed up boot time. `String classToTransform` No Javadoc found `BiFunction visitorFunction` No Javadoc found `BiFunction 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 found `int classReaderOptions` 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 found `String 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 found `Map changedClassesOldVersion` No Javadoc found `Map deletedClasses` No Javadoc found `Map 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 found `IndexView computingIndex` No Javadoc found
`io.quarkus.deployment.pkg.builditem.CompiledJavaVersionBuildItem` No Javadoc found	`JavaVersion javaVersion` No Javadoc found
`io.quarkus.deployment.builditem.ConfigClassBuildItem` No Javadoc found	`Class configClass` No Javadoc found `Set types` No Javadoc found `Set generatedClasses` No Javadoc found `String prefix` No Javadoc found `Kind kind` No Javadoc found `DotName name` No Javadoc found
`io.quarkus.deployment.builditem.ConfigDescriptionBuildItem` A build item that is not part of the standard build, but is only used to generate example config files and docs	`String propertyName` No Javadoc found `String defaultValue` No Javadoc found `String docs` No Javadoc found `String valueTypeName` No Javadoc found `List allowedValues` No Javadoc found `ConfigPhase configPhase` No Javadoc found
`io.quarkus.deployment.builditem.ConfigMappingBuildItem` No Javadoc found	`Class configClass` No Javadoc found `String prefix` No Javadoc found
`io.quarkus.deployment.builditem.ConfigPropertiesBuildItem` No Javadoc found	`Class configClass` No Javadoc found `String prefix` No Javadoc found
`io.quarkus.deployment.builditem.ConfigurationBuildItem` The build item which carries the build time configuration.	`BuildTimeConfigurationReader.ReadResult readResult` No Javadoc found
`io.quarkus.deployment.builditem.ConfigurationTypeBuildItem` The configuration type build item. Every configuration type should be registered using this build item to ensure that the converter is properly loaded in the native image case.	`Class valueType` No Javadoc found
`io.quarkus.deployment.builditem.ConsoleCommandBuildItem` No Javadoc found	`CommandContainer consoleCommand` No Javadoc found
`io.quarkus.deployment.builditem.ConsoleFormatterBannerBuildItem` No Javadoc found	`RuntimeValue bannerSupplier` No Javadoc found
`io.quarkus.deployment.console.ConsoleInstalledBuildItem` Build item that signifies that the interactive console is ready. This will not always be present, as the console may not be installed	None
`io.quarkus.deployment.builditem.ContextHandlerBuildItem` No Javadoc found	`ContextHandler contextHandler` No Javadoc found
`io.quarkus.deployment.pkg.builditem.CurateOutcomeBuildItem` No Javadoc found	`ApplicationModel appModel` No Javadoc found `AppModel effectiveModel` 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 generally be the end of the test.	`boolean firstRun` No Javadoc found `CopyOnWriteArrayList tasks` No Javadoc found `QuarkusClassLoader baseCl` No Javadoc found `boolean registered` No Javadoc found
`io.quarkus.deployment.pkg.builditem.DeploymentResultBuildItem` No Javadoc found	`String name` No Javadoc found `Map labels` No Javadoc found
`io.quarkus.deployment.dev.devservices.DevServiceDescriptionBuildItem` No Javadoc found	`String name` No Javadoc found `ContainerInfo containerInfo` No Javadoc found `Map configs` No Javadoc found
`io.quarkus.deployment.builditem.DevServicesLauncherConfigResultBuildItem` Build item that contains the final results of all	`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 found `String containerId` No Javadoc found `Map 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	None
`io.quarkus.deployment.dev.DisableInstrumentationForClassPredicateBuildItem` Allows disabling of instrumentation based reload if the changed class matches certain criteria	`Predicate predicate` No Javadoc found
`io.quarkus.deployment.dev.DisableInstrumentationForIndexPredicateBuildItem` Allows disabling of instrumentation based reload if the index of changed classes matches certain criteria	`Predicate predicate` No Javadoc found
`io.quarkus.deployment.ide.EffectiveIdeBuildItem` Contains the IDE to be opened when a request to open a class is made	`Ide ide` No Javadoc found
`io.quarkus.deployment.dev.ExceptionNotificationBuildItem` Allows for a handler to be registered when exceptions are logged. This is intended for use in dev/test mode to allow Quarkus to help the developer handle the issue.	`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 found `String resourceName` No Javadoc found
`io.quarkus.deployment.builditem.ExcludeDependencyBuildItem` Build item that defines dependencies that should not be indexed. This can be used when a dependency contains a marker file (e.g. META-INF/beans.xml).	`String groupId` No Javadoc found `String artifactId` No Javadoc found `Optional classifier` No Javadoc found
`io.quarkus.deployment.builditem.ExecutorBuildItem` The main executor for blocking tasks	`ExecutorService executor` No Javadoc found
`io.quarkus.deployment.builditem.ExtensionSslNativeSupportBuildItem` 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
`io.quarkus.deployment.builditem.nativeimage.ForceNonWeakReflectiveClassBuildItem` Forces classes that have been registered for reflection using weak semantics, to revert to normal reflection registration semantics. Essentially if this build item is used for a class that has been registered with , the field of that class is effectively false, no matter what value was supplied when creating	`String className` No Javadoc found
`io.quarkus.deployment.builditem.GeneratedClassBuildItem` No Javadoc found	`boolean applicationClass` No Javadoc found `String name` No Javadoc found `byte[] classData` No Javadoc found `String source` No Javadoc found
`io.quarkus.deployment.builditem.GeneratedFileSystemResourceBuildItem` Used when resources generated by the build should not end up in the produced runnable artifact, but in the file system inside the output directory of OutputTargetBuildItem. This are written to the file system for normal and dev mode but not for test mode	`String name` No Javadoc found `byte[] classData` No Javadoc found
`io.quarkus.deployment.builditem.GeneratedFileSystemResourceHandledBuildItem` Marker used only to ensure that the file system resources where properly written in dev-mode	None
`io.quarkus.deployment.builditem.GeneratedNativeImageClassBuildItem` A generated class that is only applicable to native images	`String name` No Javadoc found `byte[] classData` No Javadoc found
`io.quarkus.deployment.builditem.GeneratedResourceBuildItem` No Javadoc found	`String name` No Javadoc found `byte[] classData` No Javadoc found `boolean excludeFromDevCL` No Javadoc found
`io.quarkus.deployment.builditem.HotDeploymentWatchedFileBuildItem` A file that if modified may result in a hot redeployment when in the dev mode.	`String location` No Javadoc found `boolean restartNeeded` No Javadoc found
`io.quarkus.deployment.builditem.IOThreadDetectorBuildItem` A build items provides the ability to detect if the current thread is an IO thread	`IOThreadDetector detector` No Javadoc found
`io.quarkus.deployment.builditem.IndexDependencyBuildItem` Build item that defines dependencies that should be indexed. This can be used when a dependency does not contain a marker file (e.g. META-INF/beans.xml).	`String groupId` No Javadoc found `String artifactId` No Javadoc found `String classifier` No Javadoc found
`io.quarkus.deployment.builditem.nativeimage.InlineBeforeAnalysisBuildItem` If present, will force the addition of the flag during native image build	None
`io.quarkus.deployment.builditem.nativeimage.JPMSExportBuildItem` A build item that indicates that a Java package should be exported using '-J--add-exports' option to become visible to native-image	`String moduleName` No Javadoc found `String packageName` No Javadoc found
`io.quarkus.deployment.pkg.builditem.JarBuildItem` No Javadoc found	`Path path` No Javadoc found `Path originalArtifact` No Javadoc found `Path libraryDir` No Javadoc found `String type` No Javadoc found `String classifier` No Javadoc found
`io.quarkus.deployment.builditem.JavaLibraryPathAdditionalPathBuildItem` No Javadoc found	`String path` No Javadoc found
`io.quarkus.deployment.builditem.JniBuildItem` No Javadoc found	`List libraryPaths` No Javadoc found
`io.quarkus.deployment.builditem.nativeimage.JniRuntimeAccessBuildItem` Used to register a class for JNI runtime access.	`List className` No Javadoc found `boolean constructors` No Javadoc found `boolean methods` No Javadoc found `boolean fields` No Javadoc found `boolean finalFieldsWriteable` No Javadoc found
`io.quarkus.deployment.builditem.LaunchModeBuildItem` indicates the type of launch	`LaunchMode launchMode` No Javadoc found `Optional devModeType` No Javadoc found `boolean auxiliaryApplication` No Javadoc found `Optional auxiliaryDevModeType` No Javadoc found `boolean test` No Javadoc found
`io.quarkus.deployment.pkg.builditem.LegacyJarRequiredBuildItem` marker build item that extensions can use to force legacy jar creation	None
`io.quarkus.deployment.builditem.LiveReloadBuildItem` A build item that can be used to query the live reload state. It can also be used to store context information that is persistent between hot reloads.	`boolean liveReload` No Javadoc found `Set changedResources` No Javadoc found `Map reloadContext` No Javadoc found `ClassChangeInformation changeInformation` No Javadoc found
`io.quarkus.deployment.builditem.LogCategoryBuildItem` Establish the default log level of a log category.	`String category` No Javadoc found `Level level` No Javadoc found
`io.quarkus.deployment.logging.LogCleanupFilterBuildItem` Declare that a log filter should be applied to the specified `loggerName`, provided the message starts with `messageStart`.	`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.LogHandlerBuildItem` A build item for adding additional logging handlers.	`RuntimeValue handlerValue` No Javadoc found
`io.quarkus.deployment.logging.LogStreamBuildItem` No Javadoc found	None
`io.quarkus.deployment.logging.LoggingSetupBuildItem` No Javadoc found	None
`io.quarkus.deployment.builditem.MainBytecodeRecorderBuildItem` No Javadoc found	`BytecodeRecorderImpl bytecodeRecorder` No Javadoc found `String generatedStartupContextClassName` No Javadoc found
`io.quarkus.deployment.builditem.MainClassBuildItem` No Javadoc found	`String className` No Javadoc found
`io.quarkus.deployment.metrics.MetricsCapabilityBuildItem` No Javadoc found	`String path` No Javadoc found `MetricsCapability metricsCapability` No Javadoc found
`io.quarkus.deployment.metrics.MetricsFactoryConsumerBuildItem` A metrics provider will iterate over all MetricsFactory consumers, allowing them to register metrics via bytecode recording	`Consumer factoryConsumer` No Javadoc found `ExecutionTime executionTime` No Javadoc found
`io.quarkus.deployment.builditem.NamedLogHandlersBuildItem` A build item for adding additional named logging handlers.	`RuntimeValue namedHandlersMap` No Javadoc found
`io.quarkus.deployment.builditem.nativeimage.NativeImageAllowIncompleteClasspathAggregateBuildItem` Do not use directly: use instead.	`boolean allow` No Javadoc found
`io.quarkus.deployment.pkg.builditem.NativeImageBuildItem` No Javadoc found	`Path path` No Javadoc found `GraalVMVersion graalVMVersion` No Javadoc found
`io.quarkus.deployment.builditem.nativeimage.NativeImageConfigBuildItem` No Javadoc found	`Set runtimeInitializedClasses` No Javadoc found `Set runtimeReinitializedClasses` No Javadoc found `Set resourceBundles` No Javadoc found `Set proxyDefinitions` No Javadoc found `Map nativeImageSystemProperties` No Javadoc found
`io.quarkus.deployment.builditem.NativeImageEnableAllCharsetsBuildItem` No Javadoc found	None
`io.quarkus.deployment.builditem.nativeimage.NativeImageProxyDefinitionBuildItem` A build item that represents a definition that will be required in native mode. This definition takes the form of an ordered list of interfaces that this proxy will implement.	`List classes` No Javadoc found
`io.quarkus.deployment.builditem.nativeimage.NativeImageResourceBuildItem` A build item that indicates that a static resource should be included in the native image Related build items: Use if you need to add a directory of resources Use to select resource paths by regular expressions or globs	`List resources` No Javadoc found
`io.quarkus.deployment.builditem.nativeimage.NativeImageResourceBundleBuildItem` Indicates that a resource bundle should be included in the native image	`String bundleName` No Javadoc found
`io.quarkus.deployment.builditem.nativeimage.NativeImageResourceDirectoryBuildItem` A build item that indicates that directory resources should be included in the native image Related build items: Use if you need to add a single resource Use to select resource paths by regular expressions or globs	`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 API. 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 found `List includePatterns` No Javadoc found
`io.quarkus.deployment.builditem.nativeimage.NativeImageSecurityProviderBuildItem` A build item that indicates that a security provider should be included in the native image using '-H:AdditionalSecurityProviders' option	`String securityProvider` No Javadoc found
`io.quarkus.deployment.pkg.builditem.NativeImageSourceJarBuildItem` A jar that is build to run the native image	`Path path` No Javadoc found `Path libraryDir` No Javadoc found
`io.quarkus.deployment.builditem.nativeimage.NativeImageSystemPropertyBuildItem` A system property that will be set at native image build time	`String key` No Javadoc found `String value` No Javadoc found
`io.quarkus.deployment.builditem.nativeimage.NativeMinimalJavaVersionBuildItem` A build item that indicates the minimal acceptable JDK version the native-image tool was bundled with.	`int minFeature` No Javadoc found `int minUpdate` No Javadoc found `String warning` No Javadoc found
`io.quarkus.deployment.builditem.ObjectSubstitutionBuildItem` Used to capture object substitution information for non-serializable classes	`Holder holder` No Javadoc found
`io.quarkus.deployment.pkg.builditem.OutputTargetBuildItem` The location that output artifacts should be created in TODO: should we just create them in temp directories, and leave it up to the integration to move them where they want?	`Path outputDirectory` No Javadoc found `String baseName` No Javadoc found `boolean rebuild` No Javadoc found `Properties buildSystemProperties` No Javadoc found `Optional includedOptionalDependencies` No Javadoc found
`io.quarkus.deployment.pkg.builditem.PackageTypeBuildItem` Build item that extensions must create to register a package type. This allows for verification that a request package type can actually be produced	`String type` 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	None
`io.quarkus.deployment.builditem.ProxyUnwrapperBuildItem` A build item that can be used to unwrap CDI or other proxies	`Function unwrapper` No Javadoc found
`io.quarkus.deployment.builditem.QuarkusApplicationClassBuildItem` No Javadoc found	`String className` No Javadoc found
`io.quarkus.deployment.builditem.QuarkusBuildCloseablesBuildItem` No Javadoc found	`List closeables` No Javadoc found
`io.quarkus.deployment.builditem.RawCommandLineArgumentsBuildItem` A build item that represents the raw command line arguments as they were passed to the application. This can be passed directly to bytecode recorders that take a . No filtering is done on these parameters.	None
`io.quarkus.deployment.builditem.RecordableConstructorBuildItem` Indicates that the given class should be instantiated with the constructor with the most parameters when the object is bytecode recorded. An alternative to for when the objects cannot be annotated	`Class clazz` No Javadoc found
`io.quarkus.deployment.builditem.nativeimage.ReflectiveClassBuildItem` Used to register a class for reflection in native mode	`List className` No Javadoc found `boolean methods` No Javadoc found `boolean fields` No Javadoc found `boolean constructors` No Javadoc found `boolean finalFieldsWritable` No Javadoc found `boolean weak` No Javadoc found `boolean serialization` No Javadoc found
`io.quarkus.deployment.builditem.nativeimage.ReflectiveClassFinalFieldsWritablePredicateBuildItem` Used by to determine whether or not the final fields of the class should be writable (which they aren't by default) If any one of the predicates returns true for a class, then ReflectiveHierarchyStep uses that true value	`Predicate predicate` No Javadoc found
`io.quarkus.deployment.builditem.nativeimage.ReflectiveFieldBuildItem` No Javadoc found	`String declaringClass` No Javadoc found `String 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 (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 found `IndexView index` No Javadoc found `Predicate ignoreTypePredicate` No Javadoc found `Predicate ignoreFieldPredicate` No Javadoc found `Predicate ignoreMethodPredicate` No Javadoc found `String source` No Javadoc found `boolean serialization` No Javadoc found
`io.quarkus.deployment.builditem.nativeimage.ReflectiveHierarchyIgnoreWarningBuildItem` Used by to ignore reflection warning deliberately	`Predicate predicate` No Javadoc found
`io.quarkus.deployment.builditem.nativeimage.ReflectiveMethodBuildItem` No Javadoc found	`String declaringClass` No Javadoc found `String name` No Javadoc found `String[] params` No Javadoc found
`io.quarkus.deployment.builditem.RemovedResourceBuildItem` No Javadoc found	`GACT artifact` No Javadoc found `Set resources` No Javadoc found
`io.quarkus.deployment.builditem.RunTimeConfigBuilderBuildItem` No Javadoc found	`String builderClassName` No Javadoc found
`io.quarkus.deployment.builditem.RunTimeConfigurationDefaultBuildItem` A build item which specifies a configuration default value for run time, which is used to establish a default other than the one given for .	`String key` No Javadoc found `String value` No Javadoc found
`io.quarkus.deployment.builditem.RunTimeConfigurationProxyBuildItem` A build item that carries all the "fake" run time config objects for use by recorders.	`Map objects` No Javadoc found
`io.quarkus.deployment.builditem.RunTimeConfigurationSourceBuildItem` Define an additional configuration source which is used at run time.	`String className` No Javadoc found `OptionalInt priority` No Javadoc found
`io.quarkus.deployment.builditem.RunTimeConfigurationSourceValueBuildItem` This is a special build item that is intended to be used only to support bootstrap configuration in the following manner: A build step produces this BuildItem with a a payload that is obtained by calling a ( ) recorder. The build step can optionally use a configuration object that uses the config phase and pass this configuration to the recorder to allow the recorder at runtime to customize its behavior	`RuntimeValue configSourcesValue` 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
`io.quarkus.deployment.builditem.RuntimeConfigSetupCompleteBuildItem` Marker used by Build Steps that consume runtime configuration to ensure that they run after the runtime config has been setup	None
`io.quarkus.deployment.builditem.nativeimage.RuntimeInitializedClassBuildItem` A class that will be initialized at runtime in native mode.	`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
`io.quarkus.deployment.builditem.nativeimage.RuntimeReinitializedClassBuildItem` A class that will be reinitialized at runtime in native mode. This will result in the static initializer running twice.	`String className` No Javadoc found
`io.quarkus.deployment.builditem.nativeimage.ServiceProviderBuildItem` Represents a Service Provider registration. When processed, it embeds the service interface descriptor (META-INF/services/...) in the native image and registers the classes returned by for reflection (instantiation only).	`String serviceInterface` No Javadoc found `List providers` No Javadoc found
`io.quarkus.deployment.builditem.ServiceStartBuildItem` A symbolic class that represents a service start. is fired after all services are started.	`String name` No Javadoc found
`io.quarkus.deployment.builditem.ShutdownContextBuildItem` A build item that can be used to register shutdown tasks in runtime recorders.	None
`io.quarkus.deployment.builditem.ShutdownListenerBuildItem` No Javadoc found	`ShutdownListener shutdownListener` No Javadoc found
`io.quarkus.deployment.builditem.SslNativeConfigBuildItem` No Javadoc found	`Optional enableSslNativeConfig` No Javadoc found
`io.quarkus.deployment.builditem.StaticBytecodeRecorderBuildItem` No Javadoc found	`BytecodeRecorderImpl bytecodeRecorder` No Javadoc found
`io.quarkus.deployment.builditem.StaticInitConfigBuilderBuildItem` No Javadoc found	`String builderClassName` No Javadoc found
`io.quarkus.deployment.builditem.StaticInitConfigSourceFactoryBuildItem` Provides a way to register a ConfigSourceFactory in STATIC INIT.	`String factoryClassName` No Javadoc found
`io.quarkus.deployment.builditem.StaticInitConfigSourceProviderBuildItem` Provides a way to register a ConfigSourceProvider in STATIC INIT.	`String providerClassName` 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 building 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
`io.quarkus.deployment.builditem.SystemPropertyBuildItem` Represents a system property that will be set immediately on application startup.	`String key` No Javadoc found `String value` No Javadoc found
`io.quarkus.deployment.builditem.TestAnnotationBuildItem` This is an optional build item that allows us to track annotations that will define test classes It is only available during tests	`String annotationClassName` No Javadoc found
`io.quarkus.deployment.builditem.TestClassBeanBuildItem` This is an optional build item that allows us to track additional test classes that will become beans. It is only available during tests	`String testClassName` No Javadoc found
`io.quarkus.deployment.builditem.TestClassPredicateBuildItem` This is an optional build item that allows extensions to distinguish test classes from application classes. It is only available during tests.	`Predicate predicate` No Javadoc found
`io.quarkus.deployment.dev.testing.TestListenerBuildItem` No Javadoc found	`TestListener listener` No Javadoc found
`io.quarkus.deployment.dev.testing.TestSetupBuildItem` Virtual build item that is used to signify that a step must be run to setup continuous testing	None
`io.quarkus.deployment.builditem.ThreadFactoryBuildItem` 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 found `Map transformedFilesByJar` No Javadoc found
`io.quarkus.deployment.pkg.builditem.UberJarIgnoredResourceBuildItem` Ignore resources when building an Uber Jar	`String path` No Javadoc found
`io.quarkus.deployment.pkg.builditem.UberJarMergedResourceBuildItem` Merge duplicate resources from multiple JARs when building an Uber Jar	`String path` No Javadoc found
`io.quarkus.deployment.pkg.builditem.UberJarRequiredBuildItem` marker build item that extensions can use to force uber jar creation	None
`io.quarkus.deployment.builditem.nativeimage.UnsafeAccessedFieldBuildItem` No Javadoc found	`String declaringClass` No Javadoc found `String fieldName` No Javadoc found
`io.quarkus.deployment.builditem.nativeimage.UnsupportedOSBuildItem` Native-image might not be supported for a particular extension on a given OS or architecture.	`Os os` No Javadoc found `String error` No Javadoc found
`io.quarkus.deployment.pkg.builditem.UpxCompressedBuildItem` A marker build item that is used to indicate that UPX compression was performed	None
`io.quarkus.deployment.builditem.WebSocketLogHandlerBuildItem` A build item for adding the dev stream log	`RuntimeValue handlerValue` No Javadoc found

io.quarkus.deployment.builditem.AdditionalApplicationArchiveBuildItem: An additional application archive. This build item can only be consumed, it should not be produced by build steps.

PathCollection path: No Javadoc found

io.quarkus.deployment.builditem.AdditionalApplicationArchiveMarkerBuildItem: A marker file that if present indicates that a given archive should be treated as an application archive

String file: No Javadoc found

io.quarkus.deployment.builditem.AdditionalBootstrapConfigSourceProviderBuildItem: Build item to use when an additional needs to be registered to the Bootstrap Config setup. This is needed because during Bootstrap Config setup, we don't auto-discover providers but we do want for example the YAML provider to be enabled.

String providerClassName: No Javadoc found

io.quarkus.deployment.builditem.AdditionalClassLoaderResourcesBuildItem: No Javadoc found

Map resources: No Javadoc found

io.quarkus.deployment.builditem.AdditionalIndexedClassesBuildItem: Allows extensions to add classes to the index available via The classes are loaded by the Deployment ClassLoader

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).

None

io.quarkus.deployment.builditem.AnnotationProxyBuildItem: Create annotation proxies that can be used as parameters.

AnnotationProxyProvider provider: No Javadoc found

io.quarkus.deployment.pkg.builditem.AppCDSContainerImageBuildItem: Indicates that a specific container image should be used to generate the AppCDS file

String containerImage: No Javadoc found

io.quarkus.deployment.pkg.builditem.AppCDSRequestedBuildItem: Build item to indicate to the various steps that AppCDS generation has been requested

Path appCDSDir: Directory where various files needed for AppCDS generation will reside

io.quarkus.deployment.pkg.builditem.AppCDSResultBuildItem: A build item containing the result of the AppCDS generation process

Path appCDS: The file containing the generated AppCDS

io.quarkus.deployment.builditem.AppModelProviderBuildItem: No Javadoc found

ApplicationModel appModel: No Javadoc found

io.quarkus.deployment.builditem.ApplicationArchivesBuildItem: No Javadoc found

ApplicationArchive root: No Javadoc found
Collection applicationArchives: No Javadoc found
Set allArchives: No Javadoc found

io.quarkus.deployment.builditem.ApplicationClassNameBuildItem: No Javadoc found

String className: No Javadoc found

io.quarkus.deployment.builditem.ApplicationClassPredicateBuildItem: Makes it possible to identify wiring classes generated for classes from additional hot deployment paths.

Predicate predicate: No Javadoc found

io.quarkus.deployment.builditem.ApplicationIndexBuildItem: The Jandex index of the application root

Index index: No Javadoc found

io.quarkus.deployment.builditem.ApplicationInfoBuildItem: No Javadoc found

String name: No Javadoc found
String version: No Javadoc found

io.quarkus.deployment.builditem.ApplicationStartBuildItem: A symbolic class that is produced after the startup event has been fired. At this point it should be safe to open sockets and begin processing requests

None

io.quarkus.deployment.builditem.ArchiveRootBuildItem: No Javadoc found

Path archiveRoot: No Javadoc found
Collection excludedFromIndexing: No Javadoc found
PathCollection rootDirs: No Javadoc found
PathCollection paths: No Javadoc found

io.quarkus.deployment.pkg.builditem.ArtifactResultBuildItem: Represents a runnable artifact, such as an uberjar or thin jar. Most artifacts will also produce a more specialized build item, to allow them to be consumed by other build steps.

Path path: No Javadoc found
String type: No Javadoc found
Map metadata: No Javadoc found

io.quarkus.deployment.BooleanSupplierFactoryBuildItem: No Javadoc found

BuildTimeConfigurationReader.ReadResult readResult: No Javadoc found
LaunchMode launchMode: No Javadoc found
DevModeType devModeType: No Javadoc found
ClassValue suppliers: No Javadoc found

io.quarkus.deployment.builditem.BootstrapConfigSetupCompleteBuildItem: Marker used by Build Steps that consume bootstrap configuration to ensure that they run after the bootstrap config has been setup

None

io.quarkus.deployment.pkg.builditem.BuildSystemTargetBuildItem: The build systems target directory. This is used to produce

Path outputDirectory: No Javadoc found
String baseName: No Javadoc found
boolean rebuild: No Javadoc found
Properties buildSystemProps: No Javadoc found

io.quarkus.deployment.builditem.BytecodeRecorderObjectLoaderBuildItem

ObjectLoader objectLoader: No Javadoc found

io.quarkus.deployment.builditem.BytecodeTransformerBuildItem: 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 multi threaded systems.

Transformation is expensive, so doing it this way can speed up boot time.

String classToTransform

No Javadoc found

BiFunction visitorFunction

No Javadoc found

BiFunction 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 found

int classReaderOptions

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 found
String 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 found
Map changedClassesOldVersion: No Javadoc found
Map deletedClasses: No Javadoc found
Map 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 found
IndexView computingIndex: No Javadoc found

io.quarkus.deployment.pkg.builditem.CompiledJavaVersionBuildItem: No Javadoc found

JavaVersion javaVersion: No Javadoc found

io.quarkus.deployment.builditem.ConfigClassBuildItem: No Javadoc found

Class configClass: No Javadoc found
Set types: No Javadoc found
Set generatedClasses: No Javadoc found
String prefix: No Javadoc found
Kind kind: No Javadoc found
DotName name: No Javadoc found

io.quarkus.deployment.builditem.ConfigDescriptionBuildItem: A build item that is not part of the standard build, but is only used to generate example config files and docs

String propertyName: No Javadoc found
String defaultValue: No Javadoc found
String docs: No Javadoc found
String valueTypeName: No Javadoc found
List allowedValues: No Javadoc found
ConfigPhase configPhase: No Javadoc found

io.quarkus.deployment.builditem.ConfigMappingBuildItem: No Javadoc found

Class configClass: No Javadoc found
String prefix: No Javadoc found

io.quarkus.deployment.builditem.ConfigPropertiesBuildItem: No Javadoc found

Class configClass: No Javadoc found
String prefix: No Javadoc found

io.quarkus.deployment.builditem.ConfigurationBuildItem: The build item which carries the build time configuration.

BuildTimeConfigurationReader.ReadResult readResult: No Javadoc found

io.quarkus.deployment.builditem.ConfigurationTypeBuildItem: The configuration type build item. Every configuration type should be registered using this build item to ensure that the converter is properly loaded in the native image case.

Class valueType: No Javadoc found

io.quarkus.deployment.builditem.ConsoleCommandBuildItem: No Javadoc found

CommandContainer consoleCommand: No Javadoc found

io.quarkus.deployment.builditem.ConsoleFormatterBannerBuildItem: No Javadoc found

RuntimeValue bannerSupplier: No Javadoc found

io.quarkus.deployment.console.ConsoleInstalledBuildItem: Build item that signifies that the interactive console is ready. This will not always be present, as the console may not be installed

None

io.quarkus.deployment.builditem.ContextHandlerBuildItem: No Javadoc found

ContextHandler contextHandler: No Javadoc found

io.quarkus.deployment.pkg.builditem.CurateOutcomeBuildItem: No Javadoc found

ApplicationModel appModel: No Javadoc found
AppModel effectiveModel: 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 generally be the end of the test.

boolean firstRun: No Javadoc found
CopyOnWriteArrayList tasks: No Javadoc found
QuarkusClassLoader baseCl: No Javadoc found
boolean registered: No Javadoc found

io.quarkus.deployment.pkg.builditem.DeploymentResultBuildItem: No Javadoc found

String name: No Javadoc found
Map labels: No Javadoc found

io.quarkus.deployment.dev.devservices.DevServiceDescriptionBuildItem: No Javadoc found

String name: No Javadoc found
ContainerInfo containerInfo: No Javadoc found
Map configs: No Javadoc found

io.quarkus.deployment.builditem.DevServicesLauncherConfigResultBuildItem: Build item that contains the final results of all

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 found
String containerId: No Javadoc found
Map 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

None

io.quarkus.deployment.dev.DisableInstrumentationForClassPredicateBuildItem: Allows disabling of instrumentation based reload if the changed class matches certain criteria

Predicate predicate: No Javadoc found

io.quarkus.deployment.dev.DisableInstrumentationForIndexPredicateBuildItem: Allows disabling of instrumentation based reload if the index of changed classes matches certain criteria

Predicate predicate: No Javadoc found

io.quarkus.deployment.ide.EffectiveIdeBuildItem: Contains the IDE to be opened when a request to open a class is made

Ide ide: No Javadoc found

io.quarkus.deployment.dev.ExceptionNotificationBuildItem: Allows for a handler to be registered when exceptions are logged. This is intended for use in dev/test mode to allow Quarkus to help the developer handle the issue.

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 found
String resourceName: No Javadoc found

io.quarkus.deployment.builditem.ExcludeDependencyBuildItem: Build item that defines dependencies that should not be indexed. This can be used when a dependency contains a marker file (e.g. META-INF/beans.xml).

String groupId: No Javadoc found
String artifactId: No Javadoc found
Optional classifier: No Javadoc found

io.quarkus.deployment.builditem.ExecutorBuildItem: The main executor for blocking tasks

ExecutorService executor: No Javadoc found

io.quarkus.deployment.builditem.ExtensionSslNativeSupportBuildItem: 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

io.quarkus.deployment.builditem.nativeimage.ForceNonWeakReflectiveClassBuildItem: Forces classes that have been registered for reflection using weak semantics, to revert to normal reflection registration semantics. Essentially if this build item is used for a class that has been registered with , the field of that class is effectively false, no matter what value was supplied when creating

String className: No Javadoc found

io.quarkus.deployment.builditem.GeneratedClassBuildItem: No Javadoc found

boolean applicationClass: No Javadoc found
String name: No Javadoc found
byte[] classData: No Javadoc found
String source: No Javadoc found

io.quarkus.deployment.builditem.GeneratedFileSystemResourceBuildItem: Used when resources generated by the build should not end up in the produced runnable artifact, but in the file system inside the output directory of OutputTargetBuildItem. This are written to the file system for normal and dev mode but not for test mode

String name: No Javadoc found
byte[] classData: No Javadoc found

io.quarkus.deployment.builditem.GeneratedFileSystemResourceHandledBuildItem: Marker used only to ensure that the file system resources where properly written in dev-mode

None

io.quarkus.deployment.builditem.GeneratedNativeImageClassBuildItem: A generated class that is only applicable to native images

String name: No Javadoc found
byte[] classData: No Javadoc found

io.quarkus.deployment.builditem.GeneratedResourceBuildItem: No Javadoc found

String name: No Javadoc found
byte[] classData: No Javadoc found
boolean excludeFromDevCL: No Javadoc found

io.quarkus.deployment.builditem.HotDeploymentWatchedFileBuildItem: A file that if modified may result in a hot redeployment when in the dev mode.

String location: No Javadoc found
boolean restartNeeded: No Javadoc found

io.quarkus.deployment.builditem.IOThreadDetectorBuildItem: A build items provides the ability to detect if the current thread is an IO thread

IOThreadDetector detector: No Javadoc found

io.quarkus.deployment.builditem.IndexDependencyBuildItem: Build item that defines dependencies that should be indexed. This can be used when a dependency does not contain a marker file (e.g. META-INF/beans.xml).

String groupId: No Javadoc found
String artifactId: No Javadoc found
String classifier: No Javadoc found

io.quarkus.deployment.builditem.nativeimage.InlineBeforeAnalysisBuildItem: If present, will force the addition of the flag during native image build

None

io.quarkus.deployment.builditem.nativeimage.JPMSExportBuildItem: A build item that indicates that a Java package should be exported using '-J--add-exports' option to become visible to native-image

String moduleName: No Javadoc found
String packageName: No Javadoc found

io.quarkus.deployment.pkg.builditem.JarBuildItem: No Javadoc found

Path path: No Javadoc found
Path originalArtifact: No Javadoc found
Path libraryDir: No Javadoc found
String type: No Javadoc found
String classifier: No Javadoc found

io.quarkus.deployment.builditem.JavaLibraryPathAdditionalPathBuildItem: No Javadoc found

String path: No Javadoc found

io.quarkus.deployment.builditem.JniBuildItem: No Javadoc found

List libraryPaths: No Javadoc found

io.quarkus.deployment.builditem.nativeimage.JniRuntimeAccessBuildItem: Used to register a class for JNI runtime access.

List className: No Javadoc found
boolean constructors: No Javadoc found
boolean methods: No Javadoc found
boolean fields: No Javadoc found
boolean finalFieldsWriteable: No Javadoc found

io.quarkus.deployment.builditem.LaunchModeBuildItem: indicates the type of launch

LaunchMode launchMode: No Javadoc found
Optional devModeType: No Javadoc found
boolean auxiliaryApplication: No Javadoc found
Optional auxiliaryDevModeType: No Javadoc found
boolean test: No Javadoc found

io.quarkus.deployment.pkg.builditem.LegacyJarRequiredBuildItem: marker build item that extensions can use to force legacy jar creation

None

io.quarkus.deployment.builditem.LiveReloadBuildItem: A build item that can be used to query the live reload state. It can also be used to store context information that is persistent between hot reloads.

boolean liveReload: No Javadoc found
Set changedResources: No Javadoc found
Map reloadContext: No Javadoc found
ClassChangeInformation changeInformation: No Javadoc found

io.quarkus.deployment.builditem.LogCategoryBuildItem: Establish the default log level of a log category.

String category: No Javadoc found
Level level: No Javadoc found

io.quarkus.deployment.logging.LogCleanupFilterBuildItem: Declare that a log filter should be applied to the specified loggerName, provided the message starts with messageStart.

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.LogHandlerBuildItem: A build item for adding additional logging handlers.

RuntimeValue handlerValue: No Javadoc found

io.quarkus.deployment.logging.LogStreamBuildItem: No Javadoc found

None

io.quarkus.deployment.logging.LoggingSetupBuildItem: No Javadoc found

None

io.quarkus.deployment.builditem.MainBytecodeRecorderBuildItem: No Javadoc found

BytecodeRecorderImpl bytecodeRecorder: No Javadoc found
String generatedStartupContextClassName: No Javadoc found

io.quarkus.deployment.builditem.MainClassBuildItem: No Javadoc found

String className: No Javadoc found

io.quarkus.deployment.metrics.MetricsCapabilityBuildItem: No Javadoc found

String path: No Javadoc found
MetricsCapability metricsCapability: No Javadoc found

io.quarkus.deployment.metrics.MetricsFactoryConsumerBuildItem: A metrics provider will iterate over all MetricsFactory consumers, allowing them to register metrics via bytecode recording

Consumer factoryConsumer: No Javadoc found
ExecutionTime executionTime: No Javadoc found

io.quarkus.deployment.builditem.NamedLogHandlersBuildItem: A build item for adding additional named logging handlers.

RuntimeValue namedHandlersMap: No Javadoc found

io.quarkus.deployment.builditem.nativeimage.NativeImageAllowIncompleteClasspathAggregateBuildItem: Do not use directly: use instead.

boolean allow: No Javadoc found

io.quarkus.deployment.pkg.builditem.NativeImageBuildItem: No Javadoc found

Path path: No Javadoc found
GraalVMVersion graalVMVersion: No Javadoc found

io.quarkus.deployment.builditem.nativeimage.NativeImageConfigBuildItem: No Javadoc found

Set runtimeInitializedClasses: No Javadoc found
Set runtimeReinitializedClasses: No Javadoc found
Set resourceBundles: No Javadoc found
Set proxyDefinitions: No Javadoc found
Map nativeImageSystemProperties: No Javadoc found

io.quarkus.deployment.builditem.NativeImageEnableAllCharsetsBuildItem: No Javadoc found

None

io.quarkus.deployment.builditem.nativeimage.NativeImageProxyDefinitionBuildItem: A build item that represents a definition that will be required in native mode. This definition takes the form of an ordered list of interfaces that this proxy will implement.

List classes: No Javadoc found

io.quarkus.deployment.builditem.nativeimage.NativeImageResourceBuildItem

A build item that indicates that a static resource should be included in the native image

Related build items:

Use if you need to add a directory of resources
Use to select resource paths by regular expressions or globs

List resources: No Javadoc found

io.quarkus.deployment.builditem.nativeimage.NativeImageResourceBundleBuildItem: Indicates that a resource bundle should be included in the native image

String bundleName: No Javadoc found

io.quarkus.deployment.builditem.nativeimage.NativeImageResourceDirectoryBuildItem

A build item that indicates that directory resources should be included in the native image

Related build items:

Use if you need to add a single resource
Use to select resource paths by regular expressions or globs

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 API. 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 found
List includePatterns: No Javadoc found

io.quarkus.deployment.builditem.nativeimage.NativeImageSecurityProviderBuildItem: A build item that indicates that a security provider should be included in the native image using '-H:AdditionalSecurityProviders' option

String securityProvider: No Javadoc found

io.quarkus.deployment.pkg.builditem.NativeImageSourceJarBuildItem: A jar that is build to run the native image

Path path: No Javadoc found
Path libraryDir: No Javadoc found

io.quarkus.deployment.builditem.nativeimage.NativeImageSystemPropertyBuildItem: A system property that will be set at native image build time

String key: No Javadoc found
String value: No Javadoc found

io.quarkus.deployment.builditem.nativeimage.NativeMinimalJavaVersionBuildItem: A build item that indicates the minimal acceptable JDK version the native-image tool was bundled with.

int minFeature: No Javadoc found
int minUpdate: No Javadoc found
String warning: No Javadoc found

io.quarkus.deployment.builditem.ObjectSubstitutionBuildItem: Used to capture object substitution information for non-serializable classes

Holder holder: No Javadoc found

io.quarkus.deployment.pkg.builditem.OutputTargetBuildItem: The location that output artifacts should be created in TODO: should we just create them in temp directories, and leave it up to the integration to move them where they want?

Path outputDirectory: No Javadoc found
String baseName: No Javadoc found
boolean rebuild: No Javadoc found
Properties buildSystemProperties: No Javadoc found
Optional includedOptionalDependencies: No Javadoc found

io.quarkus.deployment.pkg.builditem.PackageTypeBuildItem: Build item that extensions must create to register a package type. This allows for verification that a request package type can actually be produced

String type: 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

None

io.quarkus.deployment.builditem.ProxyUnwrapperBuildItem: A build item that can be used to unwrap CDI or other proxies

Function unwrapper: No Javadoc found

io.quarkus.deployment.builditem.QuarkusApplicationClassBuildItem: No Javadoc found

String className: No Javadoc found

io.quarkus.deployment.builditem.QuarkusBuildCloseablesBuildItem: No Javadoc found

List closeables: No Javadoc found

io.quarkus.deployment.builditem.RawCommandLineArgumentsBuildItem: A build item that represents the raw command line arguments as they were passed to the application. This can be passed directly to bytecode recorders that take a . No filtering is done on these parameters.

None

io.quarkus.deployment.builditem.RecordableConstructorBuildItem: Indicates that the given class should be instantiated with the constructor with the most parameters when the object is bytecode recorded. An alternative to for when the objects cannot be annotated

Class clazz: No Javadoc found

io.quarkus.deployment.builditem.nativeimage.ReflectiveClassBuildItem: Used to register a class for reflection in native mode

List className: No Javadoc found
boolean methods: No Javadoc found
boolean fields: No Javadoc found
boolean constructors: No Javadoc found
boolean finalFieldsWritable: No Javadoc found
boolean weak: No Javadoc found
boolean serialization: No Javadoc found

io.quarkus.deployment.builditem.nativeimage.ReflectiveClassFinalFieldsWritablePredicateBuildItem: Used by to determine whether or not the final fields of the class should be writable (which they aren't by default) If any one of the predicates returns true for a class, then ReflectiveHierarchyStep uses that true value

Predicate predicate: No Javadoc found

io.quarkus.deployment.builditem.nativeimage.ReflectiveFieldBuildItem: No Javadoc found

String declaringClass: No Javadoc found
String 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 (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 found
IndexView index: No Javadoc found
Predicate ignoreTypePredicate: No Javadoc found
Predicate ignoreFieldPredicate: No Javadoc found
Predicate ignoreMethodPredicate: No Javadoc found
String source: No Javadoc found
boolean serialization: No Javadoc found

io.quarkus.deployment.builditem.nativeimage.ReflectiveHierarchyIgnoreWarningBuildItem: Used by to ignore reflection warning deliberately

Predicate predicate: No Javadoc found

io.quarkus.deployment.builditem.nativeimage.ReflectiveMethodBuildItem: No Javadoc found

String declaringClass: No Javadoc found
String name: No Javadoc found
String[] params: No Javadoc found

io.quarkus.deployment.builditem.RemovedResourceBuildItem: No Javadoc found

GACT artifact: No Javadoc found
Set resources: No Javadoc found

io.quarkus.deployment.builditem.RunTimeConfigBuilderBuildItem: No Javadoc found

String builderClassName: No Javadoc found

io.quarkus.deployment.builditem.RunTimeConfigurationDefaultBuildItem: A build item which specifies a configuration default value for run time, which is used to establish a default other than the one given for .

String key: No Javadoc found
String value: No Javadoc found

io.quarkus.deployment.builditem.RunTimeConfigurationProxyBuildItem: A build item that carries all the "fake" run time config objects for use by recorders.

Map objects: No Javadoc found

io.quarkus.deployment.builditem.RunTimeConfigurationSourceBuildItem: Define an additional configuration source which is used at run time.

String className: No Javadoc found
OptionalInt priority: No Javadoc found

io.quarkus.deployment.builditem.RunTimeConfigurationSourceValueBuildItem: This is a special build item that is intended to be used only to support bootstrap configuration in the following manner: A build step produces this BuildItem with a a payload that is obtained by calling a ( ) recorder. The build step can optionally use a configuration object that uses the config phase and pass this configuration to the recorder to allow the recorder at runtime to customize its behavior

RuntimeValue configSourcesValue: 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

io.quarkus.deployment.builditem.RuntimeConfigSetupCompleteBuildItem: Marker used by Build Steps that consume runtime configuration to ensure that they run after the runtime config has been setup

None

io.quarkus.deployment.builditem.nativeimage.RuntimeInitializedClassBuildItem: A class that will be initialized at runtime in native mode.

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

io.quarkus.deployment.builditem.nativeimage.RuntimeReinitializedClassBuildItem: A class that will be reinitialized at runtime in native mode. This will result in the static initializer running twice.

String className: No Javadoc found

io.quarkus.deployment.builditem.nativeimage.ServiceProviderBuildItem: Represents a Service Provider registration. When processed, it embeds the service interface descriptor (META-INF/services/...) in the native image and registers the classes returned by for reflection (instantiation only).

String serviceInterface: No Javadoc found
List providers: No Javadoc found

io.quarkus.deployment.builditem.ServiceStartBuildItem

A symbolic class that represents a service start.

is fired after all services are started.

String name: No Javadoc found

io.quarkus.deployment.builditem.ShutdownContextBuildItem: A build item that can be used to register shutdown tasks in runtime recorders.

None

io.quarkus.deployment.builditem.ShutdownListenerBuildItem: No Javadoc found

ShutdownListener shutdownListener: No Javadoc found

io.quarkus.deployment.builditem.SslNativeConfigBuildItem: No Javadoc found

Optional enableSslNativeConfig: No Javadoc found

io.quarkus.deployment.builditem.StaticBytecodeRecorderBuildItem: No Javadoc found

BytecodeRecorderImpl bytecodeRecorder: No Javadoc found

io.quarkus.deployment.builditem.StaticInitConfigBuilderBuildItem: No Javadoc found

String builderClassName: No Javadoc found

io.quarkus.deployment.builditem.StaticInitConfigSourceFactoryBuildItem: Provides a way to register a ConfigSourceFactory in STATIC INIT.

String factoryClassName: No Javadoc found

io.quarkus.deployment.builditem.StaticInitConfigSourceProviderBuildItem: Provides a way to register a ConfigSourceProvider in STATIC INIT.

String providerClassName: 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 building 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

io.quarkus.deployment.builditem.SystemPropertyBuildItem: Represents a system property that will be set immediately on application startup.

String key: No Javadoc found
String value: No Javadoc found

io.quarkus.deployment.builditem.TestAnnotationBuildItem: This is an optional build item that allows us to track annotations that will define test classes It is only available during tests

String annotationClassName: No Javadoc found

io.quarkus.deployment.builditem.TestClassBeanBuildItem: This is an optional build item that allows us to track additional test classes that will become beans. It is only available during tests

String testClassName: No Javadoc found

io.quarkus.deployment.builditem.TestClassPredicateBuildItem: This is an optional build item that allows extensions to distinguish test classes from application classes. It is only available during tests.

Predicate predicate: No Javadoc found

io.quarkus.deployment.dev.testing.TestListenerBuildItem: No Javadoc found

TestListener listener: No Javadoc found

io.quarkus.deployment.dev.testing.TestSetupBuildItem: Virtual build item that is used to signify that a step must be run to setup continuous testing

None

io.quarkus.deployment.builditem.ThreadFactoryBuildItem: 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 found
Map transformedFilesByJar: No Javadoc found

io.quarkus.deployment.pkg.builditem.UberJarIgnoredResourceBuildItem: Ignore resources when building an Uber Jar

String path: No Javadoc found

io.quarkus.deployment.pkg.builditem.UberJarMergedResourceBuildItem: Merge duplicate resources from multiple JARs when building an Uber Jar

String path: No Javadoc found

io.quarkus.deployment.pkg.builditem.UberJarRequiredBuildItem: marker build item that extensions can use to force uber jar creation

None

io.quarkus.deployment.builditem.nativeimage.UnsafeAccessedFieldBuildItem: No Javadoc found

String declaringClass: No Javadoc found
String fieldName: No Javadoc found

io.quarkus.deployment.builditem.nativeimage.UnsupportedOSBuildItem: Native-image might not be supported for a particular extension on a given OS or architecture.

Os os: No Javadoc found
String error: No Javadoc found

io.quarkus.deployment.pkg.builditem.UpxCompressedBuildItem: A marker build item that is used to indicate that UPX compression was performed

None

io.quarkus.deployment.builditem.WebSocketLogHandlerBuildItem: A build item for adding the dev stream log

RuntimeValue handlerValue: No Javadoc found

Agroal - SPI

Class Name Attributes

Class Name	Attributes
`io.quarkus.agroal.spi.JdbcDataSourceBuildItem` A build item for JDBC datasources. If you inject this build item when recording runtime init template calls, you are guaranteed the datasources configuration has been injected and datasources can be created.	`String name` No Javadoc found `String dbKind` No Javadoc found `boolean isDefault` No Javadoc found
`io.quarkus.agroal.spi.JdbcDataSourceSchemaReadyBuildItem` A build item which can be used to order build processors which need a datasource's schema to be ready (which really means that the tables have been created and any migration run on them) for processing.	`Collection datasourceNames` No Javadoc found
`io.quarkus.agroal.spi.JdbcDriverBuildItem` Register a JDBC driver for the Agroal extension. It allows to resolve automatically the driver from the kind, thus users don't have to set the driver anymore, except if they want to use a specific one.	`String dbKind` No Javadoc found `String driverClass` No Javadoc found `Optional xaDriverClass` No Javadoc found
`io.quarkus.agroal.spi.JdbcInitialSQLGeneratorBuildItem` No Javadoc found	`String databaseName` No Javadoc found `Supplier sqlSupplier` No Javadoc found

io.quarkus.agroal.spi.JdbcDataSourceBuildItem

A build item for JDBC datasources.

If you inject this build item when recording runtime init template calls, you are guaranteed the datasources configuration has been injected and datasources can be created.

String name: No Javadoc found
String dbKind: No Javadoc found
boolean isDefault: No Javadoc found

io.quarkus.agroal.spi.JdbcDataSourceSchemaReadyBuildItem: A build item which can be used to order build processors which need a datasource's schema to be ready (which really means that the tables have been created and any migration run on them) for processing.

Collection datasourceNames: No Javadoc found

io.quarkus.agroal.spi.JdbcDriverBuildItem

It allows to resolve automatically the driver from the kind, thus users don't have to set the driver anymore, except if they want to use a specific one.

String dbKind: No Javadoc found
String driverClass: No Javadoc found
Optional xaDriverClass: No Javadoc found

io.quarkus.agroal.spi.JdbcInitialSQLGeneratorBuildItem: No Javadoc found

String databaseName: No Javadoc found
Supplier sqlSupplier: No Javadoc found

Amazon Lambda

Class Name Attributes

Class Name	Attributes
`io.quarkus.amazon.lambda.deployment.AmazonLambdaBuildItem` No Javadoc found	`String handlerClass` No Javadoc found `String name` No Javadoc found `boolean streamHandler` No Javadoc found

io.quarkus.amazon.lambda.deployment.AmazonLambdaBuildItem: No Javadoc found

String handlerClass: No Javadoc found
String name: No Javadoc found
boolean streamHandler: No Javadoc found

Amazon Lambda - Common Deployment

Class Name Attributes

Class Name	Attributes
`io.quarkus.amazon.lambda.deployment.EventServerOverrideBuildItem` No Javadoc found	`Supplier server` No Javadoc found
`io.quarkus.amazon.lambda.deployment.LambdaObjectMapperInitializedBuildItem` No Javadoc found	None
`io.quarkus.amazon.lambda.deployment.ProvidedAmazonLambdaHandlerBuildItem` Handler provided by another extension i.e. AWS Lambda HTTP	`Class handlerClass` No Javadoc found `String provider` No Javadoc found

io.quarkus.amazon.lambda.deployment.EventServerOverrideBuildItem: No Javadoc found

Supplier server: No Javadoc found

io.quarkus.amazon.lambda.deployment.LambdaObjectMapperInitializedBuildItem: No Javadoc found

None

io.quarkus.amazon.lambda.deployment.ProvidedAmazonLambdaHandlerBuildItem: Handler provided by another extension i.e. AWS Lambda HTTP

Class handlerClass: No Javadoc found
String provider: No Javadoc found

ArC

Class Name Attributes

Class Name	Attributes
`io.quarkus.arc.deployment.AdditionalBeanBuildItem` This build item is used to specify one or more additional bean classes to be analyzed during bean discovery. By default, the resulting beans may be removed if they are considered unused and is enabled. You can change the default behavior by setting the to and via . An additional bean may have the scope defaulted via and . The default scope is only used if there is no scope declared on the bean class. The default scope should be used in cases where a bean class source is not controlled by the extension and the scope annotation cannot be declared directly on the class.	`List beanClasses` No Javadoc found `boolean removable` No Javadoc found `DotName defaultScope` No Javadoc found
`io.quarkus.arc.deployment.AdditionalStereotypeBuildItem` A map of additional stereotype classes to their instances that we want to process.	`Map stereotypes` No Javadoc found
`io.quarkus.arc.deployment.AnnotationsTransformerBuildItem` Make it possible to add, remove or alter annotations on various components. The provided transformer uses to limit the scope of transformer to classes, fields, methods, method params or a combination of those. These metadata changes are not stored in Jandex directly (Jandex is immutable) but instead in an abstraction layer. Users/extensions can access to view the updated annotation model. NOTE: Extensions that operate purely on Jandex index analysis won't be able to see any changes made via !	`AnnotationsTransformer transformer` No Javadoc found
`io.quarkus.arc.deployment.AutoAddScopeBuildItem` This build item can be used to turn a class that is not annotated with a CDI scope annotation into a bean, i.e. the default scope annotation is added automatically if all conditions are met.	`MatchPredicate matchPredicate` No Javadoc found `boolean containerServicesRequired` No Javadoc found `DotName defaultScope` No Javadoc found `boolean unremovable` No Javadoc found `String reason` No Javadoc found `int priority` No Javadoc found `BiConsumer scopeAlreadyAdded` No Javadoc found
`io.quarkus.arc.deployment.AutoInjectAnnotationBuildItem` This build item can be used to define annotations that will turn a non-static field into an injection point even if no is declared.	`List annotationNames` No Javadoc found
`io.quarkus.arc.deployment.BeanArchiveIndexBuildItem` Represent a Jandex on the whole deployment that has a complete CDI-related information. As such, this index should be used for any CDI-oriented work. Compared to this index can contain additional classes that were indexed while bean discovery was in progress. It also holds information about all programmatically registered beans and all generated bean classes.	`IndexView index` No Javadoc found `Set generatedClassNames` No Javadoc found
`io.quarkus.arc.deployment.BeanArchivePredicateBuildItem` By default, only explict/implicit bean archives (as defined by the spec) are considered during the bean discovery. However, extensions can register a logic to identify additional bean archives.	`Predicate predicate` No Javadoc found
`io.quarkus.arc.deployment.BeanContainerBuildItem` A build item that represents the fully initialized CDI bean container. This item is produced as the last step of the ArC bootstrap process.	`BeanContainer value` No Javadoc found
`io.quarkus.arc.deployment.BeanContainerListenerBuildItem` Build item that registers a listener which gets notified as soon as the CDI bean container is initialized. This is a convenient way to get access to beans and configure them as soon as the container is started. An instance of the running is provided to the listener.	`BeanContainerListener beanContainerListener` No Javadoc found
`io.quarkus.arc.deployment.BeanDefiningAnnotationBuildItem` This build item is used to specify additional bean defining annotations. See also 2.5.1. Bean defining annotations. By default, the resulting beans must not be removed even if they are considered unused and is enabled.	`DotName name` No Javadoc found `DotName defaultScope` No Javadoc found `boolean removable` No Javadoc found
`io.quarkus.arc.deployment.BeanDiscoveryFinishedBuildItem` Consumers of this build item can easily inspect all class-based beans, observers and injection points registered in the application. Synthetic beans and observers are not included. If you need to consider synthetic components as well use the instead. Additionaly, the bean resolver can be used to apply the type-safe resolution rules, e.g. to find out wheter there is a bean that would satisfy certain combination of required type and qualifiers.	None
`io.quarkus.arc.deployment.BeanRegistrationPhaseBuildItem` Bean registration phase can be used to register synthetic beans. An extension that needs to produce other build items during the "bean registration" phase should use this build item. The build step should produce a or at least inject a for this build item, otherwise it could be ignored or processed at the wrong time, e.g. after .	`BeanProcessor beanProcessor` No Javadoc found `RegistrationContext context` No Javadoc found
`io.quarkus.arc.deployment.BuildExclusionsBuildItem` A type of build item that contains only declaring classes, methods and fields that have been annotated with unsuccessful build time conditions. It aims to be used to manage the exclusion of the annotations thanks to the build time conditions also known as , , and	`Set excludedDeclaringClasses` No Javadoc found `Set excludedMethods` No Javadoc found `Set excludedFields` No Javadoc found
`io.quarkus.arc.deployment.BuildTimeConditionBuildItem` No Javadoc found	`AnnotationTarget target` No Javadoc found `boolean enabled` No Javadoc found
`io.quarkus.arc.deployment.CompletedApplicationClassPredicateBuildItem` This build item hold the "final" predicate that is used to distinguish application classes from framework/library classes.	`Predicate applicationClassPredicate` No Javadoc found
`io.quarkus.arc.deployment.configproperties.ConfigPropertiesMetadataBuildItem` No Javadoc found	`ClassInfo classInfo` No Javadoc found `String prefix` No Javadoc found `ConfigProperties.NamingStrategy namingStrategy` No Javadoc found `boolean failOnMismatchingMember` No Javadoc found `boolean needsQualifier` No Javadoc found
`io.quarkus.arc.deployment.ConfigPropertyBuildItem` Represents a mandatory config property that needs to be validated at runtime.	`String propertyName` No Javadoc found `Type propertyType` No Javadoc found `String defaultValue` No Javadoc found
`io.quarkus.arc.deployment.ContextRegistrationPhaseBuildItem` Context registration phase can be used to register custom CDI contexts. An extension that needs to produce other build items during the "context registration" phase should use this build item. The build step should produce a or at least inject a for this build item, otherwise it could be ignored or processed at the wrong time, e.g. after .	`BeanProcessor beanProcessor` No Javadoc found `ContextRegistrar.RegistrationContext context` No Javadoc found
`io.quarkus.arc.deployment.CustomScopeAnnotationsBuildItem` Holds information about all known custom scopes in the deployment and has utility methods allowing to check whether given class has some scope annotation.	`Set customScopeNames` No Javadoc found
`io.quarkus.arc.deployment.CustomScopeBuildItem` An extension that registers a custom CDI context via should produce this build item in order to contribute the custom scope annotation name to the set of bean defining annotations.	`DotName annotationName` No Javadoc found
`io.quarkus.arc.deployment.ExcludedTypeBuildItem` This build item is used to specify types to be excluded from discovery. An element value can be: a fully qualified class name, i.e. a simple class name as defined by , i.e. a package name with suffix , i.e. , matches a package a package name with suffix , i.e. , matches a package that starts with the value If any element value matches a discovered type then the type is excluded from discovery, i.e. no beans and observer methods are created from this type.	`String match` No Javadoc found
`io.quarkus.arc.deployment.GeneratedBeanBuildItem` A generated CDI bean. If this is produced then a should not be produced for the same class, as Arc will take care of this.	`String name` No Javadoc found `byte[] data` No Javadoc found `String source` No Javadoc found
`io.quarkus.arc.deployment.IgnoreSplitPackageBuildItem` Allows extensions to programmatically exclude certain packages from split package detection which is executed by . Extensions are encouraged to solve split package issues and this build item should be used primarily as temporary workaround. A package string representation can be: a full name of the package, i.e. a package name with suffix , i.e. , which matches a package that starts with provided value	`Collection excludedPackages` No Javadoc found
`io.quarkus.arc.deployment.InjectionPointTransformerBuildItem` Make it possible to programmatically modify qualifiers on an injection point.	`InjectionPointsTransformer transformer` No Javadoc found
`io.quarkus.arc.deployment.staticmethods.InterceptedStaticMethodBuildItem` Represents an intercepted static method.	`MethodInfo method` No Javadoc found `List interceptors` No Javadoc found `Set bindings` No Javadoc found `String hash` No Javadoc found
`io.quarkus.arc.deployment.staticmethods.InterceptedStaticMethodsTransformersRegisteredBuildItem` Marker build item to signal that bytecode transformers used for static method interception were registered. ASM class visitors produced by transformers registered by consumers of this build item will be run before visitors used for static method interception.	None
`io.quarkus.arc.deployment.InterceptorBindingRegistrarBuildItem` Makes it possible to register annotations that should be considered interceptor bindings but are not annotated with .	`InterceptorBindingRegistrar registrar` No Javadoc found
`io.quarkus.arc.deployment.InterceptorResolverBuildItem` Holds a reference to the interceptor resolver.	`InterceptorResolver resolver` No Javadoc found `Set interceptorBindings` No Javadoc found
`io.quarkus.arc.deployment.ObserverRegistrationPhaseBuildItem` An extension that needs to produce other build items during the "synthetic observer registration" phase should use this build item. The build step should produce a or at least inject a for this build item, otherwise it could be ignored or processed at the wrong time, e.g. after .	`BeanProcessor beanProcessor` No Javadoc found `RegistrationContext context` No Javadoc found
`io.quarkus.arc.deployment.ObserverTransformerBuildItem` This build item is used to register an instance.	`ObserverTransformer transformer` No Javadoc found
`io.quarkus.arc.deployment.QualifierRegistrarBuildItem` Makes it possible to register annotations that should be considered qualifiers but are not annotated with .	`QualifierRegistrar registrar` No Javadoc found
`io.quarkus.arc.deployment.ReflectiveBeanClassBuildItem` This build item instructs ArC to produce a for a client proxy and intercepred subclass generated for the given bean class.	`DotName className` No Javadoc found
`io.quarkus.arc.deployment.ResourceAnnotationBuildItem` This build item is used to specify resource annotations that makes it possible to resolve non-CDI injection points, such as Java EE resources.	`DotName name` No Javadoc found
`io.quarkus.arc.deployment.SynthesisFinishedBuildItem` Consumers of this build item can easily inspect all beans, observers and injection points registered in the application. Synthetic beans and observers are included. If interested in class-based components only you can use the instead. Additionaly, the bean resolver can be used to apply the type-safe resolution rules, e.g. to find out whether there is a bean that would satisfy certain combination of required type and qualifiers.	None
`io.quarkus.arc.deployment.SyntheticBeanBuildItem` Makes it possible to register a synthetic bean. Bean instances can be easily produced through a recorder and set via and .	`ExtendedBeanConfigurator configurator` No Javadoc found
`io.quarkus.arc.deployment.SyntheticBeansRuntimeInitBuildItem` This build item should be consumed by build steps that require RUNTIME_INIT synthetic beans to be initialized.	None
`io.quarkus.arc.deployment.TransformedAnnotationsBuildItem` Makes it possible to query transformed annotations for a given annotation target.	`BeanDeployment beanDeployment` No Javadoc found
`io.quarkus.arc.deployment.UnremovableBeanBuildItem` This build item is used to exclude beans that would be normally removed if the config property is set to true. Consider using one of the convenient static factory methods such as : @BuildStep UnremovableBeanBuildItem unremovable() { // Any bean that has MyService in its set of bean types is considered unremovable return UnremovableBeanBuildItem.beanTypes(MyService.class); Alternatively, you could make use of the pre-built predicate classes such as : @BuildStep UnremovableBeanBuildItem unremovable() { // A bean whose bean class FQCN is equal to org.acme.MyService is considered unremovable return new UnremovableBeanBuildItem(new BeanClassNameExclusion("org.acme.MyService"));	`Predicate predicate` No Javadoc found
`io.quarkus.arc.deployment.ValidationPhaseBuildItem` Validation phase can be used to validate the deployment. An extension that needs to produce other build items during the "validation" phase should use this build item. The build step should produce a or at least inject a for this build item, otherwise it could be ignored or processed at the wrong time, e.g. after .	`BeanProcessor beanProcessor` No Javadoc found `BeanDeploymentValidator.ValidationContext context` No Javadoc found

io.quarkus.arc.deployment.AdditionalBeanBuildItem

This build item is used to specify one or more additional bean classes to be analyzed during bean discovery.

By default, the resulting beans may be removed if they are considered unused and is enabled. You can change the default behavior by setting the to and via .

An additional bean may have the scope defaulted via and . The default scope is only used if there is no scope declared on the bean class. The default scope should be used in cases where a bean class source is not controlled by the extension and the scope annotation cannot be declared directly on the class.

List beanClasses: No Javadoc found
boolean removable: No Javadoc found
DotName defaultScope: No Javadoc found

io.quarkus.arc.deployment.AdditionalStereotypeBuildItem: A map of additional stereotype classes to their instances that we want to process.

Map stereotypes: No Javadoc found

io.quarkus.arc.deployment.AnnotationsTransformerBuildItem: Make it possible to add, remove or alter annotations on various components. The provided transformer uses to limit the scope of transformer to classes, fields, methods, method params or a combination of those. These metadata changes are not stored in Jandex directly (Jandex is immutable) but instead in an abstraction layer. Users/extensions can access to view the updated annotation model. NOTE: Extensions that operate purely on Jandex index analysis won't be able to see any changes made via !

AnnotationsTransformer transformer: No Javadoc found

io.quarkus.arc.deployment.AutoAddScopeBuildItem: This build item can be used to turn a class that is not annotated with a CDI scope annotation into a bean, i.e. the default scope annotation is added automatically if all conditions are met.

MatchPredicate matchPredicate: No Javadoc found
boolean containerServicesRequired: No Javadoc found
DotName defaultScope: No Javadoc found
boolean unremovable: No Javadoc found
String reason: No Javadoc found
int priority: No Javadoc found
BiConsumer scopeAlreadyAdded: No Javadoc found

io.quarkus.arc.deployment.AutoInjectAnnotationBuildItem: This build item can be used to define annotations that will turn a non-static field into an injection point even if no is declared.

List annotationNames: No Javadoc found

io.quarkus.arc.deployment.BeanArchiveIndexBuildItem: Represent a Jandex on the whole deployment that has a complete CDI-related information. As such, this index should be used for any CDI-oriented work. Compared to this index can contain additional classes that were indexed while bean discovery was in progress. It also holds information about all programmatically registered beans and all generated bean classes.

IndexView index: No Javadoc found
Set generatedClassNames: No Javadoc found

io.quarkus.arc.deployment.BeanArchivePredicateBuildItem: By default, only explict/implicit bean archives (as defined by the spec) are considered during the bean discovery. However, extensions can register a logic to identify additional bean archives.

Predicate predicate: No Javadoc found

io.quarkus.arc.deployment.BeanContainerBuildItem: A build item that represents the fully initialized CDI bean container. This item is produced as the last step of the ArC bootstrap process.

BeanContainer value: No Javadoc found

io.quarkus.arc.deployment.BeanContainerListenerBuildItem: Build item that registers a listener which gets notified as soon as the CDI bean container is initialized. This is a convenient way to get access to beans and configure them as soon as the container is started. An instance of the running is provided to the listener.

BeanContainerListener beanContainerListener: No Javadoc found

io.quarkus.arc.deployment.BeanDefiningAnnotationBuildItem

This build item is used to specify additional bean defining annotations. See also 2.5.1. Bean defining annotations.

By default, the resulting beans must not be removed even if they are considered unused and is enabled.

DotName name: No Javadoc found
DotName defaultScope: No Javadoc found
boolean removable: No Javadoc found

io.quarkus.arc.deployment.BeanDiscoveryFinishedBuildItem

Consumers of this build item can easily inspect all class-based beans, observers and injection points registered in the application. Synthetic beans and observers are not included. If you need to consider synthetic components as well use the instead.

Additionaly, the bean resolver can be used to apply the type-safe resolution rules, e.g. to find out wheter there is a bean that would satisfy certain combination of required type and qualifiers.

None

io.quarkus.arc.deployment.BeanRegistrationPhaseBuildItem

Bean registration phase can be used to register synthetic beans.

An extension that needs to produce other build items during the "bean registration" phase should use this build item. The build step should produce a or at least inject a for this build item, otherwise it could be ignored or processed at the wrong time, e.g. after .

BeanProcessor beanProcessor: No Javadoc found
RegistrationContext context: No Javadoc found

io.quarkus.arc.deployment.BuildExclusionsBuildItem: A type of build item that contains only declaring classes, methods and fields that have been annotated with unsuccessful build time conditions. It aims to be used to manage the exclusion of the annotations thanks to the build time conditions also known as , , and

Set excludedDeclaringClasses: No Javadoc found
Set excludedMethods: No Javadoc found
Set excludedFields: No Javadoc found

io.quarkus.arc.deployment.BuildTimeConditionBuildItem: No Javadoc found

AnnotationTarget target: No Javadoc found
boolean enabled: No Javadoc found

io.quarkus.arc.deployment.CompletedApplicationClassPredicateBuildItem: This build item hold the "final" predicate that is used to distinguish application classes from framework/library classes.

Predicate applicationClassPredicate: No Javadoc found

io.quarkus.arc.deployment.configproperties.ConfigPropertiesMetadataBuildItem: No Javadoc found

ClassInfo classInfo: No Javadoc found
String prefix: No Javadoc found
ConfigProperties.NamingStrategy namingStrategy: No Javadoc found
boolean failOnMismatchingMember: No Javadoc found
boolean needsQualifier: No Javadoc found

io.quarkus.arc.deployment.ConfigPropertyBuildItem: Represents a mandatory config property that needs to be validated at runtime.

String propertyName: No Javadoc found
Type propertyType: No Javadoc found
String defaultValue: No Javadoc found

io.quarkus.arc.deployment.ContextRegistrationPhaseBuildItem

Context registration phase can be used to register custom CDI contexts.

An extension that needs to produce other build items during the "context registration" phase should use this build item. The build step should produce a or at least inject a for this build item, otherwise it could be ignored or processed at the wrong time, e.g. after .

BeanProcessor beanProcessor: No Javadoc found
ContextRegistrar.RegistrationContext context: No Javadoc found

io.quarkus.arc.deployment.CustomScopeAnnotationsBuildItem: Holds information about all known custom scopes in the deployment and has utility methods allowing to check whether given class has some scope annotation.

Set customScopeNames: No Javadoc found

io.quarkus.arc.deployment.CustomScopeBuildItem: An extension that registers a custom CDI context via should produce this build item in order to contribute the custom scope annotation name to the set of bean defining annotations.

DotName annotationName: No Javadoc found

io.quarkus.arc.deployment.ExcludedTypeBuildItem

This build item is used to specify types to be excluded from discovery.

An element value can be:

a fully qualified class name, i.e.
a simple class name as defined by , i.e.
a package name with suffix , i.e. , matches a package
a package name with suffix , i.e. , matches a package that starts with the value

If any element value matches a discovered type then the type is excluded from discovery, i.e. no beans and observer methods are created from this type.

String match: No Javadoc found

io.quarkus.arc.deployment.GeneratedBeanBuildItem: A generated CDI bean. If this is produced then a should not be produced for the same class, as Arc will take care of this.

String name: No Javadoc found
byte[] data: No Javadoc found
String source: No Javadoc found

io.quarkus.arc.deployment.IgnoreSplitPackageBuildItem

Allows extensions to programmatically exclude certain packages from split package detection which is executed by . Extensions are encouraged to solve split package issues and this build item should be used primarily as temporary workaround.

A package string representation can be:

a full name of the package, i.e.
a package name with suffix , i.e. , which matches a package that starts with provided value

Collection excludedPackages: No Javadoc found

io.quarkus.arc.deployment.InjectionPointTransformerBuildItem: Make it possible to programmatically modify qualifiers on an injection point.

InjectionPointsTransformer transformer: No Javadoc found

io.quarkus.arc.deployment.staticmethods.InterceptedStaticMethodBuildItem: Represents an intercepted static method.

MethodInfo method: No Javadoc found
List interceptors: No Javadoc found
Set bindings: No Javadoc found
String hash: No Javadoc found

io.quarkus.arc.deployment.staticmethods.InterceptedStaticMethodsTransformersRegisteredBuildItem

Marker build item to signal that bytecode transformers used for static method interception were registered.

ASM class visitors produced by transformers registered by consumers of this build item will be run before visitors used for static method interception.

None

io.quarkus.arc.deployment.InterceptorBindingRegistrarBuildItem: Makes it possible to register annotations that should be considered interceptor bindings but are not annotated with .

InterceptorBindingRegistrar registrar: No Javadoc found

io.quarkus.arc.deployment.InterceptorResolverBuildItem: Holds a reference to the interceptor resolver.

InterceptorResolver resolver: No Javadoc found
Set interceptorBindings: No Javadoc found

io.quarkus.arc.deployment.ObserverRegistrationPhaseBuildItem: An extension that needs to produce other build items during the "synthetic observer registration" phase should use this build item. The build step should produce a or at least inject a for this build item, otherwise it could be ignored or processed at the wrong time, e.g. after .

BeanProcessor beanProcessor: No Javadoc found
RegistrationContext context: No Javadoc found

io.quarkus.arc.deployment.ObserverTransformerBuildItem: This build item is used to register an instance.

ObserverTransformer transformer: No Javadoc found

io.quarkus.arc.deployment.QualifierRegistrarBuildItem: Makes it possible to register annotations that should be considered qualifiers but are not annotated with .

QualifierRegistrar registrar: No Javadoc found

io.quarkus.arc.deployment.ReflectiveBeanClassBuildItem: This build item instructs ArC to produce a for a client proxy and intercepred subclass generated for the given bean class.

DotName className: No Javadoc found

io.quarkus.arc.deployment.ResourceAnnotationBuildItem: This build item is used to specify resource annotations that makes it possible to resolve non-CDI injection points, such as Java EE resources.

DotName name: No Javadoc found

io.quarkus.arc.deployment.SynthesisFinishedBuildItem

Consumers of this build item can easily inspect all beans, observers and injection points registered in the application. Synthetic beans and observers are included. If interested in class-based components only you can use the instead.

Additionaly, the bean resolver can be used to apply the type-safe resolution rules, e.g. to find out whether there is a bean that would satisfy certain combination of required type and qualifiers.

None

io.quarkus.arc.deployment.SyntheticBeanBuildItem

Makes it possible to register a synthetic bean.

Bean instances can be easily produced through a recorder and set via and .

ExtendedBeanConfigurator configurator: No Javadoc found

io.quarkus.arc.deployment.SyntheticBeansRuntimeInitBuildItem: This build item should be consumed by build steps that require RUNTIME_INIT synthetic beans to be initialized.

None

io.quarkus.arc.deployment.TransformedAnnotationsBuildItem: Makes it possible to query transformed annotations for a given annotation target.

BeanDeployment beanDeployment: No Javadoc found

io.quarkus.arc.deployment.UnremovableBeanBuildItem

This build item is used to exclude beans that would be normally removed if the config property is set to true.

Consider using one of the convenient static factory methods such as :

 @BuildStep UnremovableBeanBuildItem unremovable() { // Any bean that has MyService in its set of bean types is considered unremovable return UnremovableBeanBuildItem.beanTypes(MyService.class);

Alternatively, you could make use of the pre-built predicate classes such as :

 @BuildStep UnremovableBeanBuildItem unremovable() { // A bean whose bean class FQCN is equal to org.acme.MyService is considered unremovable return new UnremovableBeanBuildItem(new BeanClassNameExclusion("org.acme.MyService"));

Predicate predicate: No Javadoc found

io.quarkus.arc.deployment.ValidationPhaseBuildItem

Validation phase can be used to validate the deployment.

An extension that needs to produce other build items during the "validation" phase should use this build item. The build step should produce a or at least inject a for this build item, otherwise it could be ignored or processed at the wrong time, e.g. after .

BeanProcessor beanProcessor: No Javadoc found
BeanDeploymentValidator.ValidationContext context: No Javadoc found

Cache

Class Name Attributes

Class Name	Attributes
`io.quarkus.cache.deployment.AdditionalCacheNameBuildItem` Build item used to ensure that a cache of the specified name is created at runtime This is used in order to create caches when means other than the standard cache annotations are used	`String name` No Javadoc found
`io.quarkus.cache.deployment.CacheNamesBuildItem` This build item is used to pass the full list of cache names from the validation step to the recording step.	`Set names` No Javadoc found

io.quarkus.cache.deployment.AdditionalCacheNameBuildItem: Build item used to ensure that a cache of the specified name is created at runtime This is used in order to create caches when means other than the standard cache annotations are used

String name: No Javadoc found

io.quarkus.cache.deployment.CacheNamesBuildItem: This build item is used to pass the full list of cache names from the validation step to the recording step.

Set names: No Javadoc found

Container Image - SPI

Class Name Attributes

Class Name	Attributes
`io.quarkus.container.spi.AvailableContainerImageExtensionBuildItem` No Javadoc found	`String name` No Javadoc found
`io.quarkus.container.spi.BaseImageInfoBuildItem` No Javadoc found	`String image` No Javadoc found
`io.quarkus.container.spi.ContainerImageBuildRequestBuildItem` No Javadoc found	None
`io.quarkus.container.spi.ContainerImageBuilderBuildItem` A that represents eligible container image builders. Some extension have a dependency on external services (e.g. openshift and s2i). So, the persennce of the extension alone is not enough to let the build system know that extension is usable. This build item is produced only when all environment requirements are met.	`String builder` No Javadoc found
`io.quarkus.container.spi.ContainerImageInfoBuildItem` No Javadoc found	`Optional registry` The container registry to use `String imagePrefix` No Javadoc found `String repository` No Javadoc found `String tag` No Javadoc found `Set additionalTags` No Javadoc found
`io.quarkus.container.spi.ContainerImageLabelBuildItem` A label to be added to the built container image This will only have an effect if the extension building the container image supports adding custom labels (like the Jib extension)	`String name` No Javadoc found `String value` No Javadoc found
`io.quarkus.container.spi.ContainerImagePushRequestBuildItem` No Javadoc found	None
`io.quarkus.container.spi.FallbackContainerImageRegistryBuildItem` No Javadoc found	`String registry` No Javadoc found

io.quarkus.container.spi.AvailableContainerImageExtensionBuildItem: No Javadoc found

String name: No Javadoc found

io.quarkus.container.spi.BaseImageInfoBuildItem: No Javadoc found

String image: No Javadoc found

io.quarkus.container.spi.ContainerImageBuildRequestBuildItem: No Javadoc found

None

io.quarkus.container.spi.ContainerImageBuilderBuildItem: A that represents eligible container image builders. Some extension have a dependency on external services (e.g. openshift and s2i). So, the persennce of the extension alone is not enough to let the build system know that extension is usable. This build item is produced only when all environment requirements are met.

String builder: No Javadoc found

io.quarkus.container.spi.ContainerImageInfoBuildItem: No Javadoc found

Optional registry: The container registry to use
String imagePrefix: No Javadoc found
String repository: No Javadoc found
String tag: No Javadoc found
Set additionalTags: No Javadoc found

io.quarkus.container.spi.ContainerImageLabelBuildItem: A label to be added to the built container image This will only have an effect if the extension building the container image supports adding custom labels (like the Jib extension)

String name: No Javadoc found
String value: No Javadoc found

io.quarkus.container.spi.ContainerImagePushRequestBuildItem: No Javadoc found

None

io.quarkus.container.spi.FallbackContainerImageRegistryBuildItem: No Javadoc found

String registry: No Javadoc found

Core - Test Extension

Class Name Attributes

Class Name	Attributes
`io.quarkus.extest.deployment.PublicKeyBuildItem` No Javadoc found	`DSAPublicKey publicKey` No Javadoc found
`io.quarkus.extest.deployment.RuntimeServiceBuildItem` No Javadoc found	`RuntimeValue service` No Javadoc found
`io.quarkus.extest.deployment.TestBeanBuildItem` Represent beans annotated with @TestAnnotation that also implement IConfigConsumer	`Class configConsumer` No Javadoc found

io.quarkus.extest.deployment.PublicKeyBuildItem: No Javadoc found

DSAPublicKey publicKey: No Javadoc found

io.quarkus.extest.deployment.RuntimeServiceBuildItem: No Javadoc found

RuntimeValue service: No Javadoc found

io.quarkus.extest.deployment.TestBeanBuildItem: Represent beans annotated with @TestAnnotation that also implement IConfigConsumer

Class configConsumer: No Javadoc found

Datasource

Class Name Attributes

Class Name	Attributes
`io.quarkus.datasource.deployment.spi.DefaultDataSourceDbKindBuildItem` A build item that represents the "quarkus.datasource.db-kind" value. This is generated by specific extensions that are meant to take away the burden of configuring anything datasource related from the user.	`String dbKind` No Javadoc found `Class callerClass` No Javadoc found `String scope` No Javadoc found
`io.quarkus.datasource.deployment.spi.DevServicesDatasourceConfigurationHandlerBuildItem` A handler that can map an automatic datasource to the relevant config properties.	`String dbKind` The type of database this is for `BiFunction configProviderFunction` The function that provides the runtime config given a running DevServices database `Predicate checkConfiguredFunction` Function that checks if a given datasource has been configured. If it has been configured generally the DevServices will not be started.
`io.quarkus.datasource.deployment.spi.DevServicesDatasourceProviderBuildItem` A provider that knows how to start a database of a specific type.	`String database` No Javadoc found `DevServicesDatasourceProvider devDBProvider` No Javadoc found
`io.quarkus.datasource.deployment.spi.DevServicesDatasourceResultBuildItem` No Javadoc found	`DbResult defaultDatasource` No Javadoc found `Map namedDatasources` No Javadoc found

io.quarkus.datasource.deployment.spi.DefaultDataSourceDbKindBuildItem: A build item that represents the "quarkus.datasource.db-kind" value. This is generated by specific extensions that are meant to take away the burden of configuring anything datasource related from the user.

String dbKind: No Javadoc found
Class callerClass: No Javadoc found
String scope: No Javadoc found

io.quarkus.datasource.deployment.spi.DevServicesDatasourceConfigurationHandlerBuildItem: A handler that can map an automatic datasource to the relevant config properties.

String dbKind: The type of database this is for
BiFunction configProviderFunction: The function that provides the runtime config given a running DevServices database
Predicate checkConfiguredFunction: Function that checks if a given datasource has been configured. If it has been configured generally the DevServices will not be started.

io.quarkus.datasource.deployment.spi.DevServicesDatasourceProviderBuildItem: A provider that knows how to start a database of a specific type.

String database: No Javadoc found
DevServicesDatasourceProvider devDBProvider: No Javadoc found

io.quarkus.datasource.deployment.spi.DevServicesDatasourceResultBuildItem: No Javadoc found

DbResult defaultDatasource: No Javadoc found
Map namedDatasources: No Javadoc found

Elasticsearch REST client common

Class Name Attributes

Class Name	Attributes
`io.quarkus.elasticsearch.restclient.common.deployment.DevservicesElasticsearchBuildItem` No Javadoc found	`String hostsConfigProperty` No Javadoc found `String version` No Javadoc found `Distribution distribution` No Javadoc found

io.quarkus.elasticsearch.restclient.common.deployment.DevservicesElasticsearchBuildItem: No Javadoc found

String hostsConfigProperty: No Javadoc found
String version: No Javadoc found
Distribution distribution: No Javadoc found

Elytron Security

Class Name Attributes

Class Name	Attributes
`io.quarkus.elytron.security.deployment.ElytronPasswordMarkerBuildItem` No Javadoc found	None
`io.quarkus.elytron.security.deployment.ElytronTokenMarkerBuildItem` No Javadoc found	None
`io.quarkus.elytron.security.deployment.SecurityDomainBuildItem` This represent a instance output by a build step.	`RuntimeValue securityDomain` No Javadoc found
`io.quarkus.elytron.security.deployment.SecurityRealmBuildItem` A build item for the runtime values created for the deployment. These are combined into a single by the .	`RuntimeValue realm` No Javadoc found `String name` No Javadoc found `Runnable runtimeLoadTask` No Javadoc found

io.quarkus.elytron.security.deployment.ElytronPasswordMarkerBuildItem: No Javadoc found

None

io.quarkus.elytron.security.deployment.ElytronTokenMarkerBuildItem: No Javadoc found

None

io.quarkus.elytron.security.deployment.SecurityDomainBuildItem: This represent a instance output by a build step.

RuntimeValue securityDomain: No Javadoc found

io.quarkus.elytron.security.deployment.SecurityRealmBuildItem: A build item for the runtime values created for the deployment. These are combined into a single by the .

RuntimeValue realm: No Javadoc found
String name: No Javadoc found
Runnable runtimeLoadTask: No Javadoc found

Funqy Server Common

Class Name Attributes

Class Name	Attributes
`io.quarkus.funqy.deployment.FunctionBuildItem` No Javadoc found	`String className` No Javadoc found `String methodName` No Javadoc found `String functionName` No Javadoc found
`io.quarkus.funqy.deployment.FunctionInitializedBuildItem` No Javadoc found	None

io.quarkus.funqy.deployment.FunctionBuildItem: No Javadoc found

String className: No Javadoc found
String methodName: No Javadoc found
String functionName: No Javadoc found

io.quarkus.funqy.deployment.FunctionInitializedBuildItem: No Javadoc found

None

gRPC

Class Name Attributes

Class Name	Attributes
`io.quarkus.grpc.deployment.AdditionalGlobalInterceptorBuildItem` No Javadoc found	`String interceptorClass` No Javadoc found
`io.quarkus.grpc.deployment.BindableServiceBuildItem` No Javadoc found	`DotName serviceClass` No Javadoc found `List blockingMethods` No Javadoc found
`io.quarkus.grpc.deployment.DelegatingGrpcBeanBuildItem` No Javadoc found	`ClassInfo generatedBean` No Javadoc found `ClassInfo userDefinedBean` No Javadoc found
`io.quarkus.grpc.deployment.GrpcClientBuildItem` No Javadoc found	`String clientName` No Javadoc found `Set clients` No Javadoc found

io.quarkus.grpc.deployment.AdditionalGlobalInterceptorBuildItem: No Javadoc found

String interceptorClass: No Javadoc found

io.quarkus.grpc.deployment.BindableServiceBuildItem: No Javadoc found

DotName serviceClass: No Javadoc found
List blockingMethods: No Javadoc found

io.quarkus.grpc.deployment.DelegatingGrpcBeanBuildItem: No Javadoc found

ClassInfo generatedBean: No Javadoc found
ClassInfo userDefinedBean: No Javadoc found

io.quarkus.grpc.deployment.GrpcClientBuildItem: No Javadoc found

String clientName: No Javadoc found
Set clients: No Javadoc found

Hibernate ORM

Class Name Attributes

Class Name	Attributes
`io.quarkus.hibernate.orm.deployment.AdditionalJpaModelBuildItem` Additional Jpa model class that we need to index	`String className` No Javadoc found
`io.quarkus.hibernate.orm.deployment.integration.HibernateOrmIntegrationRuntimeConfiguredBuildItem` No Javadoc found	`String integrationName` No Javadoc found `String persistenceUnitName` No Javadoc found `HibernateOrmIntegrationRuntimeInitListener initListener` No Javadoc found
`io.quarkus.hibernate.orm.deployment.integration.HibernateOrmIntegrationStaticConfiguredBuildItem` No Javadoc found	`String integrationName` No Javadoc found `String persistenceUnitName` No Javadoc found `HibernateOrmIntegrationStaticInitListener initListener` No Javadoc found `boolean xmlMappingRequired` No Javadoc found
`io.quarkus.hibernate.orm.deployment.ImpliedBlockingPersistenceUnitTypeBuildItem` Quarkus attempts to automatically define a persistence unit when the Hibernate ORM extension is enabled, a default datasource is defined, and there are mapped entities. This build item represents the decision about creating such an implied persistence unit; it's modelled as a BuildItem so that other extensions can be aware of such a persistence unit being defined (e.g. Hibernate Reactive needs to know).	`boolean shouldGenerateOne` No Javadoc found
`io.quarkus.hibernate.orm.deployment.JpaModelBuildItem` Internal model to represent which objects are likely needing enhancement via HibernateEntityEnhancer.	`Set allModelPackageNames` No Javadoc found `Set entityClassNames` No Javadoc found `Set potentialCdiBeanClassNames` No Javadoc found `Set allModelClassNames` No Javadoc found `Map xmlMappingsByPU` No Javadoc found
`io.quarkus.hibernate.orm.deployment.JpaModelIndexBuildItem` Provides the Jandex index of the application, combined with the index of additional JPA components that might have been generated.	`CompositeIndex index` No Javadoc found
`io.quarkus.hibernate.orm.deployment.JpaModelPersistenceUnitContributionBuildItem` Provides configuration specific to a persistence unit and necessary to build the JPA model.	`String persistenceUnitName` No Javadoc found `URL persistenceUnitRootURL` No Javadoc found `Set explicitlyListedClassNames` No Javadoc found `Set explicitlyListedMappingFiles` No Javadoc found
`io.quarkus.hibernate.orm.deployment.JpaModelPersistenceUnitMappingBuildItem` Internal model to hold the mapping linking a JPA entity to its corresponding persistence units.	`Map entityToPersistenceUnits` No Javadoc found
`io.quarkus.hibernate.orm.deployment.PersistenceProviderSetUpBuildItem` Indicates that the Hibernate ORM persistence units have been started.	None
`io.quarkus.hibernate.orm.deployment.PersistenceUnitDescriptorBuildItem` Not to be confused with PersistenceXmlDescriptorBuildItem, which holds items of the same type. This build item represents a later phase, and might include the implicit configuration definitions that are automatically defined by Quarkus.	`ParsedPersistenceXmlDescriptor descriptor` No Javadoc found `Optional dataSource` No Javadoc found `MultiTenancyStrategy multiTenancyStrategy` No Javadoc found `String multiTenancySchemaDataSource` No Javadoc found `List xmlMappings` No Javadoc found `boolean isReactive` No Javadoc found `boolean fromPersistenceXml` No Javadoc found
`io.quarkus.hibernate.orm.deployment.PersistenceXmlDescriptorBuildItem` Provides instances of , the raw representation of a persistence.xml file as it is after being located and parsed. Exposed as a possible integration API: other extensions can produce additional configuration instances.	`ParsedPersistenceXmlDescriptor descriptor` No Javadoc found
`io.quarkus.hibernate.orm.deployment.ProxyDefinitionsBuildItem` Contains the reference to the class definitions of the proxies that Hibernate ORM might require at runtime. In Quarkus such proxies are built upfront, during the build. This needs to be a separate build item from other components so to avoid cycles in the rather complex build graph required by this extension.	`PreGeneratedProxies proxies` No Javadoc found

io.quarkus.hibernate.orm.deployment.AdditionalJpaModelBuildItem: Additional Jpa model class that we need to index

String className: No Javadoc found

io.quarkus.hibernate.orm.deployment.integration.HibernateOrmIntegrationRuntimeConfiguredBuildItem: No Javadoc found

String integrationName: No Javadoc found
String persistenceUnitName: No Javadoc found
HibernateOrmIntegrationRuntimeInitListener initListener: No Javadoc found

io.quarkus.hibernate.orm.deployment.integration.HibernateOrmIntegrationStaticConfiguredBuildItem: No Javadoc found

String integrationName: No Javadoc found
String persistenceUnitName: No Javadoc found
HibernateOrmIntegrationStaticInitListener initListener: No Javadoc found
boolean xmlMappingRequired: No Javadoc found

io.quarkus.hibernate.orm.deployment.ImpliedBlockingPersistenceUnitTypeBuildItem: Quarkus attempts to automatically define a persistence unit when the Hibernate ORM extension is enabled, a default datasource is defined, and there are mapped entities. This build item represents the decision about creating such an implied persistence unit; it's modelled as a BuildItem so that other extensions can be aware of such a persistence unit being defined (e.g. Hibernate Reactive needs to know).

boolean shouldGenerateOne: No Javadoc found

io.quarkus.hibernate.orm.deployment.JpaModelBuildItem: Internal model to represent which objects are likely needing enhancement via HibernateEntityEnhancer.

Set allModelPackageNames: No Javadoc found
Set entityClassNames: No Javadoc found
Set potentialCdiBeanClassNames: No Javadoc found
Set allModelClassNames: No Javadoc found
Map xmlMappingsByPU: No Javadoc found

io.quarkus.hibernate.orm.deployment.JpaModelIndexBuildItem: Provides the Jandex index of the application, combined with the index of additional JPA components that might have been generated.

CompositeIndex index: No Javadoc found

io.quarkus.hibernate.orm.deployment.JpaModelPersistenceUnitContributionBuildItem: Provides configuration specific to a persistence unit and necessary to build the JPA model.

String persistenceUnitName: No Javadoc found
URL persistenceUnitRootURL: No Javadoc found
Set explicitlyListedClassNames: No Javadoc found
Set explicitlyListedMappingFiles: No Javadoc found

io.quarkus.hibernate.orm.deployment.JpaModelPersistenceUnitMappingBuildItem: Internal model to hold the mapping linking a JPA entity to its corresponding persistence units.

Map entityToPersistenceUnits: No Javadoc found

io.quarkus.hibernate.orm.deployment.PersistenceProviderSetUpBuildItem: Indicates that the Hibernate ORM persistence units have been started.

None

io.quarkus.hibernate.orm.deployment.PersistenceUnitDescriptorBuildItem: Not to be confused with PersistenceXmlDescriptorBuildItem, which holds items of the same type. This build item represents a later phase, and might include the implicit configuration definitions that are automatically defined by Quarkus.

ParsedPersistenceXmlDescriptor descriptor: No Javadoc found
Optional dataSource: No Javadoc found
MultiTenancyStrategy multiTenancyStrategy: No Javadoc found
String multiTenancySchemaDataSource: No Javadoc found
List xmlMappings: No Javadoc found
boolean isReactive: No Javadoc found
boolean fromPersistenceXml: No Javadoc found

io.quarkus.hibernate.orm.deployment.PersistenceXmlDescriptorBuildItem: Provides instances of , the raw representation of a persistence.xml file as it is after being located and parsed. Exposed as a possible integration API: other extensions can produce additional configuration instances.

ParsedPersistenceXmlDescriptor descriptor: No Javadoc found

io.quarkus.hibernate.orm.deployment.ProxyDefinitionsBuildItem: Contains the reference to the class definitions of the proxies that Hibernate ORM might require at runtime. In Quarkus such proxies are built upfront, during the build. This needs to be a separate build item from other components so to avoid cycles in the rather complex build graph required by this extension.

PreGeneratedProxies proxies: No Javadoc found

Hibernate ORM with Panache

Class Name Attributes

Class Name	Attributes
`io.quarkus.hibernate.orm.panache.deployment.PanacheEntityClassBuildItem` Represents a regular Panache entity class.	`ClassInfo entityClass` No Javadoc found

io.quarkus.hibernate.orm.panache.deployment.PanacheEntityClassBuildItem: Represents a regular Panache entity class.

ClassInfo entityClass: No Javadoc found

Hibernate Reactive with Panache

Class Name Attributes

Class Name	Attributes
`io.quarkus.hibernate.reactive.panache.deployment.PanacheEntityClassBuildItem` Represents a regular Panache entity class.	`ClassInfo entityClass` No Javadoc found

io.quarkus.hibernate.reactive.panache.deployment.PanacheEntityClassBuildItem: Represents a regular Panache entity class.

ClassInfo entityClass: No Javadoc found

Hibernate Search - ORM + Elasticsearch

Class Name Attributes

Class Name	Attributes
`io.quarkus.hibernate.search.orm.elasticsearch.HibernateSearchElasticsearchPersistenceUnitConfiguredBuildItem` No Javadoc found	`String persistenceUnitName` No Javadoc found `HibernateSearchElasticsearchBuildTimeConfigPersistenceUnit buildTimeConfig` No Javadoc found `boolean defaultBackendIsUsed` No Javadoc found
`io.quarkus.hibernate.search.orm.elasticsearch.HibernateSearchIntegrationRuntimeConfiguredBuildItem` No Javadoc found	`String integrationName` No Javadoc found `String persistenceUnitName` No Javadoc found `HibernateOrmIntegrationRuntimeInitListener initListener` No Javadoc found
`io.quarkus.hibernate.search.orm.elasticsearch.HibernateSearchIntegrationStaticConfiguredBuildItem` No Javadoc found	`String integrationName` No Javadoc found `String persistenceUnitName` No Javadoc found `HibernateOrmIntegrationStaticInitListener initListener` No Javadoc found `boolean xmlMappingRequired` No Javadoc found

io.quarkus.hibernate.search.orm.elasticsearch.HibernateSearchElasticsearchPersistenceUnitConfiguredBuildItem: No Javadoc found

String persistenceUnitName: No Javadoc found
HibernateSearchElasticsearchBuildTimeConfigPersistenceUnit buildTimeConfig: No Javadoc found
boolean defaultBackendIsUsed: No Javadoc found

io.quarkus.hibernate.search.orm.elasticsearch.HibernateSearchIntegrationRuntimeConfiguredBuildItem: No Javadoc found

String integrationName: No Javadoc found
String persistenceUnitName: No Javadoc found
HibernateOrmIntegrationRuntimeInitListener initListener: No Javadoc found

io.quarkus.hibernate.search.orm.elasticsearch.HibernateSearchIntegrationStaticConfiguredBuildItem: No Javadoc found

String integrationName: No Javadoc found
String persistenceUnitName: No Javadoc found
HibernateOrmIntegrationStaticInitListener initListener: No Javadoc found
boolean xmlMappingRequired: No Javadoc found

Hibernate Validator - SPI

Class Name Attributes

Class Name	Attributes
`io.quarkus.hibernate.validator.spi.BeanValidationAnnotationsBuildItem` BuildItem used to publish the list of detected Bean Validation annotations for consumption by other extensions.	`DotName valid` No Javadoc found `Set constraints` No Javadoc found `Set all` No Javadoc found

io.quarkus.hibernate.validator.spi.BeanValidationAnnotationsBuildItem: BuildItem used to publish the list of detected Bean Validation annotations for consumption by other extensions.

DotName valid: No Javadoc found
Set constraints: No Javadoc found
Set all: No Javadoc found

Infinispan - Client

Class Name Attributes

Class Name	Attributes
`io.quarkus.infinispan.client.deployment.InfinispanPropertiesBuildItem` No Javadoc found	`Properties properties` No Javadoc found

io.quarkus.infinispan.client.deployment.InfinispanPropertiesBuildItem: No Javadoc found

Properties properties: No Javadoc found

Jackson

Class Name Attributes

Class Name	Attributes
`io.quarkus.jackson.deployment.IgnoreJsonDeserializeClassBuildItem` Used when an extension needs to inform the Jackson extension that a class should not be registered for reflection even if it annotated with @JsonDeserialize	`DotName dotName` No Javadoc found

io.quarkus.jackson.deployment.IgnoreJsonDeserializeClassBuildItem: Used when an extension needs to inform the Jackson extension that a class should not be registered for reflection even if it annotated with @JsonDeserialize

DotName dotName: No Javadoc found

Jackson - SPI

Class Name Attributes

Class Name	Attributes
`io.quarkus.jackson.spi.ClassPathJacksonModuleBuildItem` BuildItem used to signal that some Jackson module has been detected on the classpath The modules are then registered with the ObjectMapper. Note: Modules are assumed to have a default constructor	`String moduleClassName` No Javadoc found
`io.quarkus.jackson.spi.JacksonModuleBuildItem` BuildItem used to create a Jackson SimpleModule for the purpose of registering serializers and deserializers Serializers and deserializers MUST contain a public no-args constructor	`String name` No Javadoc found `Collection items` No Javadoc found

io.quarkus.jackson.spi.ClassPathJacksonModuleBuildItem: BuildItem used to signal that some Jackson module has been detected on the classpath The modules are then registered with the ObjectMapper. Note: Modules are assumed to have a default constructor

String moduleClassName: No Javadoc found

io.quarkus.jackson.spi.JacksonModuleBuildItem: BuildItem used to create a Jackson SimpleModule for the purpose of registering serializers and deserializers Serializers and deserializers MUST contain a public no-args constructor

String name: No Javadoc found
Collection items: No Javadoc found

JAX-RS - SPI

Class Name Attributes

Class Name	Attributes
`io.quarkus.jaxrs.spi.deployment.AdditionalJaxRsResourceMethodAnnotationsBuildItem` No Javadoc found	`List annotationClasses` No Javadoc found

io.quarkus.jaxrs.spi.deployment.AdditionalJaxRsResourceMethodAnnotationsBuildItem: No Javadoc found

List annotationClasses: No Javadoc found

JAX-RS Client Reactive

Class Name Attributes

Class Name	Attributes
`io.quarkus.jaxrs.client.reactive.deployment.JaxrsClientReactiveEnricherBuildItem` BuildItem to register a	`JaxrsClientReactiveEnricher enricher` No Javadoc found
`io.quarkus.jaxrs.client.reactive.deployment.RestClientDefaultConsumesBuildItem` No Javadoc found	`String defaultMediaType` No Javadoc found `int priority` No Javadoc found
`io.quarkus.jaxrs.client.reactive.deployment.RestClientDefaultProducesBuildItem` No Javadoc found	`String defaultMediaType` No Javadoc found `int priority` No Javadoc found

io.quarkus.jaxrs.client.reactive.deployment.JaxrsClientReactiveEnricherBuildItem: BuildItem to register a

JaxrsClientReactiveEnricher enricher: No Javadoc found

io.quarkus.jaxrs.client.reactive.deployment.RestClientDefaultConsumesBuildItem: No Javadoc found

String defaultMediaType: No Javadoc found
int priority: No Javadoc found

io.quarkus.jaxrs.client.reactive.deployment.RestClientDefaultProducesBuildItem: No Javadoc found

String defaultMediaType: No Javadoc found
int priority: No Javadoc found

JAXB

Class Name Attributes

Class Name	Attributes
`io.quarkus.jaxb.deployment.JaxbFileRootBuildItem` A location that should be scanned for jaxb.index files	`String fileRoot` No Javadoc found

io.quarkus.jaxb.deployment.JaxbFileRootBuildItem: A location that should be scanned for jaxb.index files

String fileRoot: No Javadoc found

JSON-B - SPI

Class Name Attributes

Class Name	Attributes
`io.quarkus.jsonb.spi.JsonbDeserializerBuildItem` BuildItem used to register a custom JsonbDeserializer with the default Jsonb bean Serializers and deserializers MUST contain a public no-args constructor	`Collection deserializerClassNames` No Javadoc found
`io.quarkus.jsonb.spi.JsonbSerializerBuildItem` BuildItem used to register a custom JsonbSerializer with the default Jsonb bean Serializers and deserializers MUST contain a public no-args constructor	`Collection serializerClassNames` No Javadoc found

io.quarkus.jsonb.spi.JsonbDeserializerBuildItem: BuildItem used to register a custom JsonbDeserializer with the default Jsonb bean Serializers and deserializers MUST contain a public no-args constructor

Collection deserializerClassNames: No Javadoc found

io.quarkus.jsonb.spi.JsonbSerializerBuildItem: BuildItem used to register a custom JsonbSerializer with the default Jsonb bean Serializers and deserializers MUST contain a public no-args constructor

Collection serializerClassNames: No Javadoc found

Kubernetes - SPI

Class Name Attributes

Class Name	Attributes
`io.quarkus.kubernetes.spi.ConfigurationSupplierBuildItem` A build item that wraps around ConfigurationSupplier objects. The purpose of those build items is influence the configuration that will be feed to the generator process.	`Object configurationSupplier` The configuration supplier
`io.quarkus.kubernetes.spi.ConfiguratorBuildItem` A build item that wraps around Configurator objects. The purpose of those build items is influence the configuration that will be feed to the generator process. ConfigurationRegistry are similar to decorators, but are applied to configuration instead of generated resources.	`Object configurator` The configurator
`io.quarkus.kubernetes.spi.CustomProjectRootBuildItem` Build item that allows us to supply a custom project root instead of allowing dekorate to figure out the project root based on its own rules	`Path root` No Javadoc found
`io.quarkus.kubernetes.spi.DecoratorBuildItem` A build item that wraps around Decorator objects. The purpose of those build items is to perform modification on the generated resources.	`String group` The group the decorator will be applied to. `Object decorator` The decorator
`io.quarkus.kubernetes.spi.DekorateOutputBuildItem` Produce this build item to expose the Dekorate project and Dekorate session.	`Object project` No Javadoc found `Object session` No Javadoc found `List generatedFiles` No Javadoc found
`io.quarkus.kubernetes.spi.GeneratedKubernetesResourceBuildItem` Represents a resource generated by the quarkus-kubernetes extension	`String name` No Javadoc found `byte[] content` No Javadoc found
`io.quarkus.kubernetes.spi.KubernetesAnnotationBuildItem` No Javadoc found	`String key` No Javadoc found `String value` No Javadoc found `String target` No Javadoc found
`io.quarkus.kubernetes.spi.KubernetesCommandBuildItem` No Javadoc found	`List command` No Javadoc found `List args` No Javadoc found
`io.quarkus.kubernetes.spi.KubernetesDeploymentClusterBuildItem` No Javadoc found	`String kind` No Javadoc found
`io.quarkus.kubernetes.spi.KubernetesDeploymentTargetBuildItem` Used to control which Kubernetes targets have their files generated and which get deployed Since these can be generated by various locations, code that needs the "final" set of items, should use the method to get a new list with merged items. Furthermore, if priorities need to be taken into account, the merged list should also be sorted	`String name` No Javadoc found `String kind` No Javadoc found `String group` No Javadoc found `String version` No Javadoc found `int priority` No Javadoc found `boolean enabled` No Javadoc found
`io.quarkus.kubernetes.spi.KubernetesEnvBuildItem` No Javadoc found	`String name` No Javadoc found `String value` No Javadoc found `String configmap` No Javadoc found `String secret` No Javadoc found `String field` No Javadoc found `EnvType type` No Javadoc found `String target` No Javadoc found `boolean oldStyle` No Javadoc found
`io.quarkus.kubernetes.spi.KubernetesHealthLivenessPathBuildItem` No Javadoc found	`String path` No Javadoc found
`io.quarkus.kubernetes.spi.KubernetesHealthReadinessPathBuildItem` No Javadoc found	`String path` No Javadoc found
`io.quarkus.kubernetes.spi.KubernetesHealthStartupPathBuildItem` No Javadoc found	`String path` No Javadoc found
`io.quarkus.kubernetes.spi.KubernetesLabelBuildItem` No Javadoc found	`String key` No Javadoc found `String value` No Javadoc found `String target` No Javadoc found
`io.quarkus.kubernetes.spi.KubernetesOptionalResourceDefinitionBuildItem` A build item that extension can use to mark a specific resource definition as optional. A an optional resource, when fails to get deployed, will not cause the entire deployment process to fail, but will log a warning instead.	`String apiVersion` No Javadoc found `String kind` No Javadoc found
`io.quarkus.kubernetes.spi.KubernetesPortBuildItem` No Javadoc found	`int port` No Javadoc found `String name` No Javadoc found
`io.quarkus.kubernetes.spi.KubernetesResourceMetadataBuildItem` No Javadoc found	`String target` No Javadoc found `String group` No Javadoc found `String version` No Javadoc found `String kind` No Javadoc found `String name` No Javadoc found
`io.quarkus.kubernetes.spi.KubernetesRoleBindingBuildItem` Produce this build item to request the Kubernetes extension to generate a Kubernetes resource. The configuration here is limited; in particular, you can't specify subjects of the role binding. The role will always be bound to the application's service account. Note that this can't be used to generate a .	`String name` Name of the generated resource. Can be , in which case the resource name is autogenerated. `String role` Name of the bound role. `boolean clusterWide` If , the binding refers to a , otherwise to a namespaced .
`io.quarkus.kubernetes.spi.KubernetesRoleBuildItem` Produce this build item to request the Kubernetes extension to generate a Kubernetes resource. Note that this can't be used to generate a .	`String name` Name of the generated resource. `List rules` The resources for this .

io.quarkus.kubernetes.spi.ConfigurationSupplierBuildItem: A build item that wraps around ConfigurationSupplier objects. The purpose of those build items is influence the configuration that will be feed to the generator process.

Object configurationSupplier: The configuration supplier

io.quarkus.kubernetes.spi.ConfiguratorBuildItem: A build item that wraps around Configurator objects. The purpose of those build items is influence the configuration that will be feed to the generator process. ConfigurationRegistry are similar to decorators, but are applied to configuration instead of generated resources.

Object configurator: The configurator

io.quarkus.kubernetes.spi.CustomProjectRootBuildItem: Build item that allows us to supply a custom project root instead of allowing dekorate to figure out the project root based on its own rules

Path root: No Javadoc found

io.quarkus.kubernetes.spi.DecoratorBuildItem: A build item that wraps around Decorator objects. The purpose of those build items is to perform modification on the generated resources.

String group: The group the decorator will be applied to.
Object decorator: The decorator

io.quarkus.kubernetes.spi.DekorateOutputBuildItem: Produce this build item to expose the Dekorate project and Dekorate session.

Object project: No Javadoc found
Object session: No Javadoc found
List generatedFiles: No Javadoc found

io.quarkus.kubernetes.spi.GeneratedKubernetesResourceBuildItem: Represents a resource generated by the quarkus-kubernetes extension

String name: No Javadoc found
byte[] content: No Javadoc found

io.quarkus.kubernetes.spi.KubernetesAnnotationBuildItem: No Javadoc found

String key: No Javadoc found
String value: No Javadoc found
String target: No Javadoc found

io.quarkus.kubernetes.spi.KubernetesCommandBuildItem: No Javadoc found

List command: No Javadoc found
List args: No Javadoc found

io.quarkus.kubernetes.spi.KubernetesDeploymentClusterBuildItem: No Javadoc found

String kind: No Javadoc found

io.quarkus.kubernetes.spi.KubernetesDeploymentTargetBuildItem: Used to control which Kubernetes targets have their files generated and which get deployed Since these can be generated by various locations, code that needs the "final" set of items, should use the method to get a new list with merged items. Furthermore, if priorities need to be taken into account, the merged list should also be sorted

String name: No Javadoc found
String kind: No Javadoc found
String group: No Javadoc found
String version: No Javadoc found
int priority: No Javadoc found
boolean enabled: No Javadoc found

io.quarkus.kubernetes.spi.KubernetesEnvBuildItem: No Javadoc found

String name: No Javadoc found
String value: No Javadoc found
String configmap: No Javadoc found
String secret: No Javadoc found
String field: No Javadoc found
EnvType type: No Javadoc found
String target: No Javadoc found
boolean oldStyle: No Javadoc found

io.quarkus.kubernetes.spi.KubernetesHealthLivenessPathBuildItem: No Javadoc found

String path: No Javadoc found

io.quarkus.kubernetes.spi.KubernetesHealthReadinessPathBuildItem: No Javadoc found

String path: No Javadoc found

io.quarkus.kubernetes.spi.KubernetesHealthStartupPathBuildItem: No Javadoc found

String path: No Javadoc found

io.quarkus.kubernetes.spi.KubernetesLabelBuildItem: No Javadoc found

String key: No Javadoc found
String value: No Javadoc found
String target: No Javadoc found

io.quarkus.kubernetes.spi.KubernetesOptionalResourceDefinitionBuildItem: A build item that extension can use to mark a specific resource definition as optional. A an optional resource, when fails to get deployed, will not cause the entire deployment process to fail, but will log a warning instead.

String apiVersion: No Javadoc found
String kind: No Javadoc found

io.quarkus.kubernetes.spi.KubernetesPortBuildItem: No Javadoc found

int port: No Javadoc found
String name: No Javadoc found

io.quarkus.kubernetes.spi.KubernetesResourceMetadataBuildItem: No Javadoc found

String target: No Javadoc found
String group: No Javadoc found
String version: No Javadoc found
String kind: No Javadoc found
String name: No Javadoc found

io.quarkus.kubernetes.spi.KubernetesRoleBindingBuildItem

Produce this build item to request the Kubernetes extension to generate a Kubernetes resource. The configuration here is limited; in particular, you can't specify subjects of the role binding. The role will always be bound to the application's service account.

Note that this can't be used to generate a .

String name: Name of the generated resource. Can be , in which case the resource name is autogenerated.
String role: Name of the bound role.
boolean clusterWide: If , the binding refers to a , otherwise to a namespaced .

io.quarkus.kubernetes.spi.KubernetesRoleBuildItem

Produce this build item to request the Kubernetes extension to generate a Kubernetes resource.

Note that this can't be used to generate a .

String name: Name of the generated resource.
List rules: The resources for this .

Kubernetes - Vanilla

Class Name Attributes

Class Name	Attributes
`io.quarkus.kubernetes.deployment.EnabledKubernetesDeploymentTargetsBuildItem` No Javadoc found	`List entriesSortedByPriority` No Javadoc found
`io.quarkus.kubernetes.deployment.SelectedKubernetesDeploymentTargetBuildItem` No Javadoc found	`DeploymentTargetEntry entry` No Javadoc found

io.quarkus.kubernetes.deployment.EnabledKubernetesDeploymentTargetsBuildItem: No Javadoc found

List entriesSortedByPriority: No Javadoc found

io.quarkus.kubernetes.deployment.SelectedKubernetesDeploymentTargetBuildItem: No Javadoc found

DeploymentTargetEntry entry: No Javadoc found

Kubernetes Client - SPI

Class Name Attributes

Class Name	Attributes
`io.quarkus.kubernetes.client.spi.KubernetesClientBuildItem` No Javadoc found	`KubernetesClient client` No Javadoc found

io.quarkus.kubernetes.client.spi.KubernetesClientBuildItem: No Javadoc found

KubernetesClient client: No Javadoc found

Kubernetes Service Binding - SPI

Class Name Attributes

Class Name	Attributes
`io.quarkus.kubernetes.service.binding.spi.ServiceBindingQualifierBuildItem` Build item that describes a service that the application needs to bind to. The qualifier does not encapsulate the target service coordinates, but information that given the right context can be mapped to coordinates.	`String id` No Javadoc found `String kind` No Javadoc found `String name` No Javadoc found
`io.quarkus.kubernetes.service.binding.spi.ServiceBindingRequirementBuildItem` Build item that describes a kubernetes resource that the application needs to bind to.	`String binding` No Javadoc found `String apiVersion` No Javadoc found `String kind` No Javadoc found `String name` No Javadoc found

io.quarkus.kubernetes.service.binding.spi.ServiceBindingQualifierBuildItem: Build item that describes a service that the application needs to bind to. The qualifier does not encapsulate the target service coordinates, but information that given the right context can be mapped to coordinates.

String id: No Javadoc found
String kind: No Javadoc found
String name: No Javadoc found

io.quarkus.kubernetes.service.binding.spi.ServiceBindingRequirementBuildItem: Build item that describes a kubernetes resource that the application needs to bind to.

String binding: No Javadoc found
String apiVersion: No Javadoc found
String kind: No Javadoc found
String name: No Javadoc found

Micrometer

Class Name Attributes

Class Name	Attributes
`io.quarkus.micrometer.deployment.MicrometerRegistryProviderBuildItem` No Javadoc found	`Class clazz` No Javadoc found
`io.quarkus.micrometer.deployment.RootMeterRegistryBuildItem` No Javadoc found	`RuntimeValue value` No Javadoc found

io.quarkus.micrometer.deployment.MicrometerRegistryProviderBuildItem: No Javadoc found

Class clazz: No Javadoc found

io.quarkus.micrometer.deployment.RootMeterRegistryBuildItem: No Javadoc found

RuntimeValue value: No Javadoc found

MongoDB Client

Class Name Attributes

Class Name	Attributes
`io.quarkus.mongodb.deployment.BsonDiscriminatorBuildItem` Register additional BsonDiscriminator's for the MongoDB clients.	`List bsonDiscriminatorClassNames` No Javadoc found
`io.quarkus.mongodb.deployment.CodecProviderBuildItem` Register additional s for the MongoDB clients.	`List codecProviderClassNames` No Javadoc found
`io.quarkus.mongodb.deployment.CommandListenerBuildItem` Register additional s for the MongoDB clients.	`List commandListenerClassNames` No Javadoc found
`io.quarkus.mongodb.deployment.MongoClientBuildItem` Provide the MongoDB clients as RuntimeValue's.	`RuntimeValue client` No Javadoc found `RuntimeValue reactive` No Javadoc found `String name` No Javadoc found
`io.quarkus.mongodb.deployment.MongoClientNameBuildItem` Represents the values of the .	`String name` No Javadoc found `boolean addQualifier` No Javadoc found
`io.quarkus.mongodb.deployment.MongoConnectionPoolListenerBuildItem` Register additional s.	`Supplier connectionPoolListener` No Javadoc found
`io.quarkus.mongodb.deployment.MongoUnremovableClientsBuildItem` If generated, all the Mongo clients need to be unremovable	None
`io.quarkus.mongodb.deployment.PropertyCodecProviderBuildItem` Register additional s for the MongoDB clients.	`List propertyCodecProviderClassNames` No Javadoc found

io.quarkus.mongodb.deployment.BsonDiscriminatorBuildItem: Register additional BsonDiscriminator's for the MongoDB clients.

List bsonDiscriminatorClassNames: No Javadoc found

io.quarkus.mongodb.deployment.CodecProviderBuildItem: Register additional s for the MongoDB clients.

List codecProviderClassNames: No Javadoc found

io.quarkus.mongodb.deployment.CommandListenerBuildItem: Register additional s for the MongoDB clients.

List commandListenerClassNames: No Javadoc found

io.quarkus.mongodb.deployment.MongoClientBuildItem: Provide the MongoDB clients as RuntimeValue's.

RuntimeValue client: No Javadoc found
RuntimeValue reactive: No Javadoc found
String name: No Javadoc found

io.quarkus.mongodb.deployment.MongoClientNameBuildItem: Represents the values of the .

String name: No Javadoc found
boolean addQualifier: No Javadoc found

io.quarkus.mongodb.deployment.MongoConnectionPoolListenerBuildItem: Register additional s.

Supplier connectionPoolListener: No Javadoc found

io.quarkus.mongodb.deployment.MongoUnremovableClientsBuildItem: If generated, all the Mongo clients need to be unremovable

None

io.quarkus.mongodb.deployment.PropertyCodecProviderBuildItem: Register additional s for the MongoDB clients.

List propertyCodecProviderClassNames: No Javadoc found

MongoDB with Panache - Common Deployment

Class Name Attributes

Class Name	Attributes
`io.quarkus.mongodb.panache.deployment.PanacheMongoEntityClassBuildItem` Represents a regular Panache entity class.	`ClassInfo entityClass` No Javadoc found

io.quarkus.mongodb.panache.deployment.PanacheMongoEntityClassBuildItem: Represents a regular Panache entity class.

ClassInfo entityClass: No Javadoc found

Netty

Class Name Attributes

Class Name	Attributes
`io.quarkus.netty.deployment.EventLoopSupplierBuildItem` No Javadoc found	`Supplier mainSupplier` No Javadoc found `Supplier bossSupplier` No Javadoc found
`io.quarkus.netty.deployment.MinNettyAllocatorMaxOrderBuildItem` Build item to specify the minimal required `io.netty.allocator.maxOrder`. Quarkus by default uses `maxOrder == 1`. Extensions that require a larger value can use this build item to specify it.	`int maxOrder` No Javadoc found

io.quarkus.netty.deployment.EventLoopSupplierBuildItem: No Javadoc found

Supplier mainSupplier: No Javadoc found
Supplier bossSupplier: No Javadoc found

io.quarkus.netty.deployment.MinNettyAllocatorMaxOrderBuildItem: Build item to specify the minimal required `io.netty.allocator.maxOrder`. Quarkus by default uses `maxOrder == 1`. Extensions that require a larger value can use this build item to specify it.

int maxOrder: No Javadoc found

OpenID Connect Adapter

Class Name Attributes

Class Name	Attributes
`io.quarkus.oidc.deployment.devservices.keycloak.KeycloakDevServicesConfigBuildItem` No Javadoc found	`Map config` No Javadoc found `Map properties` No Javadoc found
`io.quarkus.oidc.deployment.devservices.OidcDevServicesBuildItem` Marker build item which indicates that Dev Services for OIDC are provided by another extension. Dev Services for Keycloak will be disabled if this item is detected.	None

io.quarkus.oidc.deployment.devservices.keycloak.KeycloakDevServicesConfigBuildItem: No Javadoc found

Map config: No Javadoc found
Map properties: No Javadoc found

io.quarkus.oidc.deployment.devservices.OidcDevServicesBuildItem: Marker build item which indicates that Dev Services for OIDC are provided by another extension. Dev Services for Keycloak will be disabled if this item is detected.

None

OpenID Connect Client

Class Name Attributes

Class Name	Attributes
`io.quarkus.oidc.client.deployment.OidcClientNamesBuildItem` Contains non-default names of OIDC Clients.	`Set oidcClientNames` No Javadoc found

io.quarkus.oidc.client.deployment.OidcClientNamesBuildItem: Contains non-default names of OIDC Clients.

Set oidcClientNames: No Javadoc found

OpenTelemetry

Class Name Attributes

Class Name	Attributes
`io.quarkus.opentelemetry.deployment.tracing.DropNonApplicationUrisBuildItem` No Javadoc found	`List dropNames` No Javadoc found
`io.quarkus.opentelemetry.deployment.tracing.DropStaticResourcesBuildItem` No Javadoc found	`List dropNames` No Javadoc found
`io.quarkus.opentelemetry.deployment.tracing.TracerProviderBuildItem` No Javadoc found	`RuntimeValue tracerProvider` No Javadoc found

io.quarkus.opentelemetry.deployment.tracing.DropNonApplicationUrisBuildItem: No Javadoc found

List dropNames: No Javadoc found

io.quarkus.opentelemetry.deployment.tracing.DropStaticResourcesBuildItem: No Javadoc found

List dropNames: No Javadoc found

io.quarkus.opentelemetry.deployment.tracing.TracerProviderBuildItem: No Javadoc found

RuntimeValue tracerProvider: No Javadoc found

Panache - Common

Class Name Attributes

Class Name	Attributes
`io.quarkus.panache.common.deployment.PanacheEntityClassesBuildItem` Build item to indicate that those classes are Panache-enhanced and will get getters/setters generated for public fields, even if they're not visible in the index.	`Set entityClasses` No Javadoc found
`io.quarkus.panache.common.deployment.PanacheMethodCustomizerBuildItem` Build item to declare that a should be used on Panache-enhanced methods.	`PanacheMethodCustomizer methodCustomizer` No Javadoc found

io.quarkus.panache.common.deployment.PanacheEntityClassesBuildItem: Build item to indicate that those classes are Panache-enhanced and will get getters/setters generated for public fields, even if they're not visible in the index.

Set entityClasses: No Javadoc found

io.quarkus.panache.common.deployment.PanacheMethodCustomizerBuildItem: Build item to declare that a should be used on Panache-enhanced methods.

PanacheMethodCustomizer methodCustomizer: No Javadoc found

Panache - Hibernate - Common

Class Name Attributes

Class Name	Attributes
`io.quarkus.panache.common.deployment.HibernateEnhancersRegisteredBuildItem` Purely marker build item so that you can register enhancers after Hibernate registers its enhancers, which would make your enhancers run before the Hibernate enhancers	None
`io.quarkus.panache.common.deployment.HibernateMetamodelForFieldAccessBuildItem` No Javadoc found	`MetamodelInfo metamodelInfo` No Javadoc found
`io.quarkus.panache.common.deployment.HibernateModelClassCandidatesForFieldAccessBuildItem` No Javadoc found	`Set allModelClassNames` No Javadoc found

io.quarkus.panache.common.deployment.HibernateEnhancersRegisteredBuildItem: Purely marker build item so that you can register enhancers after Hibernate registers its enhancers, which would make your enhancers run before the Hibernate enhancers

None

io.quarkus.panache.common.deployment.HibernateMetamodelForFieldAccessBuildItem: No Javadoc found

MetamodelInfo metamodelInfo: No Javadoc found

io.quarkus.panache.common.deployment.HibernateModelClassCandidatesForFieldAccessBuildItem: No Javadoc found

Set allModelClassNames: No Javadoc found

Qute

Class Name Attributes

Class Name	Attributes
`io.quarkus.qute.deployment.CheckedTemplateAdapterBuildItem` No Javadoc found	`CheckedTemplateAdapter adapter` No Javadoc found
`io.quarkus.qute.deployment.CheckedTemplateBuildItem` Represents a method of a class annotated with .	`String templateId` No Javadoc found `Map bindings` No Javadoc found `MethodInfo method` No Javadoc found `boolean requireTypeSafeExpressions` No Javadoc found
`io.quarkus.qute.deployment.GeneratedTemplateInitializerBuildItem` No Javadoc found	`String className` No Javadoc found
`io.quarkus.qute.deployment.GeneratedValueResolverBuildItem` Holds a name of a generated class.	`String className` No Javadoc found
`io.quarkus.qute.deployment.ImplicitValueResolverBuildItem` This build item can be used to register an implicit value resolver for the specified class. It is also possible to specify the synthetic . If the specified class is also annotated with the build item is ignored. If multiple build items are produced for one class and the synthetic template data is not equal the build fails.	`ClassInfo clazz` No Javadoc found `AnnotationInstance templateData` No Javadoc found
`io.quarkus.qute.deployment.IncorrectExpressionBuildItem` No Javadoc found	`String expression` No Javadoc found `String property` No Javadoc found `String clazz` No Javadoc found `Origin origin` No Javadoc found `String reason` No Javadoc found
`io.quarkus.qute.deployment.MessageBundleBuildItem` No Javadoc found	`String name` No Javadoc found `ClassInfo defaultBundleInterface` No Javadoc found `Map localizedInterfaces` No Javadoc found `Map localizedFiles` No Javadoc found
`io.quarkus.qute.deployment.MessageBundleMethodBuildItem` Represents a message bundle method. Note that templates that contain no expressions don't need to be validated.	`String bundleName` No Javadoc found `String key` No Javadoc found `String templateId` No Javadoc found `MethodInfo method` No Javadoc found `String template` No Javadoc found `boolean isDefaultBundle` No Javadoc found
`io.quarkus.qute.deployment.TemplateExtensionMethodBuildItem` Represents a template extension method.	`MethodInfo method` No Javadoc found `String matchName` No Javadoc found `String matchRegex` No Javadoc found `Pattern matchPattern` No Javadoc found `Type matchType` No Javadoc found `int priority` No Javadoc found `String namespace` No Javadoc found `Parameters params` No Javadoc found
`io.quarkus.qute.deployment.TemplateFilePathsBuildItem` Holds all template file paths, including the versions without suffixes configured via . For example, for the template the set will contain and .	`Set filePaths` No Javadoc found
`io.quarkus.qute.deployment.TemplateGlobalBuildItem` Represents a global variable field/method.	`String name` No Javadoc found `AnnotationTarget target` No Javadoc found `Type variableType` No Javadoc found
`io.quarkus.qute.deployment.TemplatePathBuildItem` Represents a template path.	`String path` No Javadoc found `Path fullPath` No Javadoc found `String content` No Javadoc found
`io.quarkus.qute.deployment.TemplateVariantsBuildItem` Holds all template variants found.	`Map variants` No Javadoc found
`io.quarkus.qute.deployment.TemplatesAnalysisBuildItem` Represents the result of analysis of all templates.	`List analysis` No Javadoc found
`io.quarkus.qute.deployment.TypeCheckExcludeBuildItem` Makes it possible to intentionally ignore some parts of an expression when performing type-safe validation.	`Predicate predicate` No Javadoc found

io.quarkus.qute.deployment.CheckedTemplateAdapterBuildItem: No Javadoc found

CheckedTemplateAdapter adapter: No Javadoc found

io.quarkus.qute.deployment.CheckedTemplateBuildItem: Represents a method of a class annotated with .

String templateId: No Javadoc found
Map bindings: No Javadoc found
MethodInfo method: No Javadoc found
boolean requireTypeSafeExpressions: No Javadoc found

io.quarkus.qute.deployment.GeneratedTemplateInitializerBuildItem: No Javadoc found

String className: No Javadoc found

io.quarkus.qute.deployment.GeneratedValueResolverBuildItem: Holds a name of a generated class.

String className: No Javadoc found

io.quarkus.qute.deployment.ImplicitValueResolverBuildItem

This build item can be used to register an implicit value resolver for the specified class. It is also possible to specify the synthetic .

If the specified class is also annotated with the build item is ignored.

If multiple build items are produced for one class and the synthetic template data is not equal the build fails.

ClassInfo clazz: No Javadoc found
AnnotationInstance templateData: No Javadoc found

io.quarkus.qute.deployment.IncorrectExpressionBuildItem: No Javadoc found

String expression: No Javadoc found
String property: No Javadoc found
String clazz: No Javadoc found
Origin origin: No Javadoc found
String reason: No Javadoc found

io.quarkus.qute.deployment.MessageBundleBuildItem: No Javadoc found

String name: No Javadoc found
ClassInfo defaultBundleInterface: No Javadoc found
Map localizedInterfaces: No Javadoc found
Map localizedFiles: No Javadoc found

io.quarkus.qute.deployment.MessageBundleMethodBuildItem

Represents a message bundle method.

Note that templates that contain no expressions don't need to be validated.

String bundleName: No Javadoc found
String key: No Javadoc found
String templateId: No Javadoc found
MethodInfo method: No Javadoc found
String template: No Javadoc found
boolean isDefaultBundle: No Javadoc found

io.quarkus.qute.deployment.TemplateExtensionMethodBuildItem: Represents a template extension method.

MethodInfo method: No Javadoc found
String matchName: No Javadoc found
String matchRegex: No Javadoc found
Pattern matchPattern: No Javadoc found
Type matchType: No Javadoc found
int priority: No Javadoc found
String namespace: No Javadoc found
Parameters params: No Javadoc found

io.quarkus.qute.deployment.TemplateFilePathsBuildItem

Holds all template file paths, including the versions without suffixes configured via .

For example, for the template the set will contain and .

Set filePaths: No Javadoc found

io.quarkus.qute.deployment.TemplateGlobalBuildItem: Represents a global variable field/method.

String name: No Javadoc found
AnnotationTarget target: No Javadoc found
Type variableType: No Javadoc found

io.quarkus.qute.deployment.TemplatePathBuildItem: Represents a template path.

String path: No Javadoc found
Path fullPath: No Javadoc found
String content: No Javadoc found

io.quarkus.qute.deployment.TemplateVariantsBuildItem: Holds all template variants found.

Map variants: No Javadoc found

io.quarkus.qute.deployment.TemplatesAnalysisBuildItem: Represents the result of analysis of all templates.

List analysis: No Javadoc found

io.quarkus.qute.deployment.TypeCheckExcludeBuildItem: Makes it possible to intentionally ignore some parts of an expression when performing type-safe validation.

Predicate predicate: No Javadoc found

Reactive Datasource

Class Name Attributes

Class Name	Attributes
`io.quarkus.reactive.datasource.deployment.VertxPoolBuildItem` A build item for Vertx s. If you inject this build item when recording runtime init template calls, you are guaranteed the Pool configuration has been injected and Pools can be created.	`RuntimeValue vertxPool` No Javadoc found `String dbKind` No Javadoc found `boolean isDefault` No Javadoc found

io.quarkus.reactive.datasource.deployment.VertxPoolBuildItem

A build item for Vertx s.

If you inject this build item when recording runtime init template calls, you are guaranteed the Pool configuration has been injected and Pools can be created.

RuntimeValue vertxPool: No Javadoc found
String dbKind: No Javadoc found
boolean isDefault: No Javadoc found

Reactive DB2 Client

Class Name Attributes

Class Name	Attributes
`io.quarkus.reactive.db2.client.deployment.DB2PoolBuildItem` No Javadoc found	`String dataSourceName` No Javadoc found `RuntimeValue db2Pool` No Javadoc found

io.quarkus.reactive.db2.client.deployment.DB2PoolBuildItem: No Javadoc found

String dataSourceName: No Javadoc found
RuntimeValue db2Pool: No Javadoc found

Reactive Microsoft SQL Server Client

Class Name Attributes

Class Name	Attributes
`io.quarkus.reactive.mssql.client.deployment.MSSQLPoolBuildItem` No Javadoc found	`String dataSourceName` No Javadoc found `RuntimeValue mssqlPool` No Javadoc found

io.quarkus.reactive.mssql.client.deployment.MSSQLPoolBuildItem: No Javadoc found

String dataSourceName: No Javadoc found
RuntimeValue mssqlPool: No Javadoc found

Reactive MySQL Client

Class Name Attributes

Class Name	Attributes
`io.quarkus.reactive.mysql.client.deployment.MySQLPoolBuildItem` No Javadoc found	`String dataSourceName` No Javadoc found `RuntimeValue mysqlPool` No Javadoc found

io.quarkus.reactive.mysql.client.deployment.MySQLPoolBuildItem: No Javadoc found

String dataSourceName: No Javadoc found
RuntimeValue mysqlPool: No Javadoc found

Reactive Oracle Client

Class Name Attributes

Class Name	Attributes
`io.quarkus.reactive.oracle.client.deployment.OraclePoolBuildItem` No Javadoc found	`String dataSourceName` No Javadoc found `RuntimeValue oraclePool` No Javadoc found

io.quarkus.reactive.oracle.client.deployment.OraclePoolBuildItem: No Javadoc found

String dataSourceName: No Javadoc found
RuntimeValue oraclePool: No Javadoc found

Reactive PostgreSQL Client

Class Name Attributes

Class Name	Attributes
`io.quarkus.reactive.pg.client.deployment.PgPoolBuildItem` No Javadoc found	`String dataSourceName` No Javadoc found `RuntimeValue pgPool` No Javadoc found

io.quarkus.reactive.pg.client.deployment.PgPoolBuildItem: No Javadoc found

String dataSourceName: No Javadoc found
RuntimeValue pgPool: No Javadoc found

Reactive Routes

Class Name Attributes

Class Name	Attributes
`io.quarkus.vertx.web.deployment.AnnotatedRouteFilterBuildItem` No Javadoc found	`BeanInfo bean` No Javadoc found `AnnotationInstance routeFilter` No Javadoc found `MethodInfo method` No Javadoc found
`io.quarkus.vertx.web.deployment.AnnotatedRouteHandlerBuildItem` No Javadoc found	`BeanInfo bean` No Javadoc found `List routes` No Javadoc found `AnnotationInstance routeBase` No Javadoc found `MethodInfo method` No Javadoc found

io.quarkus.vertx.web.deployment.AnnotatedRouteFilterBuildItem: No Javadoc found

BeanInfo bean: No Javadoc found
AnnotationInstance routeFilter: No Javadoc found
MethodInfo method: No Javadoc found

io.quarkus.vertx.web.deployment.AnnotatedRouteHandlerBuildItem: No Javadoc found

BeanInfo bean: No Javadoc found
List routes: No Javadoc found
AnnotationInstance routeBase: No Javadoc found
MethodInfo method: No Javadoc found

REST Client

Class Name Attributes

Class Name	Attributes
`io.quarkus.restclient.deployment.RestClientAnnotationProviderBuildItem` Used to mark a custom annotation and its associated JAX-RS client provider	`DotName annotationName` No Javadoc found `Class providerClass` No Javadoc found

io.quarkus.restclient.deployment.RestClientAnnotationProviderBuildItem: Used to mark a custom annotation and its associated JAX-RS client provider

DotName annotationName: No Javadoc found
Class providerClass: No Javadoc found

REST data with Panache

Class Name Attributes

Class Name	Attributes
`io.quarkus.rest.data.panache.deployment.properties.ResourcePropertiesBuildItem` No Javadoc found	`String resourceType` No Javadoc found `ResourceProperties resourceProperties` No Javadoc found
`io.quarkus.rest.data.panache.deployment.RestDataResourceBuildItem` No Javadoc found	`ResourceMetadata resourceMetadata` No Javadoc found

io.quarkus.rest.data.panache.deployment.properties.ResourcePropertiesBuildItem: No Javadoc found

String resourceType: No Javadoc found
ResourceProperties resourceProperties: No Javadoc found

io.quarkus.rest.data.panache.deployment.RestDataResourceBuildItem: No Javadoc found

ResourceMetadata resourceMetadata: No Javadoc found

RESTEasy - Common

Class Name Attributes

Class Name	Attributes
`io.quarkus.resteasy.common.deployment.JaxrsProvidersToRegisterBuildItem` No Javadoc found	`Set providers` No Javadoc found `Set contributedProviders` No Javadoc found `Set annotatedProviders` No Javadoc found `boolean useBuiltIn` No Javadoc found
`io.quarkus.resteasy.common.deployment.RestClientBuildItem` Used to mark a class as a potential REST client interface consumed by the MicroProfile REST client. Useful when you want to apply different behaviors to REST resources and REST clients.	`String interfaceName` No Javadoc found
`io.quarkus.resteasy.common.deployment.ResteasyInjectionReadyBuildItem` Gives access to the configured Can also be used as a marker indicating the RESTEasy injection has been properly set up	`RuntimeValue injectorFactory` No Javadoc found

io.quarkus.resteasy.common.deployment.JaxrsProvidersToRegisterBuildItem: No Javadoc found

Set providers: No Javadoc found
Set contributedProviders: No Javadoc found
Set annotatedProviders: No Javadoc found
boolean useBuiltIn: No Javadoc found

io.quarkus.resteasy.common.deployment.RestClientBuildItem

Used to mark a class as a potential REST client interface consumed by the MicroProfile REST client.

Useful when you want to apply different behaviors to REST resources and REST clients.

String interfaceName: No Javadoc found

io.quarkus.resteasy.common.deployment.ResteasyInjectionReadyBuildItem: Gives access to the configured Can also be used as a marker indicating the RESTEasy injection has been properly set up

RuntimeValue injectorFactory: No Javadoc found

RESTEasy - Common - SPI

Class Name Attributes

Class Name	Attributes
`io.quarkus.resteasy.common.spi.ResteasyConfigBuildItem` No Javadoc found	`boolean jsonDefault` No Javadoc found
`io.quarkus.resteasy.common.spi.ResteasyJaxrsProviderBuildItem` A build item that represents a JAX-RS provider class.	`String name` No Javadoc found

io.quarkus.resteasy.common.spi.ResteasyConfigBuildItem: No Javadoc found

boolean jsonDefault: No Javadoc found

io.quarkus.resteasy.common.spi.ResteasyJaxrsProviderBuildItem: A build item that represents a JAX-RS provider class.

String name: No Javadoc found

RESTEasy - Server common

Class Name Attributes

io.quarkus.resteasy.server.common.deployment.ResteasyDeploymentBuildItem: No Javadoc found

String rootPath: No Javadoc found
ResteasyDeployment deployment: No Javadoc found

io.quarkus.resteasy.server.common.deployment.ResteasyDeploymentCustomizerBuildItem: A build item that is meant to customize the RESTEasy Deployment before it has been finalized This gives extensions to ability to add stuff to the Deployment

Consumer consumer: No Javadoc found

io.quarkus.resteasy.server.common.deployment.ResteasyServerConfigBuildItem: A build item that represents the configuration of the RESTEasy server.

String rootPath: No Javadoc found
String path: No Javadoc found
Map initParameters: No Javadoc found

io.quarkus.resteasy.server.common.deployment.ResteasyServletMappingBuildItem: A build item that represents a path mapping from web.xml

String path: No Javadoc found

RESTEasy - Server common - SPI

Class Name Attributes

io.quarkus.resteasy.server.common.spi.AdditionalJaxRsResourceDefiningAnnotationBuildItem: No Javadoc found

DotName annotationClass: No Javadoc found

io.quarkus.resteasy.server.common.spi.AllowedJaxRsAnnotationPrefixBuildItem: The package prefix of any annotations that have to be compatible with JaxRs resource class to allow constructor injection.

String prefix: No Javadoc found

io.quarkus.resteasy.server.common.spi.ResteasyJaxrsConfigBuildItem: A build item that represents a JAX-RS config.

String rootPath: No Javadoc found
String defaultPath: No Javadoc found

RESTEasy Reactive

Class Name Attributes

io.quarkus.resteasy.reactive.server.deployment.ContextResolversBuildItem: No Javadoc found

ContextResolvers contextResolvers: No Javadoc found

io.quarkus.resteasy.reactive.server.deployment.RequestContextFactoryBuildItem: No Javadoc found

RequestContextFactory factory: No Javadoc found

io.quarkus.resteasy.reactive.server.deployment.ResteasyReactiveDeploymentBuildItem: No Javadoc found

RuntimeValue deployment: No Javadoc found
String applicationPath: No Javadoc found

io.quarkus.resteasy.reactive.server.deployment.ResteasyReactiveDeploymentInfoBuildItem: No Javadoc found

DeploymentInfo deploymentInfo: No Javadoc found

io.quarkus.resteasy.reactive.server.deployment.ResteasyReactiveResourceMethodEntriesBuildItem: Provides a list of entries for each JAX-RS Resource Methods created during the indexing process. Each entry also contains the information about the Java class and method that correspond to the JAX-RS Resource Method, giving extensions access to the entire set of metadata thus allowing them to build additionally build-time functionality.

List entries: No Javadoc found

io.quarkus.resteasy.reactive.server.deployment.ServerSerialisersBuildItem: No Javadoc found

ServerSerialisers serialisers: No Javadoc found

io.quarkus.resteasy.reactive.server.deployment.SetupEndpointsResultBuildItem: No Javadoc found

List resourceClasses: No Javadoc found
List subResourceClasses: No Javadoc found
AdditionalReaders additionalReaders: No Javadoc found
AdditionalWriters additionalWriters: No Javadoc found

RESTEasy Reactive - Common

Class Name Attributes

io.quarkus.resteasy.reactive.common.deployment.ApplicationResultBuildItem: No Javadoc found

ApplicationScanningResult result: No Javadoc found

io.quarkus.resteasy.reactive.common.deployment.JaxRsResourceIndexBuildItem: Represents the index that is going to be used to look up JAX-RS Resources. This index contains both code that is present on disk at build time, and code that is generated by other extensions.

IndexView indexView: No Javadoc found

io.quarkus.resteasy.reactive.common.deployment.ResourceInterceptorsBuildItem: No Javadoc found

ResourceInterceptors resourceInterceptors: No Javadoc found

io.quarkus.resteasy.reactive.common.deployment.ResourceInterceptorsContributorBuildItem: No Javadoc found

Consumer buildTask: No Javadoc found

io.quarkus.resteasy.reactive.common.deployment.ResourceScanningResultBuildItem: No Javadoc found

ResourceScanningResult result: No Javadoc found

io.quarkus.resteasy.reactive.common.deployment.ServerDefaultProducesHandlerBuildItem: Enable the registration of additional default produces handlers for server endpoints

DefaultProducesHandler defaultProducesHandler: No Javadoc found

RESTEasy Reactive - Common Jackson Bits

Class Name Attributes

io.quarkus.resteasy.reactive.jackson.deployment.processor.ResteasyReactiveJacksonProviderDefinedBuildItem: A BuildItem to mark that the server side jackson provider is defined. If not "emitted" by any of the processors, the reactive rest client (if used) will add its own jackson provider

None

RESTEasy Reactive - Jackson

Class Name Attributes

io.quarkus.resteasy.reactive.jackson.deployment.processor.JacksonFeatureBuildItem: Contains the special Jackson features required by the application

Feature feature: No Javadoc found

io.quarkus.resteasy.reactive.jackson.deployment.processor.ResourceMethodCustomSerializationBuildItem: Used to pass info about a JAX-RS resource method that needs to perform custom serialization

MethodInfo methodInfo: No Javadoc found
ClassInfo declaringClassInfo: No Javadoc found
Class customSerializationProvider: No Javadoc found

RESTEasy Reactive - Server - SPI

Class Name Attributes

io.quarkus.resteasy.reactive.server.spi.AnnotationsTransformerBuildItem: Make it possible to add, remove or alter annotations on various components. The provided transformer uses to limit the scope of transformer to classes, fields, methods, method params or a combination of those. These metadata changes are not stored in Jandex directly (Jandex is immutable) but instead in an abstraction layer. Users/extensions can access to view the updated annotation model. NOTE: Extensions that operate purely on Jandex index analysis won't be able to see any changes made via !

AnnotationsTransformer transformer: No Javadoc found

io.quarkus.resteasy.reactive.server.spi.ContextTypeBuildItem: Register types that should be available for injection into JAX-RS methods via

DotName type: No Javadoc found

io.quarkus.resteasy.reactive.server.spi.MethodScannerBuildItem: No Javadoc found

MethodScanner methodScanner: No Javadoc found

io.quarkus.resteasy.reactive.server.spi.NonBlockingReturnTypeBuildItem: Register a type as non-blocking by default when used as a return type of JAX-RS Resource

DotName type: No Javadoc found

io.quarkus.resteasy.reactive.server.spi.ResumeOn404BuildItem: A marker build item which extensions can generate when they want to force RESTEasy Reactive to not reply with 404 when it does not handle the path and instead just pass control onto the next Vert.x handler

None

io.quarkus.resteasy.reactive.server.spi.UnwrappedExceptionBuildItem: When an Exception of this type is thrown and no exists, then RESTEasy Reactive will attempt to locate an for the cause of the Exception.

Class throwableClass: No Javadoc found

RESTEasy Reactive - SPI

Class Name Attributes

io.quarkus.resteasy.reactive.spi.AbstractInterceptorBuildItem: No Javadoc found

String className: No Javadoc found
Integer priority: No Javadoc found
boolean registerAsBean: No Javadoc found
Set nameBindingNames: No Javadoc found

io.quarkus.resteasy.reactive.spi.AdditionalResourceClassBuildItem: Can be used by extensions that want to make classes not annotated with JAX-RS part of the ResourceClass scanning process. This will likely be used in conjunction with

ClassInfo classInfo: No Javadoc found
String path: No Javadoc found

io.quarkus.resteasy.reactive.spi.ContainerRequestFilterBuildItem: No Javadoc found

boolean preMatching: No Javadoc found
boolean nonBlockingRequired: No Javadoc found
boolean readBody: No Javadoc found

io.quarkus.resteasy.reactive.spi.ContainerResponseFilterBuildItem: No Javadoc found

None

io.quarkus.resteasy.reactive.spi.ContextResolverBuildItem: No Javadoc found

String className: No Javadoc found
String providedType: No Javadoc found
List mediaTypes: No Javadoc found
boolean registerAsBean: No Javadoc found

io.quarkus.resteasy.reactive.spi.CustomContainerRequestFilterBuildItem: Build item used to register classes that are annotated with

String className: No Javadoc found

io.quarkus.resteasy.reactive.spi.CustomContainerResponseFilterBuildItem: Build item used to register classes that are annotated with

String className: No Javadoc found

io.quarkus.resteasy.reactive.spi.CustomExceptionMapperBuildItem: Build item used to register classes that are annotated with

String className: No Javadoc found

io.quarkus.resteasy.reactive.spi.DynamicFeatureBuildItem: No Javadoc found

String className: No Javadoc found
boolean registerAsBean: No Javadoc found

io.quarkus.resteasy.reactive.spi.ExceptionMapperBuildItem: No Javadoc found

String className: No Javadoc found
Integer priority: No Javadoc found
String handledExceptionName: No Javadoc found
boolean registerAsBean: No Javadoc found

io.quarkus.resteasy.reactive.spi.GeneratedJaxRsResourceBuildItem: Represents a JAX-RS resource that is generated. Meant to be used by extension that generate JAX-RS resources as part of their build time processing

String name: No Javadoc found
byte[] data: No Javadoc found

io.quarkus.resteasy.reactive.spi.JaxrsFeatureBuildItem: No Javadoc found

String className: No Javadoc found
boolean registerAsBean: No Javadoc found

io.quarkus.resteasy.reactive.spi.MessageBodyReaderBuildItem: No Javadoc found

String className: No Javadoc found
String handledClassName: No Javadoc found
List mediaTypeStrings: No Javadoc found
RuntimeType runtimeType: No Javadoc found
boolean builtin: No Javadoc found
Integer priority: No Javadoc found

io.quarkus.resteasy.reactive.spi.MessageBodyReaderOverrideBuildItem: No Javadoc found

String className: No Javadoc found
MessageBodyReaderWriterOverrideData overrideData: No Javadoc found

io.quarkus.resteasy.reactive.spi.MessageBodyWriterBuildItem: No Javadoc found

String className: No Javadoc found
String handledClassName: No Javadoc found
List mediaTypeStrings: No Javadoc found
RuntimeType runtimeType: No Javadoc found
boolean builtin: No Javadoc found
Integer priority: No Javadoc found

io.quarkus.resteasy.reactive.spi.MessageBodyWriterOverrideBuildItem: No Javadoc found

String className: No Javadoc found
MessageBodyReaderWriterOverrideData overrideData: No Javadoc found

io.quarkus.resteasy.reactive.spi.ParamConverterBuildItem: No Javadoc found

String className: No Javadoc found
int priority: No Javadoc found
boolean registerAsBean: No Javadoc found

io.quarkus.resteasy.reactive.spi.ReaderInterceptorBuildItem: No Javadoc found

None

io.quarkus.resteasy.reactive.spi.WriterInterceptorBuildItem: No Javadoc found

None

Security

Class Name Attributes

io.quarkus.security.deployment.AdditionalSecurityCheckBuildItem: Used as an integration point when extensions need to customize the security behavior of a bean The ResultHandle that is returned by function needs to be an instance of SecurityCheck

MethodInfo methodInfo: No Javadoc found
SecurityCheck securityCheck: No Javadoc found

io.quarkus.security.deployment.BouncyCastleJsseProviderBuildItem: No Javadoc found

boolean inFipsMode: No Javadoc found

io.quarkus.security.deployment.BouncyCastleProviderBuildItem: No Javadoc found

boolean inFipsMode: No Javadoc found

io.quarkus.security.deployment.JCAProviderBuildItem: Metadata for the names of JCA to register for reflection

String providerName: No Javadoc found

Security - SPI

Class Name Attributes

io.quarkus.security.spi.AdditionalSecuredClassesBuildItem: Contains classes that need to have @DenyAll on all methods that don't have security annotations

Collection additionalSecuredClasses: No Javadoc found
Optional rolesAllowed: No Javadoc found

SmallRye Health - SPI

Class Name Attributes

io.quarkus.smallrye.health.deployment.spi.HealthBuildItem: No Javadoc found

String healthCheckClass: No Javadoc found
boolean enabled: No Javadoc found

SmallRye OpenAPI

Class Name Attributes

io.quarkus.smallrye.openapi.deployment.OpenApiFilteredIndexViewBuildItem: The filtered Jandex index of the OpenApi

FilteredIndexView index: No Javadoc found

SmallRye OpenAPI - SPI

Class Name Attributes

io.quarkus.smallrye.openapi.deployment.spi.AddToOpenAPIDefinitionBuildItem: No Javadoc found

OASFilter filter: No Javadoc found

io.quarkus.smallrye.openapi.deployment.spi.IgnoreStaticDocumentBuildItem: Ignore a static OpenAPI document included in extension and/or dependencies. Supports regular expressions.

Pattern urlIgnorePattern: No Javadoc found

SmallRye Reactive Messaging

Class Name Attributes

io.quarkus.smallrye.reactivemessaging.deployment.items.ChannelBuildItem: Represents an application channel. These channels can be declared using , or injected , and .

String name: No Javadoc found
ChannelDirection direction: No Javadoc found
String connector: No Javadoc found

io.quarkus.smallrye.reactivemessaging.deployment.items.ConnectorBuildItem: Represents a reactive messaging connector. It contains the name (like ), the direction (incoming or outgoing), and the list of connector attributes (mainly for documentation and tooling purpose).

String name: No Javadoc found
ChannelDirection direction: No Javadoc found
List attributes: No Javadoc found

io.quarkus.smallrye.reactivemessaging.deployment.items.ConnectorManagedChannelBuildItem: Represents a channel managed by a connector.

String name: No Javadoc found
String connector: No Javadoc found
ChannelDirection direction: No Javadoc found

io.quarkus.smallrye.reactivemessaging.deployment.items.InjectedChannelBuildItem: Represents a channel injection.

String name: The name of the channel.

io.quarkus.smallrye.reactivemessaging.deployment.items.InjectedEmitterBuildItem: Represents an emitter injection.

String name: The name of the stream the emitter is connected to.
String overflow: The name of the overflow strategy. Valid values are . If not set, it uses with a default buffer size.
int bufferSize: The buffer size, used when is set to . Not that if is set to and is not set, an unbounded buffer is used.
boolean hasBroadcast: Whether the emitter uses the annotation.
boolean isMutinyEmitter: Whether the emitter is a or a regular (non-mutiny) emitter.
int awaitSubscribers: If the emitter uses the annotation, indicates the number of subscribers to be expected before subscribing upstream.

io.quarkus.smallrye.reactivemessaging.deployment.items.MediatorBuildItem: Represents a method annotated with or / and .

BeanInfo bean: No Javadoc found
MethodInfo method: No Javadoc found

io.quarkus.smallrye.reactivemessaging.deployment.items.OrphanChannelBuildItem: Represents an outbound channel without downstream or an inbound channel without upstream. In other words, this class represents channels that should be managed by connectors.

String name: No Javadoc found
ChannelDirection direction: No Javadoc found

Spring - DI

Class Name Attributes

io.quarkus.spring.di.deployment.SpringBeanNameToDotNameBuildItem: The purpose of this bean is to map the names of the Spring Beans to their associated DotName This info is needed when trying to convert SpEL expressions that reference beans by name, to bytecode

Map map: No Javadoc found

Spring - Scheduling

Class Name Attributes

io.quarkus.spring.scheduled.deployment.SpringScheduledAnnotatedMethodBuildItem: Build Item recording all the methods that have been effectively annotated with

Map methodToInstanceMap: No Javadoc found

Spring Security

Class Name Attributes

io.quarkus.spring.security.deployment.SpringPreAuthorizeAnnotatedMethodBuildItem: Build Item recording all the methods that have been effectively annotated with

Map methodToInstanceMap: No Javadoc found

Swagger UI

Class Name Attributes

io.quarkus.swaggerui.deployment.SwaggerUiBuildItem: No Javadoc found

String swaggerUiFinalDestination: No Javadoc found
String swaggerUiPath: No Javadoc found

Undertow - SPI

Class Name Attributes

io.quarkus.undertow.deployment.FilterBuildItem: No Javadoc found

String name: No Javadoc found
String filterClass: No Javadoc found
int loadOnStartup: No Javadoc found
boolean asyncSupported: No Javadoc found
List mappings: No Javadoc found
InstanceFactory instanceFactory: No Javadoc found
Map initParams: No Javadoc found

io.quarkus.undertow.deployment.GeneratedWebResourceBuildItem: A generated static resource that will be served by the web container This is automatically registered in native mode

String name: No Javadoc found
byte[] classData: No Javadoc found

io.quarkus.undertow.deployment.HttpHandlerWrapperBuildItem: No Javadoc found

HandlerWrapper value: No Javadoc found

io.quarkus.undertow.deployment.IgnoredServletContainerInitializerBuildItem: No Javadoc found

String sciClass: No Javadoc found

io.quarkus.undertow.deployment.KnownPathsBuildItem: No Javadoc found

Set knownFiles: No Javadoc found
Set knownDirectories: No Javadoc found

io.quarkus.undertow.deployment.ListenerBuildItem: No Javadoc found

String listenerClass: No Javadoc found

io.quarkus.undertow.deployment.ServletBuildItem: No Javadoc found

String name: No Javadoc found
String servletClass: No Javadoc found
int loadOnStartup: No Javadoc found
boolean asyncSupported: No Javadoc found
List mappings: No Javadoc found
InstanceFactory instanceFactory: No Javadoc found
Map initParams: No Javadoc found
MultipartConfigElement multipartConfig: No Javadoc found

io.quarkus.undertow.deployment.ServletContainerInitializerBuildItem: No Javadoc found

String sciClass: No Javadoc found
Set handlesTypes: No Javadoc found

io.quarkus.undertow.deployment.ServletContextAttributeBuildItem: No Javadoc found

String key: No Javadoc found
Object value: No Javadoc found

io.quarkus.undertow.deployment.ServletContextPathBuildItem: No Javadoc found

String servletContextPath: No Javadoc found

io.quarkus.undertow.deployment.ServletDeploymentManagerBuildItem: No Javadoc found

DeploymentManager deploymentManager: No Javadoc found

io.quarkus.undertow.deployment.ServletExtensionBuildItem: No Javadoc found

ServletExtension value: No Javadoc found

io.quarkus.undertow.deployment.ServletInitParamBuildItem: No Javadoc found

String key: No Javadoc found
String value: No Javadoc found

io.quarkus.undertow.deployment.UndertowBuildItem: No Javadoc found

RuntimeValue undertow: No Javadoc found

io.quarkus.undertow.deployment.WebMetadataBuildItem: No Javadoc found

WebMetaData webMetaData: No Javadoc found

Vert.x

Class Name Attributes

io.quarkus.vertx.core.deployment.CoreVertxBuildItem: No Javadoc found

Supplier vertx: No Javadoc found

io.quarkus.vertx.core.deployment.EventLoopCountBuildItem: A build item that can be used to retrieve the number of events loops that have been configured/calculated

Supplier eventLoopCount: No Javadoc found

io.quarkus.vertx.deployment.MessageCodecBuildItem: No Javadoc found

String type: No Javadoc found
String codec: No Javadoc found

io.quarkus.vertx.deployment.VertxBuildItem: No Javadoc found

RuntimeValue vertx: No Javadoc found

io.quarkus.vertx.core.deployment.VertxOptionsConsumerBuildItem

Provide a consumer of VertxOptions to allow customization of Vert.x system behavior, e.g. setting MetricsOptions to enable and configure a metrics provider.

Consumers will be called in priority order (lowest to highest) after VertxConfiguration has been read and applied.

Consumer optionsConsumer: No Javadoc found
int priority: No Javadoc found

Vert.x - HTTP

Class Name Attributes

io.quarkus.vertx.http.deployment.BodyHandlerBuildItem: No Javadoc found

Handler handler: No Javadoc found

io.quarkus.vertx.http.deployment.DefaultRouteBuildItem: A build item that represents a handler for the default route

Consumer route: No Javadoc found

io.quarkus.vertx.http.deployment.devmode.console.DevTemplatePathBuildItem: Represents a dev template path.

String path: No Javadoc found
String contents: No Javadoc found

io.quarkus.vertx.http.deployment.devmode.console.DevTemplateVariantsBuildItem: Holds all dev template variants found.

Map variants: No Javadoc found

io.quarkus.vertx.http.deployment.FilterBuildItem: A handler that is applied to every route

Handler handler: No Javadoc found
int priority: No Javadoc found

io.quarkus.vertx.http.deployment.HttpRootPathBuildItem: No Javadoc found

URI rootPath: Normalized from quarkus.http.root-path. This path will always end in a slash

io.quarkus.vertx.http.deployment.HttpSecurityPolicyBuildItem: No Javadoc found

String name: No Javadoc found
Supplier policySupplier: No Javadoc found

io.quarkus.vertx.http.deployment.NonApplicationRootPathBuildItem: No Javadoc found

URI httpRootPath: Normalized of quarkus.http.root-path. Must end in a slash
URI nonApplicationRootPath: Normalized from quarkus.http.non-application-root-path
boolean dedicatedRouterRequired: Non-Application root path is distinct from HTTP root path.
boolean attachedToMainRouter: No Javadoc found

io.quarkus.vertx.http.deployment.devmode.NotFoundPageDisplayableEndpointBuildItem: No Javadoc found

String endpoint: No Javadoc found
String description: No Javadoc found
boolean absolutePath: No Javadoc found

io.quarkus.vertx.http.deployment.RequireBodyHandlerBuildItem: This is a marker that indicates that the body handler should be installed on all routes, as an extension requires the request to be fully buffered.

None

io.quarkus.vertx.http.deployment.RequireVirtualHttpBuildItem: Marker class to turn on virtual http channel

boolean alwaysVirtual: No Javadoc found

io.quarkus.vertx.http.deployment.RouteBuildItem: No Javadoc found

Function routeFunction: No Javadoc found
Handler handler: No Javadoc found
HandlerType type: No Javadoc found
RouteType routeType: No Javadoc found
RouteType routerType: No Javadoc found
NotFoundPageDisplayableEndpointBuildItem notFoundPageDisplayableEndpoint: No Javadoc found
ConfiguredPathInfo configuredPathInfo: No Javadoc found

io.quarkus.vertx.http.deployment.devmode.RouteDescriptionBuildItem: No Javadoc found

RouteDescription description: No Javadoc found

io.quarkus.vertx.http.deployment.SecurityInformationBuildItem: Contains information on the security model used in the application

SecurityModel securityModel: No Javadoc found
Optional openIDConnectInformation: No Javadoc found

io.quarkus.vertx.http.deployment.VertxWebRouterBuildItem: No Javadoc found

RuntimeValue httpRouter: No Javadoc found
RuntimeValue mainRouter: No Javadoc found
RuntimeValue frameworkRouter: No Javadoc found
RuntimeValue mutinyRouter: No Javadoc found

io.quarkus.vertx.http.deployment.webjar.WebJarBuildItem: BuildItem for deploying a webjar.

GACT artifactKey: ArtifactKey pointing to the web jar. Has to be one of the applications dependencies.
String root: Root inside the webJar starting from which resources are unpacked.
boolean onlyCopyNonArtifactFiles: Only copy resources of the webjar which are either user overridden, or contain variables.
boolean useDefaultQuarkusBranding: Defines whether Quarkus can override resources of the webjar with Quarkus internal files.
WebJarResourcesFilter filter: No Javadoc found

io.quarkus.vertx.http.deployment.webjar.WebJarResultsBuildItem: Holds the complete result after applying every .

Map results: No Javadoc found

io.quarkus.vertx.http.deployment.WebsocketSubProtocolsBuildItem: No Javadoc found

String websocketSubProtocols: No Javadoc found

Vert.x - HTTP - Dev Console SPI

Class Name Attributes

io.quarkus.devconsole.spi.DevConsoleRouteBuildItem

A route for handling requests in the dev console.

Routes are registered under /q/dev/{groupId.{artifactId/

The route is registered:

in the "regular" app router (runtime class loader), if the handler is produced by a recorder (i.e. implements ),
in the Dev UI router (deployment class loader).

String groupId: No Javadoc found
String artifactId: No Javadoc found
String path: No Javadoc found
String method: No Javadoc found
Class callerClass: No Javadoc found
Handler handler: No Javadoc found
boolean isBodyHandlerRequired: No Javadoc found
boolean isBlockingHandler: No Javadoc found

io.quarkus.devconsole.spi.DevConsoleRuntimeTemplateInfoBuildItem: Information that can be directly displayed in dev console templates, using the info: prefix This is scoped to the extension that produced it, to prevent namespace clashes. This value will be evaluated at runtime, so can contain info that is produced from recorders

String groupId: No Javadoc found
String artifactId: No Javadoc found
String name: No Javadoc found
Supplier object: No Javadoc found

io.quarkus.devconsole.spi.DevConsoleTemplateInfoBuildItem

Information that can be directly displayed in dev console templates, using the info: prefix

This is scoped to the extension that produced it, to prevent namespace clashes

String name: No Javadoc found
Object object: No Javadoc found
Class callerClass: No Javadoc found

Vert.x - HTTP - SPI

Class Name Attributes

io.quarkus.vertx.http.deployment.spi.AdditionalStaticResourceBuildItem: Meant to be used by extensions that generate resource into . These resources cannot be picked up automatically by the standard Static resources handling because when the check is made, these resources don't exist yet on the file system. The value of should be prefixed with and is assumed to be a path under .

String path: No Javadoc found
boolean isDirectory: No Javadoc found

io.quarkus.vertx.http.deployment.spi.FrameworkEndpointsBuildItem: No Javadoc found

List endpoints: No Javadoc found

io.quarkus.vertx.http.deployment.spi.StaticResourcesBuildItem: No Javadoc found

Set entries: No Javadoc found

WebSockets Client

Class Name Attributes

io.quarkus.websockets.client.deployment.AnnotatedWebsocketEndpointBuildItem: A server websocket endpoint

String className: No Javadoc found
boolean client: No Javadoc found

io.quarkus.websockets.client.deployment.ServerWebSocketContainerBuildItem: No Javadoc found

RuntimeValue container: No Javadoc found

io.quarkus.websockets.client.deployment.ServerWebSocketContainerFactoryBuildItem: No Javadoc found

ServerWebSocketContainerFactory factory: No Javadoc found

io.quarkus.websockets.client.deployment.WebSocketDeploymentInfoBuildItem: No Javadoc found

RuntimeValue info: No Javadoc found