types.Snapshot 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 types;

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

import java.util.Date;

/**
 * Represents a snapshot object.
 *
 * Example XML representation:
 *
 * [source,xml]
 * ----
 * 
 *   
 *     
 *   
 *   
 *   Virtual Machine 1 - Snapshot A
 *   active
 *   2010-08-16T14:24:29
 *   false
 * 
 * ----
 *
 * @author Daniel Erez 
 * @author Tahlia Richardson 
 * @date 28 Nov 2016
 * @status updated_by_docs
 */
@Type
public interface Snapshot extends Vm {

    /**
     * The date when this snapshot has been created.
     *
     * @author Tomas Jelinek 
     * @date 24 Apr 2017
     * @status added
     */
    Date date();

    /**
     * Status of the snapshot.
     *
     * @author Tomas Jelinek 
     * @date 24 Apr 2017
     * @status added
     */
    SnapshotStatus snapshotStatus();

    /**
     * Indicates if the content of the memory of the virtual machine is included in the snapshot.
     *
     * When a snapshot is created the default value is `true`.
     *
     * @author Juan Hernandez 
     * @date 9 Mar 2017
     * @status added
     */
    Boolean persistMemorystate();

    /**
     * Type of the snapshot.
     *
     * @author Tomas Jelinek 
     * @date 24 Apr 2017
     * @status added
     */
    SnapshotType snapshotType(); //revisit. Had to be done because of VmBase.type changed to VmType

    /**
     * The virtual machine this snapshot has been taken for.
     *
     * @author Tomas Jelinek 
     * @date 24 Apr 2017
     * @status added
     */
    @Link Vm vm();

    /**
     * List of disks linked to the snapshot.
     *
     * @author Ondra Machacek 
     * @author Steve Goodman 
     * @date 12 Sep 2018
     * @status updated_by_docs
     */
    @Link Disk[] disks();
}