Class ConsulUpdatingListenerBuilder
java.lang.Object
com.linecorp.armeria.server.consul.ConsulUpdatingListenerBuilder
- All Implemented Interfaces:
ConsulConfigSetters
@UnstableApi
public final class ConsulUpdatingListenerBuilder
extends Object
implements ConsulConfigSetters
Builds a new
ConsulUpdatingListener
, which registers the server to Consul cluster.
Examples
ConsulUpdatingListener listener = ConsulUpdatingListener.builder(consulUri, "myService")
.build();
ServerBuilder sb = Server.builder();
sb.serverListener(listener);
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Returns a newly-createdConsulUpdatingListener
that registers theServer
to Consul when theServer
starts.checkInterval
(Duration checkInterval) Sets the specifiedDuration
for checking health.checkIntervalMillis
(long checkIntervalMillis) Sets the specifiedcheckIntervalMills
for checking health in milliseconds.checkMethod
(HttpMethod checkMethod) Sets HTTP method for checking health by Consul agent.Sets URI for checking health by Consul agent.Sets URI for checking health by Consul agent.consulApiVersion
(String consulApiVersion) Sets the specified Consul's API version.consulToken
(String consulToken) Sets the specified token for Consul's API.Sets theEndpoint
to register.Adds a list of tags to the list of tags associated with the service on registration.Adds a list of tags to the list of tags associated with the service on registration.
-
Method Details
-
checkUri
Sets URI for checking health by Consul agent.- Parameters:
checkUri
- the URI for checking health of service
-
checkUri
Sets URI for checking health by Consul agent.- Parameters:
checkUri
- the URI for checking health of service
-
checkMethod
Sets HTTP method for checking health by Consul agent. If not setHttpMethod.HEAD
is used by default.Note that the
checkMethod
should be configured withcheckUri(String)
. Otherwise, thebuild()
method will throw anIllegalStateException
.- Parameters:
checkMethod
- theHttpMethod
for checking health of service
-
checkInterval
Sets the specifiedDuration
for checking health. If not set 10000L milliseconds is used by default.Note that the
checkInterval
should be configured withcheckUri(URI)
. Otherwise, thebuild()
method will throw anIllegalStateException
. -
checkIntervalMillis
Sets the specifiedcheckIntervalMills
for checking health in milliseconds. If not set 10000L is used by default.Note that the
checkIntervalMillis
should be configured withcheckUri(URI)
. Otherwise, thebuild()
method will throwsIllegalStateException
. -
endpoint
Sets theEndpoint
to register. If not set, the current host name is used by default.- Parameters:
endpoint
- theEndpoint
to register
-
tags
Adds a list of tags to the list of tags associated with the service on registration.- Parameters:
tags
- the tags to add
-
tags
Adds a list of tags to the list of tags associated with the service on registration.- Parameters:
tags
- the tags to add
-
consulApiVersion
Description copied from interface:ConsulConfigSetters
Sets the specified Consul's API version.- Specified by:
consulApiVersion
in interfaceConsulConfigSetters
- Parameters:
consulApiVersion
- the version of Consul API service, default: "v1"
-
consulToken
Description copied from interface:ConsulConfigSetters
Sets the specified token for Consul's API.- Specified by:
consulToken
in interfaceConsulConfigSetters
- Parameters:
consulToken
- the token for accessing Consul API, default:null
-
build
Returns a newly-createdConsulUpdatingListener
that registers theServer
to Consul when theServer
starts.
-