Uses of Class
org.kiwiproject.consul.option.QueryOptions

Packages that use QueryOptions

Package	Description
org.kiwiproject.consul
org.kiwiproject.consul.cache
org.kiwiproject.consul.option

Uses of QueryOptions in org.kiwiproject.consul

Methods in org.kiwiproject.consul with parameters of type QueryOptions

Modifier and Type	Method	Description
void	AgentClient.deregister(String serviceId, QueryOptions options)	De-register a particular service from the Consul Agent.
void	CatalogClient.deregister(CatalogDeregistration deregistration, QueryOptions options)	De-registers a service or node.
void	PreparedQueryClient.execute(String nameOrId, QueryOptions options, Callback<QueryResults> callback)	Executes a prepared query by its name or ID.
ConsulResponse<List<ServiceHealth>>	HealthClient.getAllServiceInstances(String service, QueryOptions queryOptions)	Retrieves the healthchecks for all nodes in a given datacenter with QueryOptions.
void	HealthClient.getAllServiceInstances(String service, QueryOptions queryOptions, ConsulResponseCallback<List<ServiceHealth>> callback)	Asynchronously retrieves the healthchecks for all nodes in a given datacenter with QueryOptions.
Map<String,HealthCheck>	AgentClient.getChecks(QueryOptions queryOptions)	Retrieves all checks registered with the Agent.
ConsulResponse<List<HealthCheck>>	HealthClient.getChecksByState(State state, QueryOptions queryOptions)	Retrieves the healthchecks for a state in a given datacenter with QueryOptions.
void	HealthClient.getChecksByState(State state, QueryOptions queryOptions, ConsulResponseCallback<List<HealthCheck>> callback)	Asynchronously retrieves the healthchecks for a state in a given datacenter with QueryOptions.
Optional<ConsulResponse<Value>>	KeyValueClient.getConsulResponseWithValue(String key, QueryOptions queryOptions)	Returns a ConsulResponse for a specific key from the kv store.
ConsulResponse<List<Value>>	KeyValueClient.getConsulResponseWithValues(String key, QueryOptions queryOptions)	Retrieves a ConsulResponse with a list of Value objects along with consul response headers for a specific key from the key/value store.
List<String>	CatalogClient.getDatacenters(QueryOptions queryOptions)	Get the list of datacenters with query options
ConsulResponse<List<ServiceHealth>>	HealthClient.getHealthyServiceInstances(String service, QueryOptions queryOptions)	Retrieves the healthchecks for all healthy service instances in a given datacenter with QueryOptions.
void	HealthClient.getHealthyServiceInstances(String service, QueryOptions queryOptions, ConsulResponseCallback<List<ServiceHealth>> callback)	Asynchronously retrieves the healthchecks for all healthy service instances in a given datacenter with QueryOptions.
List<String>	KeyValueClient.getKeys(String key, String separator, QueryOptions queryOptions)	Retrieves a list of matching keys for the given key.
List<String>	KeyValueClient.getKeys(String key, QueryOptions queryOptions)	Retrieves a list of matching keys for the given key.
String	StatusClient.getLeader(QueryOptions queryOptions)	Retrieves the host/port of the Consul leader.
List<Member>	AgentClient.getMembers(QueryOptions queryOptions)	Retrieves all members that the Agent can see in the gossip pool.
ConsulResponse<CatalogNode>	CatalogClient.getNode(String node, QueryOptions queryOptions)	Retrieves a single node for a given datacenter with QueryOptions.
void	CatalogClient.getNode(String node, QueryOptions queryOptions, ConsulResponseCallback<CatalogNode> callback)	Asynchronously retrieves the single node for a given datacenter with QueryOptions.
ConsulResponse<List<HealthCheck>>	HealthClient.getNodeChecks(String node, QueryOptions queryOptions)	Retrieves the healthchecks for a node in a given datacenter with QueryOptions.
ConsulResponse<List<Node>>	CatalogClient.getNodes(QueryOptions queryOptions)	Retrieves all nodes for a given datacenter with QueryOptions.
void	CatalogClient.getNodes(QueryOptions queryOptions, ConsulResponseCallback<List<Node>> callback)	Asynchronously retrieves the nodes for a given datacenter with QueryOptions.
List<String>	StatusClient.getPeers(QueryOptions queryOptions)	Retrieves a list of host/ports for raft peers.
ConsulResponse<FullService>	AgentClient.getService(String id, QueryOptions queryOptions)	Retrieves all information about a service.
void	AgentClient.getService(String id, QueryOptions queryOptions, ConsulResponseCallback<FullService> callback)	Retrieves all information about a service.
ConsulResponse<List<CatalogService>>	CatalogClient.getService(String service, QueryOptions queryOptions)	Retrieves a single service for a given datacenter with QueryOptions.
void	CatalogClient.getService(String service, QueryOptions queryOptions, ConsulResponseCallback<List<CatalogService>> callback)	Asynchronously retrieves the single service for a given datacenter with QueryOptions.
ConsulResponse<List<HealthCheck>>	HealthClient.getServiceChecks(String service, QueryOptions queryOptions)	Retrieves the healthchecks for a service in a given datacenter with QueryOptions.
void	HealthClient.getServiceChecks(String service, QueryOptions queryOptions, ConsulResponseCallback<List<HealthCheck>> callback)	Asynchronously retrieves the healthchecks for a service in a given datacenter with QueryOptions.
Map<String,Service>	AgentClient.getServices(QueryOptions queryOptions)	Retrieves all services registered with the Agent.
ConsulResponse<Map<String,List<String>>>	CatalogClient.getServices(QueryOptions queryOptions)	Retrieves all services for a given datacenter.
void	CatalogClient.getServices(QueryOptions queryOptions, ConsulResponseCallback<Map<String,List<String>>> callback)	Asynchronously retrieves the services for a given datacenter.
Optional<Value>	KeyValueClient.getValue(String key, QueryOptions queryOptions)	Retrieves a Value for a specific key from the key/value store.
void	KeyValueClient.getValue(String key, QueryOptions queryOptions, ConsulResponseCallback<Optional<Value>> callback)	Asynchronously retrieves a Value for a specific key from the key/value store.
List<Value>	KeyValueClient.getValues(String key, QueryOptions queryOptions)	Retrieves a list of Value objects for a specific key from the key/value store.
void	KeyValueClient.getValues(String key, QueryOptions queryOptions, ConsulResponseCallback<List<Value>> callback)	Asynchronously retrieves a list of Value objects for a specific key from the key/value store.
boolean	AgentClient.join(String address, QueryOptions queryOptions)	GET /v1/agent/join/{address}?queryOptions
EventResponse	EventClient.listEvents(String name, QueryOptions queryOptions)	Lists events for the Consul agent.
void	EventClient.listEvents(String name, QueryOptions queryOptions, EventResponseCallback callback)	Asynchronously lists events for the Consul agent.
EventResponse	EventClient.listEvents(QueryOptions queryOptions)	Lists events for the Consul agent.
void	EventClient.listEvents(QueryOptions queryOptions, EventResponseCallback callback)	Asynchronously lists events for the Consul agent.
void	AgentClient.register(Registration registration, QueryOptions options)
void	AgentClient.register(Registration registration, QueryOptions options, QueryParameterOptions queryParameterOptions)	Registers the client as a service with Consul.
void	CatalogClient.register(CatalogRegistration registration, QueryOptions options)	Registers a service or node.
void	SnapshotClient.restore(File sourceFile, QueryOptions queryOptions, Callback<Void> callback)	Restores a snapshot stored in a file.
void	SnapshotClient.save(File destinationFile, QueryOptions queryOptions, Callback<BigInteger> callback)	Requests a new snapshot and save it in a file.
void	AgentClient.toggleMaintenanceMode(String serviceId, QueryOptions queryOptions)	Toggles maintenance mode for a service ID.

Uses of QueryOptions in org.kiwiproject.consul.cache

Methods in org.kiwiproject.consul.cache that return QueryOptions

Modifier and Type	Method	Description
protected static QueryOptions	ConsulCache.watchParams(BigInteger index, int blockSeconds, QueryOptions queryOptions)

Methods in org.kiwiproject.consul.cache with parameters of type QueryOptions

Modifier and Type	Method	Description
static HealthCheckCache	HealthCheckCache.newCache(HealthClient healthClient, State checkState, int watchSeconds, QueryOptions queryOptions)
static HealthCheckCache	HealthCheckCache.newCache(HealthClient healthClient, State checkState, int watchSeconds, QueryOptions queryOptions, Function<HealthCheck,String> keyExtractor)
static HealthCheckCache	HealthCheckCache.newCache(HealthClient healthClient, State checkState, int watchSeconds, QueryOptions queryOptions, Function<HealthCheck,String> keyExtractor, ScheduledExecutorService callbackExecutorService)	Factory method to construct a string/HealthCheck map for a particular State.
static KVCache	KVCache.newCache(KeyValueClient kvClient, String rootPath, int watchSeconds, QueryOptions queryOptions)
static KVCache	KVCache.newCache(KeyValueClient kvClient, String rootPath, int watchSeconds, QueryOptions queryOptions, ScheduledExecutorService callbackExecutorService)
static NodesCatalogCache	NodesCatalogCache.newCache(CatalogClient catalogClient, QueryOptions queryOptions, int watchSeconds)
static NodesCatalogCache	NodesCatalogCache.newCache(CatalogClient catalogClient, QueryOptions queryOptions, int watchSeconds, ScheduledExecutorService callbackExecutorService)
static ServiceCatalogCache	ServiceCatalogCache.newCache(CatalogClient catalogClient, String serviceName, QueryOptions queryOptions, int watchSeconds)
static ServiceCatalogCache	ServiceCatalogCache.newCache(CatalogClient catalogClient, String serviceName, QueryOptions queryOptions, int watchSeconds, ScheduledExecutorService callbackExecutorService)
static ServiceHealthCache	ServiceHealthCache.newCache(HealthClient healthClient, String serviceName, boolean passing, int watchSeconds, QueryOptions queryOptions)
static ServiceHealthCache	ServiceHealthCache.newCache(HealthClient healthClient, String serviceName, boolean passing, int watchSeconds, QueryOptions queryOptions, Function<ServiceHealth,ServiceHealthKey> keyExtractor)
static ServiceHealthCache	ServiceHealthCache.newCache(HealthClient healthClient, String serviceName, boolean passing, int watchSeconds, QueryOptions queryOptions, Function<ServiceHealth,ServiceHealthKey> keyExtractor, ScheduledExecutorService callbackExecutorService)	Factory method to construct a string/ServiceHealth map for a particular service.
static ServiceHealthCache	ServiceHealthCache.newCache(HealthClient healthClient, String serviceName, boolean passing, QueryOptions queryOptions, int watchSeconds)
protected static QueryOptions	ConsulCache.watchParams(BigInteger index, int blockSeconds, QueryOptions queryOptions)

Uses of QueryOptions in org.kiwiproject.consul.option

Subclasses of QueryOptions in org.kiwiproject.consul.option

Modifier and Type	Class	Description
final class	ImmutableQueryOptions	Immutable implementation of QueryOptions.

Fields in org.kiwiproject.consul.option declared as QueryOptions

Modifier and Type	Field	Description
static final QueryOptions	QueryOptions.BLANK

Methods in org.kiwiproject.consul.option with parameters of type QueryOptions

Modifier and Type	Method	Description
static ImmutableQueryOptions	ImmutableQueryOptions.copyOf(QueryOptions instance)	Creates an immutable copy of a QueryOptions value.
final ImmutableQueryOptions.Builder	ImmutableQueryOptions.Builder.from(QueryOptions instance)	Fill a builder with attribute values from the provided org.kiwiproject.consul.option.QueryOptions instance.