ConsulOperations (micronaut 1.1.4 API)

All Known Subinterfaces:

ConsulClient

All Known Implementing Classes:

AbstractConsulClient
```
public interface ConsulOperations
```
API operations for Consul.

Since:

1.0

Author:

graemerocher

Method Summary

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

Method Detail

putValue

@Put(value="/kv/{+key}",
     processes="text/plain",
     single=true)
Publisher<Boolean> putValue(String key,
                                                                                                    @Body
                                                                                                    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)
Publisher<List<KeyValue>> readValues(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}")
Publisher<List<KeyValue>> readValues(String key,
                                                                                                                                                                                                                                           @Nullable @QueryValue(value="dc")
                                                                                                                                                                                                                                           String datacenter,
                                                                                                                                                                                                                                           @Nullable
                                                                                                                                                                                                                                           Boolean raw,
                                                                                                                                                                                                                                           @Nullable
                                                                                                                                                                                                                                           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:10}",
           delay="${consul.client.registration.retry-delay:3s}")
Publisher<HttpStatus> pass(String checkId,
                                                                                                                                                                                                                  @Nullable
                                                                                                                                                                                                                  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}")
Publisher<HttpStatus> warn(String checkId,
                                                                            @Nullable
                                                                            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:10}",
           delay="${consul.client.registration.retry-delay:3s}")
Publisher<HttpStatus> fail(String checkId,
                                                                                                                                                                                                                  @Nullable
                                                                                                                                                                                                                  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
Publisher<String> status()

Returns:: The current leader address

register

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

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)
Publisher<Boolean> deregister(@NotNull @Body
                                                                                @NotNull CatalogEntry entry)

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:10}",
           delay="${consul.client.registration.retry-delay:3s}")
Publisher<HttpStatus> register(@NotNull @Body
                                                                                                                                                                                                           @NotNull NewServiceEntry entry)

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:10}",
           delay="${consul.client.registration.retry-delay:3s}")
Publisher<HttpStatus> deregister(@NotNull
                                                                                                                                                                                                                         @NotNull String service)

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)
Publisher<Map<String,ServiceEntry>> getServices()

Gets all of the registered services.

Returns:: The NewServiceEntry instances

getMembers
```
@Get(uri="/agent/members",
     single=true)
Publisher<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)
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)
Publisher<List<HealthEntry>> getHealthyServices(@NotNull
                                                                                                                         @NotNull String service,
                                                                                                                         @Nullable
                                                                                                                         Boolean passing,
                                                                                                                         @Nullable
                                                                                                                         String tag,
                                                                                                                         @Nullable
                                                                                                                         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)
Publisher<List<CatalogEntry>> getNodes()

Gets all of the registered nodes.

Returns:: All the nodes

getNodes

@Get(uri="/catalog/nodes?dc={datacenter}",
     single=true)
Publisher<List<CatalogEntry>> getNodes(@NotNull
                                                                                                    @NotNull 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)
Publisher<Map<String,List<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 Publisher<HttpStatus> pass(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 Publisher<HttpStatus> warn(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 Publisher<HttpStatus> fail(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 Publisher<List<HealthEntry>> getHealthyServices(@NotNull
                                                        @NotNull String service)

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

Parameters:: service - The service
Returns:: The HealthEntry instances

Interface ConsulOperations

Method Summary

Method Detail

putValue

readValues

readValues

pass

warn

fail

status

register

deregister

register

deregister

getServices

getMembers

getSelf

getHealthyServices

getNodes

getNodes

getServiceNames

pass

warn

fail

getHealthyServices