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

/*
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 java.math.BigInteger;
import java.util.List;
import org.ovirt.engine.sdk4.Request;
import org.ovirt.engine.sdk4.Response;
import org.ovirt.engine.sdk4.Service;
import org.ovirt.engine.sdk4.builders.HostBuilder;
import org.ovirt.engine.sdk4.types.Host;

/**
 * This service manages a collection of all hosts assigned to an affinity group.
 */
public interface AffinityGroupHostsService extends Service {
    /**
     * Adds a host to the affinity group.
     * 
     * For example, to add the host `789` to the affinity group `456` of cluster `123`, send a request like
     * this:
     * 
     * ....
     * POST /ovirt-engine/api/clusters/123/affinitygroups/456/hosts
     * ....
     * 
     * With the following body:
     * 
     * [source,xml]
     * ----
     * 
     * ----
     */
    public interface AddRequest extends Request {
        AddRequest host(Host host);
        /**
         * The host to be added to the affinity group.
         */
        AddRequest host(HostBuilder host);
    }
    
    /**
     * Adds a host to the affinity group.
     * 
     * For example, to add the host `789` to the affinity group `456` of cluster `123`, send a request like
     * this:
     * 
     * ....
     * POST /ovirt-engine/api/clusters/123/affinitygroups/456/hosts
     * ....
     * 
     * With the following body:
     * 
     * [source,xml]
     * ----
     * 
     * ----
     */
    public interface AddResponse extends Response {
        /**
         * The host to be added to the affinity group.
         */
        Host host();
    }
    
    /**
     * Adds a host to the affinity group.
     * 
     * For example, to add the host `789` to the affinity group `456` of cluster `123`, send a request like
     * this:
     * 
     * ....
     * POST /ovirt-engine/api/clusters/123/affinitygroups/456/hosts
     * ....
     * 
     * With the following body:
     * 
     * [source,xml]
     * ----
     * 
     * ----
     */
    AddRequest add();
    
    /**
     * List all hosts assigned to this affinity group.
     * 
     * The order of the returned hosts isn't guaranteed.
     */
    public interface ListRequest 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.
         */
        ListRequest follow(String follow);
        /**
         * Sets the maximum number of hosts to return. If not specified, all the hosts are
         * returned.
         */
        ListRequest max(Integer max);
        /**
         * Sets the maximum number of hosts to return. If not specified, all the hosts are
         * returned.
         */
        ListRequest max(Long max);
        /**
         * Sets the maximum number of hosts to return. If not specified, all the hosts are
         * returned.
         */
        ListRequest max(BigInteger max);
    }
    
    /**
     * List all hosts assigned to this affinity group.
     * 
     * The order of the returned hosts isn't guaranteed.
     */
    public interface ListResponse extends Response {
        /**
         * The list of hosts assigned to this affinity group.
         */
        List hosts();
    }
    
    /**
     * List all hosts assigned to this affinity group.
     * 
     * The order of the returned hosts isn't guaranteed.
     */
    ListRequest list();
    
    /**
     * Access the service that manages the host assignment to this affinity group.
     */
    AffinityGroupHostService hostService(String id);
    /**
     * Service locator method, returns individual service on which the URI is dispatched.
     */
    Service service(String path);
}