Skip to main content

Interface IHealthEndpoint

Namespace: Consul
Assembly: Consul.dll

The interface for the Health API Endpoints

public interface IHealthEndpoint

Methods​

Checks(string, CancellationToken)​

Task<QueryResult<HealthCheck[]>> Checks(string service, CancellationToken ct = default)

Parameters​

service string

ct CancellationToken

Returns​

Task <QueryResult <HealthCheck []>>

Checks(string, QueryOptions, CancellationToken)​

Task<QueryResult<HealthCheck[]>> Checks(string service, QueryOptions q, CancellationToken ct = default)

Parameters​

service string

q QueryOptions

ct CancellationToken

Returns​

Task <QueryResult <HealthCheck []>>

Connect(string, string, bool, QueryOptions, Filter, CancellationToken)​

Task<QueryResult<ServiceEntry[]>> Connect(string service, string tag, bool passingOnly, QueryOptions q, Filter filter, CancellationToken ct = default)

Parameters​

service string

tag string

passingOnly bool

q QueryOptions

filter Filter

ct CancellationToken

Returns​

Task <QueryResult <ServiceEntry []>>

Connect(string, string, bool, QueryOptions, CancellationToken)​

Task<QueryResult<ServiceEntry[]>> Connect(string service, string tag, bool passingOnly, QueryOptions q, CancellationToken ct = default)

Parameters​

service string

tag string

passingOnly bool

q QueryOptions

ct CancellationToken

Returns​

Task <QueryResult <ServiceEntry []>>

Ingress(string, string, bool, QueryOptions, Filter, CancellationToken)​

Task<QueryResult<ServiceEntry[]>> Ingress(string service, string tag, bool passingOnly, QueryOptions q, Filter filter, CancellationToken ct = default)

Parameters​

service string

tag string

passingOnly bool

q QueryOptions

filter Filter

ct CancellationToken

Returns​

Task <QueryResult <ServiceEntry []>>

Ingress(string, string, bool, QueryOptions, CancellationToken)​

Task<QueryResult<ServiceEntry[]>> Ingress(string service, string tag, bool passingOnly, QueryOptions q, CancellationToken ct = default)

Parameters​

service string

tag string

passingOnly bool

q QueryOptions

ct CancellationToken

Returns​

Task <QueryResult <ServiceEntry []>>

Ingress(string, string, bool, CancellationToken)​

Task<QueryResult<ServiceEntry[]>> Ingress(string service, string tag, bool passingOnly, CancellationToken ct = default)

Parameters​

service string

tag string

passingOnly bool

ct CancellationToken

Returns​

Task <QueryResult <ServiceEntry []>>

Node(string, CancellationToken)​

Task<QueryResult<HealthCheck[]>> Node(string node, CancellationToken ct = default)

Parameters​

node string

ct CancellationToken

Returns​

Task <QueryResult <HealthCheck []>>

Node(string, QueryOptions, CancellationToken)​

Task<QueryResult<HealthCheck[]>> Node(string node, QueryOptions q, CancellationToken ct = default)

Parameters​

node string

q QueryOptions

ct CancellationToken

Returns​

Task <QueryResult <HealthCheck []>>

Service(string, CancellationToken)​

Task<QueryResult<ServiceEntry[]>> Service(string service, CancellationToken ct = default)

Parameters​

service string

ct CancellationToken

Returns​

Task <QueryResult <ServiceEntry []>>

Service(string, string, CancellationToken)​

Task<QueryResult<ServiceEntry[]>> Service(string service, string tag, CancellationToken ct = default)

Parameters​

service string

tag string

ct CancellationToken

Returns​

Task <QueryResult <ServiceEntry []>>

Service(string, string, bool, CancellationToken)​

Task<QueryResult<ServiceEntry[]>> Service(string service, string tag, bool passingOnly, CancellationToken ct = default)

Parameters​

service string

tag string

passingOnly bool

ct CancellationToken

Returns​

Task <QueryResult <ServiceEntry []>>

Service(string, string, bool, QueryOptions, CancellationToken)​

Task<QueryResult<ServiceEntry[]>> Service(string service, string tag, bool passingOnly, QueryOptions q, CancellationToken ct = default)

Parameters​

service string

tag string

passingOnly bool

q QueryOptions

ct CancellationToken

Returns​

Task <QueryResult <ServiceEntry []>>

Service(string, string, bool, QueryOptions, Filter, CancellationToken)​

Task<QueryResult<ServiceEntry[]>> Service(string service, string tag, bool passingOnly, QueryOptions q, Filter filter, CancellationToken ct = default)

Parameters​

service string

tag string

passingOnly bool

q QueryOptions

filter Filter

ct CancellationToken

Returns​

Task <QueryResult <ServiceEntry []>>

State(HealthStatus, CancellationToken)​

Task<QueryResult<HealthCheck[]>> State(HealthStatus status, CancellationToken ct = default)

Parameters​

status HealthStatus

ct CancellationToken

Returns​

Task <QueryResult <HealthCheck []>>

State(HealthStatus, QueryOptions, CancellationToken)​

Task<QueryResult<HealthCheck[]>> State(HealthStatus status, QueryOptions q, CancellationToken ct = default)

Parameters​

status HealthStatus

q QueryOptions

ct CancellationToken

Returns​

Task <QueryResult <HealthCheck []>>

  • Methods
    • Checks(string, CancellationToken)
    • Checks(string, QueryOptions, CancellationToken)
    • Connect(string, string, bool, QueryOptions, Filter, CancellationToken)
    • Connect(string, string, bool, QueryOptions, CancellationToken)
    • Ingress(string, string, bool, QueryOptions, Filter, CancellationToken)
    • Ingress(string, string, bool, QueryOptions, CancellationToken)
    • Ingress(string, string, bool, CancellationToken)
    • Node(string, CancellationToken)
    • Node(string, QueryOptions, CancellationToken)
    • Service(string, CancellationToken)
    • Service(string, string, CancellationToken)
    • Service(string, string, bool, CancellationToken)
    • Service(string, string, bool, QueryOptions, CancellationToken)
    • Service(string, string, bool, QueryOptions, Filter, CancellationToken)
    • State(HealthStatus, CancellationToken)
    • State(HealthStatus, QueryOptions, CancellationToken)