services.openstack.OpenstackNetworkProviderService 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.InputDetail;
import org.ovirt.api.metamodel.annotations.Out;
import org.ovirt.api.metamodel.annotations.Service;
import services.ExternalProviderService;
import types.OpenStackNetworkProvider;

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

/**
 * This service manages the OpenStack network provider.
 *
 * @author Mor Kalfon 
 * @author Byron Gravenorst 
 * @date 18 Sep 2017
 * @status updated_by_docs
 */
@Service
@Area("Network")
public interface OpenstackNetworkProviderService extends ExternalProviderService {
    /**
     * Returns the representation of the object managed by this service.
     *
     * For example, to get the OpenStack network provider with identifier `1234`, send a request like this:
     *
     * [source]
     * ----
     * GET /ovirt-engine/api/openstacknetworkproviders/1234
     * ----
     *
     * @author Mor Kalfon 
     * @date 14 Dec 2016
     * @status added
     */
    interface Get extends Follow {
        @Out OpenStackNetworkProvider provider();
    }

    /**
     * Updates the provider.
     *
     * For example, to update `provider_name`, `requires_authentication`, `url`, `tenant_name` and `type` properties,
     * for the OpenStack network provider with identifier `1234`, send a request like this:
     *
     * [source]
     * ----
     * PUT /ovirt-engine/api/openstacknetworkproviders/1234
     * ----
     *
     * With a request body like this:
     *
     * [source,xml]
     * ----
     * 
     *   ovn-network-provider
     *   false
     *   http://some_server_url.domain.com:9696
     *   oVirt
     *   external
     * 
     * ----
     *
     * @author Mor Kalfon 
     * @date 14 Dec 2016
     * @status added
     */
    interface Update {
        @InputDetail
        default void inputDetail() {
            optional(provider().authenticationUrl());
            optional(provider().description());
            optional(provider().name());
            optional(provider().password());
            optional(provider().requiresAuthentication());
            optional(provider().tenantName());
            optional(provider().userDomainName());
            optional(provider().projectName());
            optional(provider().projectDomainName());
            optional(provider().username());
            optional(provider().properties()[COLLECTION].name());
            optional(provider().properties()[COLLECTION].value());
            optional(provider().autoSync());
            optional(provider().unmanaged());
        }
        /**
         * The provider to update.
         *
         * @author Mor Kalfon 
         * @date 14 Dec 2016
         * @status added
         */
        @In @Out OpenStackNetworkProvider provider();

        /**
         * Indicates if the update should be performed asynchronously.
         */
        @In Boolean async();
    }

    /**
     * Removes the provider.
     *
     * For example, to remove the OpenStack network provider with identifier `1234`, send a request like this:
     *
     * [source]
     * ----
     * DELETE /ovirt-engine/api/openstacknetworkproviders/1234
     * ----
     *
     * @author Mor Kalfon 
     * @date 14 Dec 2016
     * @status added
     */
    interface Remove {
        /**
         * Indicates if the remove should be performed asynchronously.
         *
         * @author Mor Kalfon 
         * @date 14 Dec 2016
         * @status added
         */
        @In Boolean async();
    }

    /**
     * Reference to OpenStack networks service.
     *
     * @author Mor Kalfon 
     * @date 12 Dec 2016
     * @status added
     */
    @Service OpenstackNetworksService networks();
}