services.EventSubscriptionService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of model Show documentation

Model management tools for the oVirt Engine API.

There is a newer version: 4.6.0

package services;

import org.ovirt.api.metamodel.annotations.In;
import org.ovirt.api.metamodel.annotations.Out;
import org.ovirt.api.metamodel.annotations.Service;

import annotations.Area;
import types.EventSubscription;

/**
 * A service to manage a specific event-subscription in the system.
 *
 * @author Ori Liel 
 * @date 17 June 2019
 * @status added
 * @since 4.4.0
 */
@Service
@Area("Infrastructure")
public interface EventSubscriptionService {

    /**
     * Gets the information about the event-subscription.
     *
     * For example to retrieve the information about the subscription of user '123' to
     * the event 'vm_console_detected':
     *
     * ....
     * GET /ovirt-engine/api/users/123/vm_console_detected
     * ....
     *
     * [source,xml]
     * ----
     * 
     *   vm_console_detected
     *   smtp
     *   
     *   [email protected]
     * 
     * ----
     *
     * @author Ori Liel 
     * @date 17 June 2019
     * @status added
     * @since 4.4.0
     */
    interface Get {
        /**
         * The event-subscription.
         *
         * @author Ori Liel 
         * @date 17 June 2019
         * @status added
         * @since 4.4.0
         */
        @Out
        EventSubscription eventSubscription();
    }

    /**
     * Removes the event-subscription from the system.
     *
     * For example to remove user 123's subscription to `vm_console_detected` event:
     *
     * ....
     * DELETE /ovirt-engine/api/users/123/vm_console_detected
     * ....
     *
     * @author Ori Liel 
     * @date 17 June 2019
     * @status added
     * @since 4.4.0
     */
    interface Remove {
        /**
         * Indicates if the remove should be performed asynchronously.
         *
         * @author Ori Liel 
         * @date 17 June 2019
         * @status added
         * @since 4.4.0
         */
        @In Boolean async();
    }
}