services.openstack.OpenstackVolumeProvidersService 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.openstack;

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.OpenStackVolumeProvider;

import static org.ovirt.api.metamodel.language.ApiLanguage.COLLECTION;
import static org.ovirt.api.metamodel.language.ApiLanguage.mandatory;
import static org.ovirt.api.metamodel.language.ApiLanguage.optional;
import static org.ovirt.api.metamodel.language.ApiLanguage.or;

@Service
@Area("Storage")
public interface OpenstackVolumeProvidersService {
    /**
     * Adds a new volume provider.
     *
     * For example:
     *
     * [source]
     * ----
     * POST /ovirt-engine/api/openstackvolumeproviders
     * ----
     *
     * With a request body like this:
     *
     * [source,xml]
     * ----
     * 
     *   mycinder
     *   https://mycinder.example.com:8776
     *   
     *     mydc
     *   
     *   true
     *   admin
     *   mypassword
     *   mytenant
     * 
     * ----
     *
     * @author Daniel Erez 
     * @date 14 Sep 2016
     * @status added
     */
    interface Add {
        default void inputDetail() {
            mandatory(provider().name());
            optional(provider().authenticationUrl());
            optional(provider().description());
            optional(provider().password());
            optional(provider().requiresAuthentication());
            optional(provider().tenantName());
            optional(provider().url());
            optional(provider().username());
            or(optional(provider().dataCenter().id()), optional(provider().dataCenter().name()));
            optional(provider().properties()[COLLECTION].name());
            optional(provider().properties()[COLLECTION].value());
        }
        @In @Out OpenStackVolumeProvider provider();
    }

    /**
     * Retrieves the list of volume providers.
     *
     * The order of the returned list of volume providers isn't guaranteed.
     *
     * @author Daniel Erez 
     * @date 14 Sep 2016
     * @status added
     */
    interface List extends Follow {
        @Out OpenStackVolumeProvider[] providers();

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

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

    @Service OpenstackVolumeProviderService provider(String id);
}