Module io.helidon.discovery.providers.eureka

Package io.helidon.discovery.providers.eureka

Interface EurekaDiscoveryConfig

All Superinterfaces:

Prototype.Api, Prototype.Factory<EurekaDiscovery>

All Known Implementing Classes:

EurekaDiscoveryConfig.BuilderBase.EurekaDiscoveryConfigImpl

public interface EurekaDiscoveryConfig
extends Prototype.Api

Prototypical state for EurekaDiscovery instances.

The EurekaDiscoveryConfig class is generated at compile time using facilities from the Helidon Builder API.

Instances of this class are returned by the EurekaDiscovery.prototype() method.

See Also:

• EurekaDiscovery
• EurekaDiscovery.prototype()
• EurekaDiscovery.create(EurekaDiscoveryConfig)
• builder()
• create()

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static EurekaDiscoveryConfig.Builder	builder()	Create a new fluent API builder to customize configuration.
static EurekaDiscoveryConfig.Builder	builder(EurekaDiscoveryConfig instance)	Create a new fluent API builder from an existing instance.
CacheConfig	cache()	The CacheConfig to use controlling how a local cache of Eureka server information is used.
Optional<Http1Client>	client()	The Http1Client to use to communicate with the Eureka server.
static EurekaDiscoveryConfig	create()	Create a new instance with default values.
static EurekaDiscoveryConfig	create(Config config)	Deprecated. use create(io.helidon.config.Config)
static EurekaDiscoveryConfig	create(Config config)	Create a new instance from configuration.
String	name()	The name of this EurekaDiscoveryConfig instance; the default value of "eureka" is normally entirely suitable.
boolean	preferIpAddress()	Whether the host component of any URI should be set to the IP address stored by Eureka, or the hostname; false by default.

Methods inherited from interface io.helidon.builder.api.Prototype.Factory

build

Method Details

builder

static EurekaDiscoveryConfig.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

static EurekaDiscoveryConfig.Builder builder(EurekaDiscoveryConfig 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 EurekaDiscoveryConfig 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

@Deprecated
static EurekaDiscoveryConfig create(Config config)

Deprecated.

use create(io.helidon.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 EurekaDiscoveryConfig create()

Create a new instance with default values.

Returns:

a new instance

cache

CacheConfig cache()

The CacheConfig to use controlling how a local cache of Eureka server information is used.

Returns:

a CacheConfig

See Also:

• CacheConfig

client

Optional<Http1Client> client()

The Http1Client to use to communicate with the Eureka server.

To be useful, the client must have a prototype whose HttpClientConfig.BuilderBase.baseUri(io.helidon.webclient.api.ClientUri) property is set to the endpoint of a Eureka Server instance. Often this value will be something like http://example.com:8761/eureka.

Returns:

a Http1Client

See Also:

• Http1Client
• HttpClientConfig.BuilderBase.baseUri(io.helidon.webclient.api.ClientUri)

name

String name()

The name of this EurekaDiscoveryConfig instance; the default value of "eureka" is normally entirely suitable.

Returns:

the name of this instance

See Also:

• NamedService.name()

preferIpAddress

boolean preferIpAddress()

Whether the host component of any URI should be set to the IP address stored by Eureka, or the hostname; false by default.

Returns:

true if the IP address should be used; false if the hostname should be used