services.externalhostproviders.ExternalComputeResourceService 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.externalhostproviders;

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

/**
 * Manages a single external compute resource.
 *
 * Compute resource is a term of host external provider. The external provider also needs to know to where the
 * provisioned host needs to register. The login details of the engine are saved as a compute resource  in the external
 * provider side.
 *
 * @author Yaniv Bronhaim 
 * @date 24 Apr 2017
 * @status added
 */
@Service
@Area("Infrastructure")
public interface ExternalComputeResourceService {
    /**
     * Retrieves external compute resource details.
     *
     * For example, to get the details of compute resource `234` of provider `123`, send a request like this:
     *
     * ....
     * GET /ovirt-engine/api/externalhostproviders/123/computeresources/234
     * ....
     *
     * It will return a response like this:
     *
     * [source,xml]
     * ----
     * 
     *   hostname
     *   oVirt
     *   https://hostname/api
     *   admin@internal
     *   
     * 
     * ----
     *
     * @author Yaniv Bronhaim 
     * @date 24 Apr 2017
     * @status added
     */
    interface Get extends Follow {
        /**
         * External compute resource information
         *
         * @author Yaniv Bronhaim 
         * @date 24 Apr 2017
         * @status added
         */
        @Out ExternalComputeResource resource();
    }
}