org.openstack4j.api.telemetry

Interface EventService

All Superinterfaces:

RestService

All Known Implementing Classes:

EventServiceImpl

public interface EventService
extends RestService

OpenStack (Ceilometer) Event based Operations

Author:

Miroslav Lacina

Method Summary

Modifier and Type	Method and Description
Event	get(String messageId) Return a single Event with the given message id
List<? extends Event>	list(EventCriteria eventCriteria) Return all Events matching the query filters
List<? extends Event>	list(EventCriteria eventCriteria, int limit) Return all Events matching the query filters
List<String>	listEventTypes() Get all event types
List<? extends TraitDescription>	listTraitDescriptions(String eventType) Return all trait names for an event type
List<? extends Trait>	listTraits(String eventType, String traitName) Return all instances of a trait for an event type

Method Detail

list

List<? extends Event> list(EventCriteria eventCriteria)

Return all Events matching the query filters

Parameters:

eventCriteria - the event query criteria for filtering results

Returns:

list of Events

list

List<? extends Event> list(EventCriteria eventCriteria,
                           int limit)

Return all Events matching the query filters

Parameters:

eventCriteria - the event query criteria for filtering results

limit - maximum number of samples to be returned

Returns:

list of Events

get

Event get(String messageId)

Return a single Event with the given message id

Parameters:

messageId - message ID of the Event to be returned

Returns:

single Event

listEventTypes

List<String> listEventTypes()

Get all event types

Returns:

list of event types

listTraitDescriptions

List<? extends TraitDescription> listTraitDescriptions(String eventType)

Return all trait names for an event type

Parameters:

eventType - event type to filter traits by

Returns:

list of TraitDescriptions

listTraits

List<? extends Trait> listTraits(String eventType,
                                 String traitName)

Return all instances of a trait for an event type

Parameters:

eventType - event type to filter traits by

traitName - trait to return values for

Returns:

list of Traits