Interface ICatalogEndpoint

Namespace: Consul
Assembly: Consul.dll

The interface for the Catalog API Endpoints

public interface ICatalogEndpoint

Methods

Datacenters(CancellationToken)

Task<QueryResult<string[]>> Datacenters(CancellationToken ct = default)

Parameters

ct CancellationToken

Returns

Task <QueryResult <string []>>

Datacenters(QueryOptions, CancellationToken)

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

Parameters

q QueryOptions

ct CancellationToken

Returns

Task <QueryResult <string []>>

Deregister(CatalogDeregistration, CancellationToken)

Task<WriteResult> Deregister(CatalogDeregistration reg, CancellationToken ct = default)

Parameters

reg CatalogDeregistration

ct CancellationToken

Returns

Task <WriteResult >

Deregister(CatalogDeregistration, WriteOptions, CancellationToken)

Task<WriteResult> Deregister(CatalogDeregistration reg, WriteOptions q, CancellationToken ct = default)

Parameters

reg CatalogDeregistration

q WriteOptions

ct CancellationToken

Returns

Task <WriteResult >

GatewayService(string, QueryOptions, CancellationToken)

Task<QueryResult<GatewayService[]>> GatewayService(string gateway, QueryOptions q, CancellationToken ct = default)

Parameters

gateway string

q QueryOptions

ct CancellationToken

Returns

Task <QueryResult <GatewayService []>>

GatewayService(string, CancellationToken)

Task<QueryResult<GatewayService[]>> GatewayService(string gateway, CancellationToken ct = default)

Parameters

gateway string

ct CancellationToken

Returns

Task <QueryResult <GatewayService []>>

Node(string, CancellationToken)

Task<QueryResult<CatalogNode>> Node(string node, CancellationToken ct = default)

Parameters

node string

ct CancellationToken

Returns

Task <QueryResult <CatalogNode >>

Node(string, QueryOptions, CancellationToken)

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

Parameters

node string

q QueryOptions

ct CancellationToken

Returns

Task <QueryResult <CatalogNode >>

Nodes(CancellationToken)

Task<QueryResult<Node[]>> Nodes(CancellationToken ct = default)

Parameters

ct CancellationToken

Returns

Task <QueryResult <Node []>>

Nodes(QueryOptions, CancellationToken)

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

Parameters

q QueryOptions

ct CancellationToken

Returns

Task <QueryResult <Node []>>

NodesForMeshCapableService(string, Filter, CancellationToken)

Task<QueryResult<CatalogService[]>> NodesForMeshCapableService(string service, Filter filter, CancellationToken ct = default)

Parameters

service string

filter Filter

ct CancellationToken

Returns

Task <QueryResult <CatalogService []>>

NodesForMeshCapableService(string, QueryOptions, Filter, CancellationToken)

Task<QueryResult<CatalogService[]>> NodesForMeshCapableService(string service, QueryOptions q, Filter filter, CancellationToken ct = default)

Parameters

service string

q QueryOptions

filter Filter

ct CancellationToken

Returns

Task <QueryResult <CatalogService []>>

NodesForMeshCapableService(string, CancellationToken)

Task<QueryResult<CatalogService[]>> NodesForMeshCapableService(string service, CancellationToken ct = default)

Parameters

service string

ct CancellationToken

Returns

Task <QueryResult <CatalogService []>>

Register(CatalogRegistration, CancellationToken)

Task<WriteResult> Register(CatalogRegistration reg, CancellationToken ct = default)

Parameters

reg CatalogRegistration

ct CancellationToken

Returns

Task <WriteResult >

Register(CatalogRegistration, WriteOptions, CancellationToken)

Task<WriteResult> Register(CatalogRegistration reg, WriteOptions q, CancellationToken ct = default)

Parameters

reg CatalogRegistration

q WriteOptions

ct CancellationToken

Returns

Task <WriteResult >

Service(string, CancellationToken)

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

Parameters

service string

ct CancellationToken

Returns

Task <QueryResult <CatalogService []>>

Service(string, string, CancellationToken)

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

Parameters

service string

tag string

ct CancellationToken

Returns

Task <QueryResult <CatalogService []>>

Service(string, string, QueryOptions, CancellationToken)

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

Parameters

service string

tag string

q QueryOptions

ct CancellationToken

Returns

Task <QueryResult <CatalogService []>>

Services(CancellationToken)

Task<QueryResult<Dictionary<string, string[]>>> Services(CancellationToken ct = default)

Parameters

ct CancellationToken

Returns

Task <QueryResult <Dictionary <string , string []>>>

Services(QueryOptions, CancellationToken)

Task<QueryResult<Dictionary<string, string[]>>> Services(QueryOptions q, CancellationToken ct = default)

Parameters

q QueryOptions

ct CancellationToken

Returns

Task <QueryResult <Dictionary <string , string []>>>

ServicesForNode(string, QueryOptions, CancellationToken)

Task<QueryResult<NodeService>> ServicesForNode(string node, QueryOptions q, CancellationToken ct = default)

Parameters

node string

q QueryOptions

ct CancellationToken

Returns

Task <QueryResult <NodeService >>

ServicesForNode(string, CancellationToken)

Task<QueryResult<NodeService>> ServicesForNode(string node, CancellationToken ct = default)

Parameters

node string

ct CancellationToken

Returns

Task <QueryResult <NodeService >>