services.gluster.GlusterVolumesService 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) 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 services.gluster;

import annotations.Area;
import org.ovirt.api.metamodel.annotations.In;
import org.ovirt.api.metamodel.annotations.Out;
import org.ovirt.api.metamodel.annotations.Service;
import types.GlusterVolume;

@Service
@Area("Gluster")
public interface GlusterVolumesService {
    /**
     * Creates a new Gluster volume and adds it to the database. The volume is created based on properties of the
     * `volume` parameter. The properties `name`, `volumeType` and `bricks` are required.
     */
    interface Add {
        /**
         * The Gluster volume definition from which to create the volume is passed as input and the newly created
         * volume is returned.
         */
        @In @Out GlusterVolume volume();
    }

    interface List {
        @Out GlusterVolume[] volumes();

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

        /**
         * A query string used to restrict the returned volumes.
         */
        @In String search();

        /**
         * Indicates if the search performed using the `search` parameter should be performed taking case into
         * account. The default value is `true`, which means that case is taken into account. If you want to search
         * ignoring case set it to `false`.
         */
        @In Boolean caseSensitive();
    }

    @Service GlusterVolumeService volume(String id);
}