com.orbitz.consul

Class CatalogClient

java.lang.Object

com.orbitz.consul.CatalogClient

public class CatalogClient
extends Object

HTTP Client for /v1/catalog/ endpoints.

Method Summary

Modifier and Type	Method and Description
List<String>	getDatacenters() Retrieves all datacenters.
ConsulResponse<CatalogNode>	getNode(String node) Retrieves a single node.
ConsulResponse<CatalogNode>	getNode(String node, CatalogOptions catalogOptions) Retrieves a single node for a given datacenter.
ConsulResponse<CatalogNode>	getNode(String node, CatalogOptions catalogOptions, QueryOptions queryOptions) Retrieves a single node for a given datacenter with QueryOptions.
ConsulResponse<CatalogNode>	getNode(String node, QueryOptions queryOptions) Retrieves a single node with QueryOptions.
ConsulResponse<List<Node>>	getNodes() Retrieves all nodes.
ConsulResponse<List<Node>>	getNodes(CatalogOptions catalogOptions) Retrieves all nodes for a given datacenter.
ConsulResponse<List<Node>>	getNodes(CatalogOptions catalogOptions, QueryOptions queryOptions) Retrieves all nodes for a given datacenter with QueryOptions.
ConsulResponse<List<Node>>	getNodes(QueryOptions queryOptions) Retrieves all nodes with QueryOptions.
ConsulResponse<List<CatalogService>>	getService(String service) Retrieves a single service.
ConsulResponse<List<CatalogService>>	getService(String service, CatalogOptions catalogOptions) Retrieves a single service for a given datacenter.
ConsulResponse<List<CatalogService>>	getService(String service, CatalogOptions catalogOptions, QueryOptions queryOptions) Retrieves a single service for a given datacenter with QueryOptions.
ConsulResponse<List<CatalogService>>	getService(String service, QueryOptions queryOptions) Retrieves a single service with QueryOptions.
ConsulResponse<Map<String,List<String>>>	getServices() Retrieves all services for a given datacenter.
ConsulResponse<Map<String,List<String>>>	getServices(CatalogOptions catalogOptions) Retrieves all services for a given datacenter.
ConsulResponse<Map<String,List<String>>>	getServices(CatalogOptions catalogOptions, QueryOptions queryOptions) Retrieves all services for a given datacenter with QueryOptions.
ConsulResponse<Map<String,List<String>>>	getServices(QueryOptions queryOptions) Retrieves all services for a given datacenter with QueryOptions.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getDatacenters

public List<String> getDatacenters()

Retrieves all datacenters. GET /v1/catalog/datacenters

Returns:

A list of datacenter names.

getNodes

public ConsulResponse<List<Node>> getNodes()

Retrieves all nodes. GET /v1/catalog/nodes

Returns:

A ConsulResponse containing a list of Node objects.

getNodes

public ConsulResponse<List<Node>> getNodes(CatalogOptions catalogOptions)

Retrieves all nodes for a given datacenter. GET /v1/catalog/nodes?dc={datacenter}

Parameters:

catalogOptions - Catalog specific options to use.

Returns:

A ConsulResponse containing a list of Node objects.

getNodes

public ConsulResponse<List<Node>> getNodes(QueryOptions queryOptions)

Retrieves all nodes with QueryOptions. GET /v1/catalog/nodes

Parameters:

queryOptions - The Query Options to use.

Returns:

A ConsulResponse containing a list of Node objects.

getNodes

public ConsulResponse<List<Node>> getNodes(CatalogOptions catalogOptions,
                                           QueryOptions queryOptions)

Retrieves all nodes for a given datacenter with QueryOptions. GET /v1/catalog/nodes?dc={datacenter}

Parameters:

catalogOptions - Catalog specific options to use.

queryOptions - The Query Options to use.

Returns:

A ConsulResponse containing a list of Node objects.

getServices

public ConsulResponse<Map<String,List<String>>> getServices()

Retrieves all services for a given datacenter. GET /v1/catalog/services?dc={datacenter}

Returns:

A ConsulResponse containing a map of service name to list of tags.

getServices

public ConsulResponse<Map<String,List<String>>> getServices(CatalogOptions catalogOptions)

Retrieves all services for a given datacenter. GET /v1/catalog/services?dc={datacenter}

Parameters:

catalogOptions - Catalog specific options to use.

Returns:

A ConsulResponse containing a map of service name to list of tags.

getServices

public ConsulResponse<Map<String,List<String>>> getServices(QueryOptions queryOptions)

Retrieves all services for a given datacenter with QueryOptions. GET /v1/catalog/services?dc={datacenter}

Parameters:

queryOptions - The Query Options to use.

Returns:

A ConsulResponse containing a map of service name to list of tags.

getServices

public ConsulResponse<Map<String,List<String>>> getServices(CatalogOptions catalogOptions,
                                                            QueryOptions queryOptions)

Retrieves all services for a given datacenter with QueryOptions. GET /v1/catalog/services?dc={datacenter}

Parameters:

catalogOptions - Catalog specific options to use.

queryOptions - The Query Options to use.

Returns:

A ConsulResponse containing a map of service name to list of tags.

getService

public ConsulResponse<List<CatalogService>> getService(String service)

Retrieves a single service. GET /v1/catalog/service/{service}

Returns:

A ConsulResponse containing CatalogService objects.

getService

public ConsulResponse<List<CatalogService>> getService(String service,
                                                       CatalogOptions catalogOptions)

Retrieves a single service for a given datacenter. GET /v1/catalog/service/{service}?dc={datacenter}

Parameters:

catalogOptions - Catalog specific options to use.

Returns:

A ConsulResponse containing CatalogService objects.

getService

public ConsulResponse<List<CatalogService>> getService(String service,
                                                       QueryOptions queryOptions)

Retrieves a single service with QueryOptions. GET /v1/catalog/service/{service}

Parameters:

queryOptions - The Query Options to use.

Returns:

A ConsulResponse containing CatalogService objects.

getService

public ConsulResponse<List<CatalogService>> getService(String service,
                                                       CatalogOptions catalogOptions,
                                                       QueryOptions queryOptions)

Retrieves a single service for a given datacenter with QueryOptions. GET /v1/catalog/service/{service}?dc={datacenter}

Parameters:

catalogOptions - Catalog specific options to use.

queryOptions - The Query Options to use.

Returns:

A ConsulResponse containing CatalogService objects.

getNode

public ConsulResponse<CatalogNode> getNode(String node)

Retrieves a single node. GET /v1/catalog/node/{node}

Returns:

A list of matching CatalogService objects.

getNode

public ConsulResponse<CatalogNode> getNode(String node,
                                           CatalogOptions catalogOptions)

Retrieves a single node for a given datacenter. GET /v1/catalog/node/{node}?dc={datacenter}

Parameters:

catalogOptions - Catalog specific options to use.

Returns:

A list of matching CatalogService objects.

getNode

public ConsulResponse<CatalogNode> getNode(String node,
                                           QueryOptions queryOptions)

Retrieves a single node with QueryOptions. GET /v1/catalog/node/{node}

Parameters:

queryOptions - The Query Options to use.

Returns:

A list of matching CatalogService objects.

getNode

public ConsulResponse<CatalogNode> getNode(String node,
                                           CatalogOptions catalogOptions,
                                           QueryOptions queryOptions)

Retrieves a single node for a given datacenter with QueryOptions. GET /v1/catalog/node/{node}?dc={datacenter}

Parameters:

catalogOptions - Catalog specific options to use.

queryOptions - The Query Options to use.

Returns:

A list of matching CatalogService objects.