| Package | Description |
|---|---|
| com.orbitz.consul | |
| com.orbitz.consul.cache | |
| com.orbitz.consul.option |
| Modifier and Type | Method and Description |
|---|---|
void |
CatalogClient.deregister(CatalogDeregistration deregistration,
QueryOptions options)
Deregisters a service or node.
|
void |
AgentClient.deregister(String serviceId,
QueryOptions options)
De-register a particular service from the Consul Agent.
|
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. |
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. |
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,
QueryOptions queryOptions)
Retrieves a list of matching keys for the given key.
|
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. |
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. |
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. |
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.
|
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.
|
void |
CatalogClient.register(CatalogRegistration registration,
QueryOptions options)
Registers a service or node.
|
void |
AgentClient.register(Registration registration,
QueryOptions options)
Registers the client as a service with Consul.
|
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.
|
| Modifier and Type | Method and Description |
|---|---|
protected static QueryOptions |
ConsulCache.watchParams(BigInteger index,
int blockSeconds,
QueryOptions queryOptions) |
| Modifier and Type | Method and Description |
|---|---|
static NodesCatalogCache |
NodesCatalogCache.newCache(CatalogClient catalogClient,
QueryOptions queryOptions,
int watchSeconds) |
static ServiceCatalogCache |
ServiceCatalogCache.newCache(CatalogClient catalogClient,
String serviceName,
QueryOptions queryOptions,
int watchSeconds) |
static HealthCheckCache |
HealthCheckCache.newCache(HealthClient healthClient,
State state,
int watchSeconds,
QueryOptions queryOptions) |
static HealthCheckCache |
HealthCheckCache.newCache(HealthClient healthClient,
State state,
int watchSeconds,
QueryOptions queryOptions,
Function<HealthCheck,String> keyExtractor)
Factory method to construct a string/
HealthCheck map for a particular State. |
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)
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) |
static KVCache |
KVCache.newCache(KeyValueClient kvClient,
String rootPath,
int watchSeconds,
QueryOptions queryOptions) |
protected static QueryOptions |
ConsulCache.watchParams(BigInteger index,
int blockSeconds,
QueryOptions queryOptions) |
| Modifier and Type | Class and Description |
|---|---|
class |
ImmutableQueryOptions
Immutable implementation of
QueryOptions. |
| Modifier and Type | Field and Description |
|---|---|
static QueryOptions |
QueryOptions.BLANK |
| Modifier and Type | Method and Description |
|---|---|
static ImmutableQueryOptions |
ImmutableQueryOptions.copyOf(QueryOptions instance)
Creates an immutable copy of a
QueryOptions value. |
ImmutableQueryOptions.Builder |
ImmutableQueryOptions.Builder.from(QueryOptions instance)
Fill a builder with attribute values from the provided
QueryOptions instance. |
Copyright © 2019. All rights reserved.