services.aaa.UserOptionService 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.aaa;

import static org.ovirt.api.metamodel.language.ApiLanguage.mandatory;

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

import annotations.Area;
import types.UserOption;

@Service
@Area("Infrastructure")
public interface UserOptionService {
    /**
     * Returns a user profile property of type JSON.
     *
     * Example request(for user with identifier `123` and option with identifier `456`):
     *
     * [source]
     * ----
     * GET /ovirt-engine/api/users/123/options/456
     * ----
     *
     * The result will be the following XML document:
     *
     * [source,xml]
     * ----
     *   
     *     SomeName
     *     ["any", "JSON"]
     *     
     *   
     * ----
     * @author Radoslaw Szwajkowski 
     * @date 11 Jan 2021
     * @status added
     * @since 4.4.5
     */
    interface Get {
        @Out UserOption option();
    }

    /**
     * Deletes an existing property of type JSON.
     *
     * Example request(for user with identifier `123` and option with identifier `456`):
     *
     * [source]
     * ----
     * DELETE /ovirt-engine/api/users/123/options/456
     * ----
     * @author Radoslaw Szwajkowski 
     * @date 11 Jan 2021
     * @status added
     * @since 4.4.5
     */
    interface Remove {
    }
}