Skip to main content

Class Coordinate

Namespace: Consul
Assembly: Consul.dll

public class Coordinate : ICoordinateEndpoint

Inheritance

objectCoordinate

Implements

ICoordinateEndpoint

Inherited Members

object.Equals(object) , object.Equals(object, object) , object.GetHashCode() , object.GetType() , object.MemberwiseClone() , object.ReferenceEquals(object, object) , object.ToString()

Methods

Datacenters(CancellationToken)

Datacenters is used to return the coordinates of all the servers in the WAN pool.

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

Parameters

ct CancellationToken

Returns

Task <QueryResult <CoordinateDatacenterMap []>>

A query result containing a map of datacenters, each with a list of coordinates of all the servers in the WAN pool

Node(string, QueryOptions, CancellationToken)

Node returns the coordinates of a given node in the LAN pool.

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

Parameters

node string

The node to query

q QueryOptions

Customized query options

ct CancellationToken

The cancellation token

Returns

Task <QueryResult <CoordinateEntry []>>

Node is used to return the coordinates of a given node in the LAN pool.

Node(string, CancellationToken)

public Task<QueryResult<CoordinateEntry[]>> Node(string node, CancellationToken ct)

Parameters

node string

ct CancellationToken

Returns

Task <QueryResult <CoordinateEntry []>>

Node(string)

public Task<QueryResult<CoordinateEntry[]>> Node(string node)

Parameters

node string

Returns

Task <QueryResult <CoordinateEntry []>>

Nodes(CancellationToken)

Nodes is used to return the coordinates of all the nodes in the LAN pool.

public Task<QueryResult<CoordinateEntry[]>> Nodes(CancellationToken ct)

Parameters

ct CancellationToken

Returns

Task <QueryResult <CoordinateEntry []>>

A query result containing coordinates of all the nodes in the LAN pool

Nodes()

public Task<QueryResult<CoordinateEntry[]>> Nodes()

Returns

Task <QueryResult <CoordinateEntry []>>

Nodes(QueryOptions, CancellationToken)

Nodes is used to return the coordinates of all the nodes in the LAN pool.

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

Parameters

q QueryOptions

Customized query options

ct CancellationToken

The cancellation token

Returns

Task <QueryResult <CoordinateEntry []>>

A query result containing coordinates of all the nodes in the LAN pool

Update(CoordinateEntry, WriteOptions, CancellationToken)

Updates the LAN network coordinates for a node in a given datacenter.

public Task<WriteResult> Update(CoordinateEntry entry, WriteOptions q, CancellationToken ct = default)

Parameters

entry CoordinateEntry

The coordinate entry to update

q WriteOptions

Customized write options

ct CancellationToken

Cancellation Token

Returns

Task <WriteResult >

An empty write result

Update(CoordinateEntry, CancellationToken)

Updates the LAN network coordinates for a node in a given datacenter.

public Task<WriteResult> Update(CoordinateEntry entry, CancellationToken ct)

Parameters

entry CoordinateEntry

The coordinate entry to update

ct CancellationToken

Cancellation Token

Returns

Task <WriteResult >

An empty write result

Update(CoordinateEntry)

public Task<WriteResult> Update(CoordinateEntry entry)

Parameters

entry CoordinateEntry

Returns

Task <WriteResult >

  • Methods
    • Datacenters(CancellationToken)
    • Node(string, QueryOptions, CancellationToken)
    • Node(string, CancellationToken)
    • Node(string)
    • Nodes(CancellationToken)
    • Nodes()
    • Nodes(QueryOptions, CancellationToken)
    • Update(CoordinateEntry, WriteOptions, CancellationToken)
    • Update(CoordinateEntry, CancellationToken)
    • Update(CoordinateEntry)