com.orbitz.consul

Class PreparedQueryClient

java.lang.Object

com.orbitz.consul.PreparedQueryClient

public class PreparedQueryClient
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected Http	http

Method Summary

Modifier and Type	Method and Description
String	createPreparedQuery(PreparedQuery preparedQuery) Creates a prepared query.
String	createPreparedQuery(PreparedQuery preparedQuery, String dc) Creates a prepared query.
QueryResults	execute(String nameOrId) Executes a prepared query by its name or ID.
void	execute(String nameOrId, QueryOptions options, Callback<QueryResults> callback) Executes a prepared query by its name or ID.
ClientConfig	getConfig()
ClientEventHandler	getEventHandler()
List<StoredQuery>	getPreparedQueries() Retrieves the list of prepared queries.
List<StoredQuery>	getPreparedQueries(String dc) Retrieves the list of prepared queries.
Optional<StoredQuery>	getPreparedQuery(String id) Retrieves a prepared query by its ID.
Optional<StoredQuery>	getPreparedQuery(String id, String dc) Retrieves a prepared query by its ID.

Methods inherited from class java.lang.Object

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

Field Detail

http

protected final Http http

Method Detail

createPreparedQuery

public String createPreparedQuery(PreparedQuery preparedQuery)

Creates a prepared query. POST /v1/query

Parameters:

preparedQuery - The prepared query to create.

Returns:

The ID of the created query.

createPreparedQuery

public String createPreparedQuery(PreparedQuery preparedQuery,
                                  String dc)

Creates a prepared query. POST /v1/query

Parameters:

preparedQuery - The prepared query to create.

dc - The data center.

Returns:

The ID of the created query.

getPreparedQueries

public List<StoredQuery> getPreparedQueries()

Retrieves the list of prepared queries. GET /v1/query

Returns:

The list of prepared queries.

getPreparedQueries

public List<StoredQuery> getPreparedQueries(String dc)

Retrieves the list of prepared queries. GET /v1/query

Parameters:

dc - The data center.

Returns:

The list of prepared queries.

getPreparedQuery

public Optional<StoredQuery> getPreparedQuery(String id)

Retrieves a prepared query by its ID. GET /v1/query/{id}

Parameters:

id - The query ID.

Returns:

The store prepared query.

getPreparedQuery

public Optional<StoredQuery> getPreparedQuery(String id,
                                              String dc)

Retrieves a prepared query by its ID. GET /v1/query/{id}

Parameters:

id - The query ID.

dc - The data center.

Returns:

The store prepared query.

execute

public QueryResults execute(String nameOrId)

Executes a prepared query by its name or ID.

Parameters:

nameOrId - The query name or ID.

Returns:

A QueryResults object containing service instances.

execute

public void execute(String nameOrId,
                    QueryOptions options,
                    Callback<QueryResults> callback)

Executes a prepared query by its name or ID.

Parameters:

nameOrId - The query name or ID.

options - Query options.

callback - Basic callback for the response.

getConfig

public ClientConfig getConfig()

getEventHandler

public ClientEventHandler getEventHandler()