ConsulConfig (Quarkus - Consul Config - Runtime 2.1.0.CR1 API)

java.lang.Object
- io.quarkus.consul.config.runtime.ConsulConfig

@ConfigRoot(name="consul-config",
            phase=BOOTSTRAP)
public class ConsulConfig
extends Object

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class ConsulConfig.AgentConfig

Field Summary

Fields
Modifier and Type	Field	Description
`(package private) ConsulConfig.AgentConfig`	`agent`	Consul agent related configuration
`(package private) boolean`	`enabled`	If set to true, the application will attempt to look up the configuration from Consul
`(package private) boolean`	`failOnMissingKey`	If set to true, the application will not start if any of the configured config sources cannot be located
`(package private) Optional<String>`	`prefix`	Common prefix that all keys share when looking up the keys from Consul.
`(package private) Optional<List<String>>`	`propertiesValueKeys`	Keys whose value represents a properties file.
`(package private) Optional<List<String>>`	`rawValueKeys`	Keys whose value is a raw string.

Constructor Summary

Constructors
Constructor Description

ConsulConfig()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type Method Description

(package private) Map<String,ValueType> keysAsMap()
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - enabled
```
@ConfigItem(defaultValue="false")
boolean enabled
```
    If set to true, the application will attempt to look up the configuration from Consul
  - agent
```
@ConfigItem
ConsulConfig.AgentConfig agent
```
    Consul agent related configuration
  - prefix
```
@ConfigItem
Optional<String> prefix
```
    Common prefix that all keys share when looking up the keys from Consul. The prefix is not included in the keys of the user configuration
  - rawValueKeys
```
@ConfigItem
Optional<List<String>> rawValueKeys
```
    Keys whose value is a raw string. When this is used, the keys that end up in the user configuration are the keys specified her with '/' replaced by '.'
  - propertiesValueKeys
```
@ConfigItem
Optional<List<String>> propertiesValueKeys
```
    Keys whose value represents a properties file. When this is used, the keys that end up in the user configuration are the keys of the properties file, not these keys
  - failOnMissingKey
```
@ConfigItem(defaultValue="true")
boolean failOnMissingKey
```
    If set to true, the application will not start if any of the configured config sources cannot be located
- Constructor Detail
  - ConsulConfig
```
public ConsulConfig()
```
- Method Detail
  - keysAsMap
```
Map<String,ValueType> keysAsMap()
```