org.hawkular.client.alert.clients

Interface AlertClient

All Known Implementing Classes:

DefaultAlertClient

public interface AlertClient

Method Summary

Modifier and Type	Method and Description
ClientResponse<Empty>	ackAlert(String alertId, String ackBy, String ackNotes) Set one alert Acknowledged.
ClientResponse<Empty>	ackAlerts(String alertIds, String ackBy, String ackNotes) Set one or more alerts Acknowledged.
ClientResponse<Empty>	addNoteToAlert(String alertId, String user, String text) Add a note into an existing Alert.
ClientResponse<Empty>	addTag(String alertIds, String tagNames) Add tags to existing Alerts.
ClientResponse<Empty>	deleteAlert(String alertId) Delete an existing Alert.
ClientResponse<Integer>	deleteAlerts(Long startTime, Long endTime, String alertIds, String triggerIds, String statuses, String severities, String tags) Delete alerts with optional filtering.
ClientResponse<Empty>	deleteTags(String alertIds, String tagNames) Remove tags from existing Alerts.
ClientResponse<List<org.hawkular.alerts.api.model.event.Alert>>	findAlerts(Long startTime, Long endTime, String alertIds, String triggerIds, String statuses, String severities, String tags, Boolean thin) Get alerts with optional filtering.
ClientResponse<org.hawkular.alerts.api.model.event.Alert>	getAlert(String alertId, Boolean thin) Get an existing Alert.
ClientResponse<Empty>	resolveAlert(String alertId, String resolvedBy, String resolvedNotes) Set one alert Resolved.
ClientResponse<Empty>	resolveAlerts(String alertIds, String resolvedBy, String resolvedNotes) Set one or more alerts resolved.
ClientResponse<Empty>	sendData(List<org.hawkular.alerts.api.model.data.Data> datums) Send data for alert processing/condition evaluation.

Method Detail

findAlerts

ClientResponse<List<org.hawkular.alerts.api.model.event.Alert>> findAlerts(Long startTime,
                                                                           Long endTime,
                                                                           String alertIds,
                                                                           String triggerIds,
                                                                           String statuses,
                                                                           String severities,
                                                                           String tags,
                                                                           Boolean thin)

Get alerts with optional filtering.

Parameters:

startTime -

endTime -

alertIds -

triggerIds -

statuses -

severities -

tags -

thin -

Returns:

ackAlerts

ClientResponse<Empty> ackAlerts(String alertIds,
                                String ackBy,
                                String ackNotes)

Set one or more alerts Acknowledged.

Parameters:

alertIds -

ackBy -

ackNotes -

Returns:

ackAlert

ClientResponse<Empty> ackAlert(String alertId,
                               String ackBy,
                               String ackNotes)

Set one alert Acknowledged.

Parameters:

alertId -

ackBy -

ackNotes -

Returns:

getAlert

ClientResponse<org.hawkular.alerts.api.model.event.Alert> getAlert(String alertId,
                                                                   Boolean thin)

Get an existing Alert.

Parameters:

alertId -

thin -

Returns:

sendData

ClientResponse<Empty> sendData(List<org.hawkular.alerts.api.model.data.Data> datums)

Send data for alert processing/condition evaluation.

Parameters:

datums -

Returns:

deleteAlerts

ClientResponse<Integer> deleteAlerts(Long startTime,
                                     Long endTime,
                                     String alertIds,
                                     String triggerIds,
                                     String statuses,
                                     String severities,
                                     String tags)

Delete alerts with optional filtering.

Parameters:

startTime -

endTime -

alertIds -

triggerIds -

statuses -

severities -

tags -

Returns:

addNoteToAlert

ClientResponse<Empty> addNoteToAlert(String alertId,
                                     String user,
                                     String text)

Add a note into an existing Alert.

Parameters:

alertId -

user -

text -

Returns:

resolveAlerts

ClientResponse<Empty> resolveAlerts(String alertIds,
                                    String resolvedBy,
                                    String resolvedNotes)

Set one or more alerts resolved.

Parameters:

alertIds -

resolvedBy -

resolvedNotes -

Returns:

resolveAlert

ClientResponse<Empty> resolveAlert(String alertId,
                                   String resolvedBy,
                                   String resolvedNotes)

Set one alert Resolved.

Parameters:

alertId -

resolvedBy -

resolvedNotes -

Returns:

deleteTags

ClientResponse<Empty> deleteTags(String alertIds,
                                 String tagNames)

Remove tags from existing Alerts.

Parameters:

alertIds -

tagNames -

Returns:

addTag

ClientResponse<Empty> addTag(String alertIds,
                             String tagNames)

Add tags to existing Alerts.

Parameters:

alertIds -

tagNames -

Returns:

deleteAlert

ClientResponse<Empty> deleteAlert(String alertId)

Delete an existing Alert.

Parameters:

alertId -

Returns: