io.micronaut.discovery.consul.client.v1

Interface ConsulOperations

All Known Subinterfaces:

ConsulClient

All Known Implementing Classes:

AbstractConsulClient

public interface ConsulOperations

API operations for Consul.

Since:

1.0

Author:

graemerocher

Method Summary

Modifier and Type	Method and Description
org.reactivestreams.Publisher<java.lang.Boolean>	deregister(@NotNull CatalogEntry entry) Register a new CatalogEntry.
org.reactivestreams.Publisher<io.micronaut.http.HttpStatus>	deregister(@NotNull java.lang.String service) Register a new CatalogEntry.
default org.reactivestreams.Publisher<io.micronaut.http.HttpStatus>	fail(java.lang.String checkId) Fail the TTL check.
org.reactivestreams.Publisher<io.micronaut.http.HttpStatus>	fail(java.lang.String checkId, java.lang.String note) Fail the TTL check.
default org.reactivestreams.Publisher<java.util.List<HealthEntry>>	getHealthyServices(@NotNull java.lang.String service) Gets service health information.
org.reactivestreams.Publisher<java.util.List<HealthEntry>>	getHealthyServices(@NotNull java.lang.String service, java.lang.Boolean passing, java.lang.String tag, java.lang.String dc) Gets the healthy services that are passing health checks.
org.reactivestreams.Publisher<java.util.List<MemberEntry>>	getMembers() Returns the members the agent sees in the cluster gossip pool.
org.reactivestreams.Publisher<java.util.List<CatalogEntry>>	getNodes() Gets all of the registered nodes.
org.reactivestreams.Publisher<java.util.List<CatalogEntry>>	getNodes(@NotNull java.lang.String datacenter) Gets all the nodes for the given data center.
org.reactivestreams.Publisher<LocalAgentConfiguration>	getSelf() Returns the configuration and member information of the local agent.
org.reactivestreams.Publisher<java.util.Map<java.lang.String,java.util.List<java.lang.String>>>	getServiceNames() Gets all of the service names and optional tags.
org.reactivestreams.Publisher<java.util.Map<java.lang.String,ServiceEntry>>	getServices() Gets all of the registered services.
default org.reactivestreams.Publisher<io.micronaut.http.HttpStatus>	pass(java.lang.String checkId) Pass the TTL check.
org.reactivestreams.Publisher<io.micronaut.http.HttpStatus>	pass(java.lang.String checkId, java.lang.String note) Pass the TTL check.
org.reactivestreams.Publisher<java.lang.Boolean>	putValue(java.lang.String key, java.lang.String value) Writes a value for the given key to Consul.
org.reactivestreams.Publisher<java.util.List<KeyValue>>	readValues(java.lang.String key) Reads a Key from Consul.
org.reactivestreams.Publisher<java.util.List<KeyValue>>	readValues(java.lang.String key, java.lang.String datacenter, java.lang.Boolean raw, java.lang.String seperator) Reads a Key from Consul.
org.reactivestreams.Publisher<java.lang.Boolean>	register(@NotNull CatalogEntry entry) Register a new CatalogEntry.
org.reactivestreams.Publisher<io.micronaut.http.HttpStatus>	register(@NotNull NewServiceEntry entry) Register a new CatalogEntry.
org.reactivestreams.Publisher<java.lang.String>	status()
default org.reactivestreams.Publisher<io.micronaut.http.HttpStatus>	warn(java.lang.String checkId) Warn the TTL check.
org.reactivestreams.Publisher<io.micronaut.http.HttpStatus>	warn(java.lang.String checkId, java.lang.String note) Warn the TTL check.

Method Detail

putValue

@Put(value="/kv/{+key}",
     processes="text/plain",
     single=true)
org.reactivestreams.Publisher<java.lang.Boolean> putValue(java.lang.String key,
                                                                                                                                  @Body
                                                                                                                                  java.lang.String value)

Writes a value for the given key to Consul.

Parameters:

key - The key

value - The value as a String

Returns:

A Publisher that emits a boolean if the operation succeeded

readValues

@Get(uri="/kv/{+key}?recurse",
     single=true)
org.reactivestreams.Publisher<java.util.List<KeyValue>> readValues(java.lang.String key)

Reads a Key from Consul. See https://www.consul.io/api/kv.html.

Parameters:

key - The key to read

Returns:

A Publisher that emits a list of KeyValue

readValues

@Get(uri="/kv/{+key}?recurse=true{&dc}{&raw}{&seperator}",
     single=true)
 @Retryable(attempts="${consul.client.config.retry-count:3}",
           delay="${consul.client.config.retry-delay:1s}")
org.reactivestreams.Publisher<java.util.List<KeyValue>> readValues(java.lang.String key,
                                                                                                                                                                                                                                                                         @Nullable @QueryValue(value="dc")
                                                                                                                                                                                                                                                                         java.lang.String datacenter,
                                                                                                                                                                                                                                                                         @Nullable
                                                                                                                                                                                                                                                                         java.lang.Boolean raw,
                                                                                                                                                                                                                                                                         @Nullable
                                                                                                                                                                                                                                                                         java.lang.String seperator)

Reads a Key from Consul. See https://www.consul.io/api/kv.html.

Parameters:

key - The key

datacenter - The data center

raw - Whether the value should be raw without encoding or metadata

seperator - The separator to use

Returns:

A Publisher that emits a list of KeyValue

pass

@Put(value="/agent/check/pass/{checkId}{?note}")
 @Retryable(attempts="${consul.client.registration.retry-count:3}",
           delay="${consul.client.registration.retry-delay:3s}")
org.reactivestreams.Publisher<io.micronaut.http.HttpStatus> pass(java.lang.String checkId,
                                                                                                                                                                                                                                                       @Nullable
                                                                                                                                                                                                                                                       java.lang.String note)

Pass the TTL check. See https://www.consul.io/api/agent/check.html.

Parameters:

checkId - The check ID

note - An optional note

Returns:

An HttpStatus of HttpStatus.OK if all is well

warn

@Put(value="/agent/check/warn/{checkId}{?note}")
org.reactivestreams.Publisher<io.micronaut.http.HttpStatus> warn(java.lang.String checkId,
                                                                                                                  @Nullable
                                                                                                                  java.lang.String note)

Warn the TTL check. See https://www.consul.io/api/agent/check.html.

Parameters:

checkId - The check ID

note - An optional note

Returns:

An HttpStatus of HttpStatus.OK if all is well

fail

@Put(value="/agent/check/fail/{checkId}{?note}")
 @Retryable(attempts="${consul.client.registration.retry-count:3}",
           delay="${consul.client.registration.retry-delay:3s}")
org.reactivestreams.Publisher<io.micronaut.http.HttpStatus> fail(java.lang.String checkId,
                                                                                                                                                                                                                                                       @Nullable
                                                                                                                                                                                                                                                       java.lang.String note)

Fail the TTL check. See https://www.consul.io/api/agent/check.html.

Parameters:

checkId - The check ID

note - An optional note

Returns:

An HttpStatus of HttpStatus.OK if all is well

status

@Get(uri="/status/leader",
     single=true)
 @Retryable
org.reactivestreams.Publisher<java.lang.String> status()

Returns:

The current leader address

register

@Put(uri="/catalog/register",
     single=true)
org.reactivestreams.Publisher<java.lang.Boolean> register(@NotNull @Body
                                                                                                          @NotNull CatalogEntry entry)

Register a new CatalogEntry. See https://www.consul.io/api/catalog.html.

Parameters:

entry - The entry to register

Returns:

A Publisher that emits a boolean true if the operation was successful

deregister

@Put(uri="/catalog/deregister",
     single=true)
org.reactivestreams.Publisher<java.lang.Boolean> deregister(@NotNull @Body
                                                                                                              @NotNull CatalogEntry entry)

Register a new CatalogEntry. See https://www.consul.io/api/catalog.html.

Parameters:

entry - The entry to register

Returns:

A Publisher that emits a boolean true if the operation was successful

register

@Put(value="/agent/service/register")
 @Retryable(attempts="${consul.client.registration.retry-count:3}",
           delay="${consul.client.registration.retry-delay:3s}")
org.reactivestreams.Publisher<io.micronaut.http.HttpStatus> register(@NotNull @Body
                                                                                                                                                                                                                                                @NotNull NewServiceEntry entry)

Register a new CatalogEntry. See https://www.consul.io/api/catalog.html.

Parameters:

entry - The entry to register

Returns:

A Publisher that emits a boolean true if the operation was successful

deregister

@Put(value="/agent/service/deregister/{service}")
 @Retryable(attempts="${consul.client.registration.retry-count:3}",
           delay="${consul.client.registration.retry-delay:3s}")
org.reactivestreams.Publisher<io.micronaut.http.HttpStatus> deregister(@NotNull
                                                                                                                                                                                                                                                              @NotNull java.lang.String service)

Register a new CatalogEntry. See https://www.consul.io/api/catalog.html.

Parameters:

service - The service to register

Returns:

A Publisher that emits a boolean true if the operation was successful

getServices

@Get(uri="/agent/services",
     single=true)
org.reactivestreams.Publisher<java.util.Map<java.lang.String,ServiceEntry>> getServices()

Gets all of the registered services.

Returns:

The NewServiceEntry instances

getMembers

@Get(uri="/agent/members",
     single=true)
org.reactivestreams.Publisher<java.util.List<MemberEntry>> getMembers()

Returns the members the agent sees in the cluster gossip pool.

Returns:

the MemberEntry instances

getSelf

@Get(uri="/agent/self",
     single=true)
org.reactivestreams.Publisher<LocalAgentConfiguration> getSelf()

Returns the configuration and member information of the local agent.

Returns:

the LocalAgentConfiguration instance

getHealthyServices

@Get(uri="/health/service/{service}{?passing,tag,dc}",
     single=true)
org.reactivestreams.Publisher<java.util.List<HealthEntry>> getHealthyServices(@NotNull
                                                                                                                                                       @NotNull java.lang.String service,
                                                                                                                                                       @Nullable
                                                                                                                                                       java.lang.Boolean passing,
                                                                                                                                                       @Nullable
                                                                                                                                                       java.lang.String tag,
                                                                                                                                                       @Nullable
                                                                                                                                                       java.lang.String dc)

Gets the healthy services that are passing health checks.

Parameters:

service - The service

passing - The passing parameter

tag - The tag

dc - The dc

Returns:

The HealthEntry instances

getNodes

@Get(uri="/catalog/nodes",
     single=true)
org.reactivestreams.Publisher<java.util.List<CatalogEntry>> getNodes()

Gets all of the registered nodes.

Returns:

All the nodes

getNodes

@Get(uri="/catalog/nodes?dc={datacenter}",
     single=true)
org.reactivestreams.Publisher<java.util.List<CatalogEntry>> getNodes(@NotNull
                                                                                                                                  @NotNull java.lang.String datacenter)

Gets all the nodes for the given data center.

Parameters:

datacenter - The data center

Returns:

A publisher that emits the nodes

getServiceNames

@Get(uri="/catalog/services",
     single=true)
org.reactivestreams.Publisher<java.util.Map<java.lang.String,java.util.List<java.lang.String>>> getServiceNames()

Gets all of the service names and optional tags.

Returns:

A Map where the keys are service names and the values are service tags

pass

default org.reactivestreams.Publisher<io.micronaut.http.HttpStatus> pass(java.lang.String checkId)

Pass the TTL check. See https://www.consul.io/api/agent/check.html.

Parameters:

checkId - The check ID

Returns:

An HttpStatus of HttpStatus.OK if all is well

warn

default org.reactivestreams.Publisher<io.micronaut.http.HttpStatus> warn(java.lang.String checkId)

Warn the TTL check. See https://www.consul.io/api/agent/check.html.

Parameters:

checkId - The check ID

Returns:

An HttpStatus of HttpStatus.OK if all is well

fail

default org.reactivestreams.Publisher<io.micronaut.http.HttpStatus> fail(java.lang.String checkId)

Fail the TTL check. See https://www.consul.io/api/agent/check.html.

Parameters:

checkId - The check ID

Returns:

An HttpStatus of HttpStatus.OK if all is well

getHealthyServices

default org.reactivestreams.Publisher<java.util.List<HealthEntry>> getHealthyServices(@NotNull
                                                                                      @NotNull java.lang.String service)

Gets service health information. Defaults to return both non-healthy and healthy services.

Parameters:

service - The service

Returns:

The HealthEntry instances