Package org.ovirt.engine.sdk4.services

Interface EventSubscriptionsService

All Superinterfaces:

Service

All Known Implementing Classes:

EventSubscriptionsServiceImpl

public interface EventSubscriptionsService
extends Service

Represents a service to manage collection of event-subscription of a user.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	EventSubscriptionsService.AddRequest	Add a new event-subscription to the system.
static interface	EventSubscriptionsService.AddResponse	Add a new event-subscription to the system.
static interface	EventSubscriptionsService.ListRequest	List the event-subscriptions for the provided user.
static interface	EventSubscriptionsService.ListResponse	List the event-subscriptions for the provided user.

Method Summary

Modifier and Type	Method	Description
EventSubscriptionsService.AddRequest	add()	Add a new event-subscription to the system.
EventSubscriptionService	eventSubscriptionService(String id)	Reference to the service that manages a specific event-subscription.
EventSubscriptionsService.ListRequest	list()	List the event-subscriptions for the provided user.
Service	service(String path)	Service locator method, returns individual service on which the URI is dispatched.

Method Detail

add

EventSubscriptionsService.AddRequest add()

Add a new event-subscription to the system. An event-subscription is always added in the context of a user. For example, to add new event-subscription for `host_high_cpu_use` for user `123`, and have the notification sent to the e-mail address: `[email protected]`, send a request like this: .... POST /ovirt-engine/api/users/123/eventsubscriptions .... With a request body like this: [source,xml] ---- host_high_cpu_use

[email protected]

---- The event name will become the ID of the new event-subscription entity: GET .../api/users/123/eventsubscriptions/host_high_cpu_use Note that no user id is provided in the request body. This is because the user-id (in this case 123) is already known to the API from the context. Note also that event-subscription entity contains notification-method field, but it is not provided either in the request body. This is because currently it's always set to SMTP as SNMP notifications are still unsupported by the API layer.

list

EventSubscriptionsService.ListRequest list()

List the event-subscriptions for the provided user. For example to list event-subscriptions for user `123`: .... GET /ovirt-engine/api/users/123/event-subscriptions .... [source,xml] ---- host_install_failed smtp

[email protected]

vm_paused smtp

[email protected]

----

eventSubscriptionService

EventSubscriptionService eventSubscriptionService(String id)

Reference to the service that manages a specific event-subscription.

service

Service service(String path)

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