Module io.helidon.metrics.api
Package io.helidon.metrics.api
Interface ComponentMetricsSettings.Builder
-
- All Superinterfaces:
Builder<ComponentMetricsSettings>,Supplier<ComponentMetricsSettings>
- Enclosing interface:
- ComponentMetricsSettings
public static interface ComponentMetricsSettings.Builder extends Builder<ComponentMetricsSettings>
Builder forComponentMetricsSettings.
-
-
Field Summary
Fields Modifier and Type Field Description static StringENABLED_CONFIG_KEYConfig key within the component'smetricsconfig section controlling whether metrics are enabled for that component.static StringMETRICS_CONFIG_KEYBy convention, the config key within the component's config section containing metrics settings for the component.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ComponentMetricsSettingsbuild()Constructs aComponentMetricsSettingsobject from the builder.ComponentMetricsSettings.Builderconfig(Config config)Updates the builder using the provided metrics config.ComponentMetricsSettings.Builderenabled(boolean value)Sets whether metrics should be enabled for the component.
-
-
-
Field Detail
-
METRICS_CONFIG_KEY
static final String METRICS_CONFIG_KEY
By convention, the config key within the component's config section containing metrics settings for the component.- See Also:
- Constant Field Values
-
ENABLED_CONFIG_KEY
static final String ENABLED_CONFIG_KEY
Config key within the component'smetricsconfig section controlling whether metrics are enabled for that component.- See Also:
- Constant Field Values
-
-
Method Detail
-
build
ComponentMetricsSettings build()
Constructs aComponentMetricsSettingsobject from the builder.- Specified by:
buildin interfaceBuilder<ComponentMetricsSettings>- Returns:
- new settings instance based on the builder
-
enabled
ComponentMetricsSettings.Builder enabled(boolean value)
Sets whether metrics should be enabled for the component.- Parameters:
value- true if metrics should be enabled for the component; false if not- Returns:
- updated builder
-
config
ComponentMetricsSettings.Builder config(Config config)
Updates the builder using the provided metrics config.- Parameters:
config- the component'smetricsconfig section- Returns:
- updated builder
-
-