services.IconService 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

/*
Copyright (c) 2015 Red Hat, Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

  http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package services;

import annotations.Area;
import mixins.Follow;
import org.ovirt.api.metamodel.annotations.Out;
import org.ovirt.api.metamodel.annotations.Service;
import types.Icon;

/**
 * A service to manage an icon (read-only).
 *
 * @author Aleksei Slaikovskii 
 * @date 12 Dec 2016
 * @status added
 */
@Service
@Area("Virtualization")
public interface IconService {
    /**
     * Get an icon.
     *
     * [source]
     * ----
     * GET /ovirt-engine/api/icons/123
     * ----
     *
     * You will get a XML response like this one:
     *
     * [source,xml]
     * ----
     * 
     *   Some binary data here
     *   image/png
     * 
     * ----
     *
     * @author Aleksei Slaikovskii 
     * @date 12 Dec 2016
     * @status added
     */
    interface Get extends Follow {
        /**
         * Retrieved icon.
         *
         * @author Aleksei Slaikovskii 
         * @date 12 Dec 2016
         * @status added
         */
        @Out Icon icon();
    }
}