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

Show more of this group Show more artifacts with this name
Show all versions of sdk Show documentation
There is a newer version: 4.5.1
/*
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.DiskProfileBuilder;
import org.ovirt.engine.sdk4.types.DiskProfile;

public interface DiskProfilesService extends Service {
    /**
     * Add a new disk profile to the system.
     */
    public interface AddRequest extends Request {
        AddRequest profile(DiskProfile profile);
        AddRequest profile(DiskProfileBuilder profile);
    }
    
    /**
     * Add a new disk profile to the system.
     */
    public interface AddResponse extends Response {
        DiskProfile profile();
    }
    
    /**
     * Add a new disk profile to the system.
     */
    AddRequest add();
    
    /**
     * Returns the list of disk profiles of the system.
     * 
     * The order of the returned list of disk profiles 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 profiles to return. If not specified all the profiles are returned.
         */
        ListRequest max(Integer max);
        /**
         * Sets the maximum number of profiles to return. If not specified all the profiles are returned.
         */
        ListRequest max(Long max);
        /**
         * Sets the maximum number of profiles to return. If not specified all the profiles are returned.
         */
        ListRequest max(BigInteger max);
    }
    
    /**
     * Returns the list of disk profiles of the system.
     * 
     * The order of the returned list of disk profiles isn't guaranteed.
     */
    public interface ListResponse extends Response {
        List profile();
    }
    
    /**
     * Returns the list of disk profiles of the system.
     * 
     * The order of the returned list of disk profiles isn't guaranteed.
     */
    ListRequest list();
    
    DiskProfileService diskProfileService(String id);
    /**
     * Service locator method, returns individual service on which the URI is dispatched.
     */
    Service service(String path);
}