types.RegistrationDomainMapping 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) 2017 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 types;

import org.ovirt.api.metamodel.annotations.Link;
import org.ovirt.api.metamodel.annotations.Type;

/**
 * This type describes how to map the users' domain as part of the object registration. An object can be
 * a virtual machine, template, etc.
 * NOTE: This is based on the assumption that user names will be the same, and that only
 * the domain name will be changed.
 *
 * An example of an XML representation using this mapping:
 *
 * [source,xml]
 * ----
 * 
 *   
 *     
 *       
 *         
 *           redhat
 *         
 *         
 *           internal
 *         
 *       
 *     
 *   
 * 
 * ----
 *
 * @author Maor Lipchuk 
 * @author Byron Gravenorst 
 * @date 20 Oct 2017
 * @status updated_by_docs
 * @since 4.2
 */
@Type
interface RegistrationDomainMapping {
    /**
     * Reference to the original domain. It can be specified
     * using `name`.
     *
     * @author Maor Lipchuk 
     * @author Byron Gravenorst 
     * @date 20 Oct 2017
     * @status updated_by_docs
     * @since 4.2
     */
    @Link Domain from();

    /**
     * Reference to the destination domain.
     *
     * @author Maor Lipchuk 
     * @author Byron Gravenorst 
     * @date 20 Oct 2017
     * @status updated_by_docs
     * @since 4.2
     */
    @Link Domain to();
}