Interface IConsulDiscoveryClient

Namespace

Steeltoe.Discovery.Consul.Discovery

Assembly

Steeltoe.Discovery.Consul.dll

A Consul Discovery client

public interface IConsulDiscoveryClient : IDiscoveryClient, IServiceInstanceProvider, IDisposable

Inherited Members

IDiscoveryClient.GetLocalServiceInstance()

IDiscoveryClient.ShutdownAsync()

IServiceInstanceProvider.Description

IServiceInstanceProvider.Services

IServiceInstanceProvider.GetInstances(string)

IDisposable.Dispose()

Methods

GetAllInstances(QueryOptions)

Get all the instances from the Consul catalog

IList<IServiceInstance> GetAllInstances(QueryOptions queryOptions = null)

Parameters

queryOptions QueryOptions

any Consul query options to use

Returns

IList<IServiceInstance>

list of found service instances

GetInstances(string, QueryOptions)

Get all the instances for the given service id

IList<IServiceInstance> GetInstances(string serviceId, QueryOptions queryOptions = null)

Parameters

serviceId string

the service to lookup

queryOptions QueryOptions

any Consul query options to use

Returns

IList<IServiceInstance>

list of found service instances

GetServices(QueryOptions)

Get all of the services from the Consul catalog

IList<string> GetServices(QueryOptions queryOptions = null)

Parameters

queryOptions QueryOptions

any Consul query options to use

Returns

IList<string>

list of found services