org.ovirt.engine.sdk4.services.VmBackupService 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.Backup;

/**
 * A service managing a backup of a virtual machines.
 */
public interface VmBackupService extends Service {
    /**
     * Finalize the virtual machine backup entity.
     * 
     * End backup, unlock resources, and perform cleanups.
     */
    public interface FinalizeRequest extends Request {
    }
    
    /**
     * Finalize the virtual machine backup entity.
     * 
     * End backup, unlock resources, and perform cleanups.
     */
    public interface FinalizeResponse extends Response {
    }
    
    /**
     * Finalize the virtual machine backup entity.
     * 
     * End backup, unlock resources, and perform cleanups.
     */
    FinalizeRequest finalize_();
    
    /**
     * Returns information about the virtual machine backup.
     */
    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);
    }
    
    /**
     * Returns information about the virtual machine backup.
     */
    public interface GetResponse extends Response {
        /**
         * The information about the virtual machine backup entities.
         * 
         * [source,xml]
         * ----
         * 
         *   
         *     previous-checkpoint-uuid
         *     
         *       
         *       ...
         *       ...
         *     
         *     initializing
         *     
         *  
         * 
         * ----
         */
        Backup backup();
    }
    
    /**
     * Returns information about the virtual machine backup.
     */
    GetRequest get();
    
    /**
     * A reference to the service that lists the disks in backup.
     */
    VmBackupDisksService disksService();
    /**
     * Service locator method, returns individual service on which the URI is dispatched.
     */
    Service service(String path);
}