Package org.kiwiproject.consul

Class EventClient

java.lang.Object

org.kiwiproject.consul.EventClient

public class EventClient
extends Object

HTTP Client for /v1/event/ endpoints.

See Also:

• The Consul API Docs

Field Summary

Fields

Modifier and Type	Field	Description
protected final Http	http

Method Summary

Modifier and Type	Method	Description
Event	fireEvent(String name)	Fires a Consul event.
Event	fireEvent(String name, String payload)	Fires a Consul event.
Event	fireEvent(String name, EventOptions eventOptions)	Fires a Consul event.
Event	fireEvent(String name, EventOptions eventOptions, String payload)	Fires a Consul event.
ClientConfig	getConfig()
ClientEventHandler	getEventHandler()
EventResponse	listEvents()	Lists events for the Consul agent.
EventResponse	listEvents(String name)	Lists events for the Consul agent.
EventResponse	listEvents(String name, QueryOptions queryOptions)	Lists events for the Consul agent.
void	listEvents(String name, QueryOptions queryOptions, EventResponseCallback callback)	Asynchronously lists events for the Consul agent.
void	listEvents(EventResponseCallback callback)	Asynchronously lists events for the Consul agent.
EventResponse	listEvents(QueryOptions queryOptions)	Lists events for the Consul agent.
void	listEvents(QueryOptions queryOptions, EventResponseCallback callback)	Asynchronously lists events for the Consul agent.

Methods inherited from class java.lang.Object

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

Field Details

http

protected final Http http

Method Details

fireEvent

public Event fireEvent(String name,
 EventOptions eventOptions,
 String payload)

Fires a Consul event.

PUT /v1/event/fire/{name}

Parameters:

name - The name of the event.

eventOptions - The event specific options to use.

payload - Optional string payload.

Returns:

The newly created Event.

fireEvent

public Event fireEvent(String name)

Fires a Consul event.

PUT /v1/event/fire/{name}

Parameters:

name - The name of the event.

Returns:

The newly created Event.

fireEvent

public Event fireEvent(String name,
 EventOptions eventOptions)

Fires a Consul event.

PUT /v1/event/fire/{name}

Parameters:

name - The name of the event.

eventOptions - The event specific options to use.

Returns:

The newly created Event.

fireEvent

public Event fireEvent(String name,
 String payload)

Fires a Consul event.

PUT /v1/event/fire/{name}

Parameters:

name - The name of the event.

payload - Optional string payload.

Returns:

The newly created Event.

listEvents

public EventResponse listEvents(String name,
 QueryOptions queryOptions)

Lists events for the Consul agent.

GET /v1/event/list?name={name}

Parameters:

name - Event name to filter.

queryOptions - The query options to use.

Returns:

A ConsulResponse object containing a list of Event objects.

listEvents

public EventResponse listEvents(String name)

Lists events for the Consul agent.

GET /v1/event/list?name={name}

Parameters:

name - Event name to filter.

Returns:

A ConsulResponse object containing a list of Event objects.

listEvents

public EventResponse listEvents(QueryOptions queryOptions)

Lists events for the Consul agent.

GET /v1/event/list

Parameters:

queryOptions - The query options to use.

Returns:

A ConsulResponse object containing a list of Event objects.

listEvents

public EventResponse listEvents()

Lists events for the Consul agent.

GET /v1/event/list

Returns:

A ConsulResponse object containing a list of Event objects.

listEvents

public void listEvents(String name,
 QueryOptions queryOptions,
 EventResponseCallback callback)

Asynchronously lists events for the Consul agent.

GET /v1/event/list?name={name}

Parameters:

name - Event name to filter.

queryOptions - The query options to use.

callback - The callback to asynchronously process the result.

listEvents

public void listEvents(QueryOptions queryOptions,
 EventResponseCallback callback)

Asynchronously lists events for the Consul agent.

GET /v1/event/list

Parameters:

queryOptions - The query options to use.

callback - The callback to asynchronously process the result.

listEvents

public void listEvents(EventResponseCallback callback)

Asynchronously lists events for the Consul agent.

GET /v1/event/list

Parameters:

callback - The callback to asynchronously process the result.

getConfig

public ClientConfig getConfig()

getEventHandler

public ClientEventHandler getEventHandler()