org.ovirt.engine.sdk4.services.ExternalHostGroupService Maven / Gradle / Ivy

Go to download
/*
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 org.ovirt.engine.sdk4.services;

import java.io.IOException;
import org.ovirt.engine.sdk4.Request;
import org.ovirt.engine.sdk4.Response;
import org.ovirt.engine.sdk4.Service;
import org.ovirt.engine.sdk4.types.ExternalHostGroup;

/**
 * This service manages a single host group information.
 * 
 * Host group is a term of host provider - the host group includes provision details that are applied to new discovered
 * host. Information such as subnet, operating system, domain, etc.
 */
public interface ExternalHostGroupService extends Service {
    /**
     * Get host group information.
     * 
     * For example, to get the details of hostgroup `234` of provider `123`, send a request like this:
     * 
     * ....
     * GET /ovirt-engine/api/externalhostproviders/123/hostgroups/234
     * ....
     * 
     * It will return a response like this:
     * 
     * [source,xml]
     * ----
     * 
     *   rhel7
     *   x86_64
     *   s.com
     *   RedHat 7.3
     *   sat0
     *   
     * 
     * ----
     */
    public interface GetRequest extends Request {
        /**
         * Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part
         * of the current request. See <> for details.
         */
        GetRequest follow(String follow);
    }
    
    /**
     * Get host group information.
     * 
     * For example, to get the details of hostgroup `234` of provider `123`, send a request like this:
     * 
     * ....
     * GET /ovirt-engine/api/externalhostproviders/123/hostgroups/234
     * ....
     * 
     * It will return a response like this:
     * 
     * [source,xml]
     * ----
     * 
     *   rhel7
     *   x86_64
     *   s.com
     *   RedHat 7.3
     *   sat0
     *   
     * 
     * ----
     */
    public interface GetResponse extends Response {
        /**
         * Host group information.
         */
        ExternalHostGroup group();
    }
    
    /**
     * Get host group information.
     * 
     * For example, to get the details of hostgroup `234` of provider `123`, send a request like this:
     * 
     * ....
     * GET /ovirt-engine/api/externalhostproviders/123/hostgroups/234
     * ....
     * 
     * It will return a response like this:
     * 
     * [source,xml]
     * ----
     * 
     *   rhel7
     *   x86_64
     *   s.com
     *   RedHat 7.3
     *   sat0
     *   
     * 
     * ----
     */
    GetRequest get();
    
    /**
     * Service locator method, returns individual service on which the URI is dispatched.
     */
    Service service(String path);
}