Package io.quarkus.restclient.config

Interface RestClientsBuildTimeConfig

@ConfigMapping(prefix="quarkus.rest-client")
@ConfigRoot(phase=BUILD_TIME)
public interface RestClientsBuildTimeConfig

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	RestClientsBuildTimeConfig.RestClientBuildConfig

Method Summary

Modifier and Type	Method	Description
@WithKeys(RestClientKeysProvider.class) Map<String,RestClientsBuildTimeConfig.RestClientBuildConfig>	clients()	Configurations of REST client instances.
boolean	removesTrailingSlash()	If true, the extension will automatically remove the trailing slash in the paths if any.
Optional<String>	scope()	The CDI scope to use for injection.

Method Details

clients

@WithParentName
@WithDefaults
@WithKeys(RestClientKeysProvider.class)
@ConfigDocMapKey("client")
@WithKeys(RestClientKeysProvider.class) Map<String,RestClientsBuildTimeConfig.RestClientBuildConfig> clients()

Configurations of REST client instances.

scope

Optional<String> scope()

The CDI scope to use for injection. This property can contain either a fully qualified class name of a CDI scope annotation (such as "jakarta.enterprise.context.ApplicationScoped") or its simple name (such as "ApplicationScoped"). By default, this is not set which means the interface is not registered as a bean unless it is annotated with RegisterRestClient. If an interface is not annotated with RegisterRestClient and this property is set, then Quarkus will make the interface a bean of the configured scope.

removesTrailingSlash

@WithName("removes-trailing-slash")
@WithDefault("true")
boolean removesTrailingSlash()

If true, the extension will automatically remove the trailing slash in the paths if any. This property is not applicable to the RESTEasy Client.