Module io.helidon.microprofile.restclient.metrics

Package io.helidon.microprofile.restclientmetrics

Interface RestClientMetricsConfig

All Superinterfaces:

Prototype.Api

All Known Implementing Classes:

RestClientMetricsConfig.BuilderBase.RestClientMetricsConfigImpl

public interface RestClientMetricsConfig
extends Prototype.Api

Configuration settings for MP REST client metrics.

See Also:

• builder()
• create()

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	RestClientMetricsConfig.Builder	Fluent API builder for RestClientMetricsConfig.
static class	RestClientMetricsConfig.BuilderBase<BUILDER extends RestClientMetricsConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends RestClientMetricsConfig>	Fluent API builder base for RestClientMetricsConfig.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONFIG_KEY	Root=level config key for REST client metrics settings.

Method Summary

Modifier and Type	Method	Description
static RestClientMetricsConfig.Builder	builder()	Create a new fluent API builder to customize configuration.
static RestClientMetricsConfig.Builder	builder(RestClientMetricsConfig instance)	Create a new fluent API builder from an existing instance.
static RestClientMetricsConfig	create()	Create a new instance with default values.
static RestClientMetricsConfig	create(Config config)	Create a new instance from configuration.
boolean	enabled()	Whether REST client metrics functionality is enabled.

Field Details

CONFIG_KEY

static final String CONFIG_KEY

Root=level config key for REST client metrics settings.

See Also:

• Constant Field Values

Method Details

builder

static RestClientMetricsConfig.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

static RestClientMetricsConfig.Builder builder(RestClientMetricsConfig instance)

Create a new fluent API builder from an existing instance.

Parameters:

instance - an existing instance used as a base for the builder

Returns:

a builder based on an instance

create

static RestClientMetricsConfig create(Config config)

Create a new instance from configuration.

Parameters:

config - used to configure the new instance

Returns:

a new instance configured from configuration

create

static RestClientMetricsConfig create()

Create a new instance with default values.

Returns:

a new instance

enabled

boolean enabled()

Whether REST client metrics functionality is enabled.

Returns:

if REST client metrics are configured to be enabled