Package org.ovirt.engine.sdk4.services

Interface EventsService

All Superinterfaces:

Service

All Known Implementing Classes:

EventsServiceImpl

public interface EventsService
extends Service

A service to manage events in the system.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	EventsService.AddRequest	Adds an external event to the internal audit log.
static interface	EventsService.AddResponse	Adds an external event to the internal audit log.
static interface	EventsService.ListRequest	Get list of events.
static interface	EventsService.ListResponse	Get list of events.
static interface	EventsService.UndeleteRequest
static interface	EventsService.UndeleteResponse

Method Summary

Modifier and Type	Method	Description
EventsService.AddRequest	add()	Adds an external event to the internal audit log.
EventService	eventService(String id)	Reference to the service that manages a specific event.
EventsService.ListRequest	list()	Get list of events.
Service	service(String path)	Service locator method, returns individual service on which the URI is dispatched.
EventsService.UndeleteRequest	undelete()

Method Detail

add

EventsService.AddRequest add()

Adds an external event to the internal audit log. This is intended for integration with external systems that detect or produce events relevant for the administrator of the system. For example, an external monitoring tool may be able to detect that a file system is full inside the guest operating system of a virtual machine. This event can be added to the internal audit log sending a request like this: [source] ---- POST /ovirt-engine/api/events File system /home is full alert mymonitor 1467879754 ---- Events can also be linked to specific objects. For example, the above event could be linked to the specific virtual machine where it happened, using the `vm` link: [source] ---- POST /ovirt-engine/api/events File system /home is full alert mymonitor 1467879754 ---- NOTE: When using links, like the `vm` in the previous example, only the `id` attribute is accepted. The `name` attribute, if provided, is simply ignored.

list

EventsService.ListRequest list()

Get list of events. [source] ---- GET /ovirt-engine/api/events ---- To the above request we get following response: [source,xml] ---- User admin@internal-authz logged out. 31 1e892ea9 -1 30 oVirt normal 2016-09-14T12:14:34.541+02:00 User admin logged in. 30 1fbd81f4 -1 30 oVirt normal 2016-09-14T11:54:35.229+02:00 ---- The following events occur: * id="1" - The API logs in the admin user account. * id="2" - The API logs out of the admin user account. The order of the returned list of events is always garanteed. If the `sortby` clause is included in the `search` parameter, then the events will be ordered according to that clause. If the `sortby` clause isn't included, then the events will be sorted by the numeric value of the `id` attribute, starting with the highest value. This, combined with the `max` parameter, simplifies obtaining the most recent event: .... GET /ovirt-engine/api/events?max=1 ....

undelete

EventsService.UndeleteRequest undelete()

eventService

EventService eventService(String id)

Reference to the service that manages a specific event.

service

Service service(String path)

Service locator method, returns individual service on which the URI is dispatched.