Coordinate
consul4s.v1.api.Coordinate
Attributes
- Graph
-
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
-
class ConsulApi[F]class ConsulClient[F]
- Self type
-
ConsulApi[F]
Members list
Value members
Concrete methods
GET /coordinate/datacenters
GET /coordinate/datacenters
Value parameters
- token
-
- consul token
Attributes
- Returns
-
- This endpoint returns the WAN network coordinates for all Consul servers, organized by datacenters.
def getNodeCoordinate(node: String, dc: Option[String], consistencyMode: ConsistencyMode, token: Option[String]): F[Result[Option[List[NodeCoordinate]]]]
GET /coordinate/node/:node
GET /coordinate/node/:node
Value parameters
- consistencyMode
-
- see ConsistencyMode
- dc
-
- Specifies the datacenter to query. This will default to the datacenter of the agent being queried. This is specified as part of the URL as a query parameter. Using this across datacenters is not recommended.
- node
-
- node id
- token
-
- consul token
Attributes
- Returns
-
- This endpoint returns the LAN network coordinates for the given node.
def getNodeCoordinates(dc: Option[String], consistencyMode: ConsistencyMode, token: Option[String]): F[Result[List[NodeCoordinate]]]
GET /coordinate/nodes
GET /coordinate/nodes
Value parameters
- consistencyMode
-
- see ConsistencyMode
- dc
-
- Specifies the datacenter to query. This will default to the datacenter of the agent being queried. This is specified as part of the URL as a query parameter. Using this across datacenters is not recommended.
- token
-
- consul token
Attributes
- Returns
-
- This endpoint returns the LAN network coordinates for all nodes in a given datacenter.
def updateNodeCoordinate(nodeCoordinate: NodeCoordinate, dc: Option[String], token: Option[String]): F[Result[Unit]]
PUT /coordinate/update This endpoint updates the LAN network coordinates for a node in a given datacenter.
PUT /coordinate/update This endpoint updates the LAN network coordinates for a node in a given datacenter.
Value parameters
- dc
-
- Specifies the datacenter to query. This will default to the datacenter of the agent being queried. This is specified as part of the URL as a query parameter. Using this across datacenters is not recommended.
- nodeCoordinate
-
- new coordinates
- token
-
- consul token
Attributes
- Returns
-
- unit
In this article