services.VmBackupDisksService 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) 2019 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;

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

@Service
@Area("Storage")
public interface VmBackupDisksService {
    /**
     * Returns the list of disks in backup.
     *
     * @author Daniel Erez 
     * @date 8 Jan 2019
     * @status added
     * @since 4.3
     */
    interface List extends Follow {
        /**
         * The list of retrieved disks.
         *
         * @author Daniel Erez 
         * @date 8 Jan 2019
         * @status added
         * @since 4.3
         */
        @Out Disk[] disks();

        /**
         * Sets the maximum number of disks to return. If not specified, all the disks are returned.
         */
        @In Integer max();
    }

    /**
     * A reference to the service that manages a specific disk.
     *
     * @author Daniel Erez 
     * @date 8 Jan 2019
     * @status added
     * @since 4.3
     */
    @Service VmBackupDiskService disk(String id);
}