// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements.  See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership.  The ASF licenses this file
// to you 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 org.apache.cloudstack.engine.subsystem.api.storage;

import java.util.List;

import org.apache.cloudstack.framework.config.ConfigKey;

import com.cloud.storage.Snapshot;
import com.cloud.utils.exception.CloudRuntimeException;

public interface SnapshotInfo extends DataObject, Snapshot {
    ConfigKey<Boolean> BackupSnapshotAfterTakingSnapshot = new ConfigKey<>(Boolean.class, "snapshot.backup.to.secondary",  "Snapshots", "true", "Indicates whether to always"
            + " backup primary storage snapshot to secondary storage. Keeping snapshots only on Primary storage is applicable for KVM + Ceph only.", false, ConfigKey.Scope.Global,
            null);

    SnapshotInfo getParent();

    String getPath();

    DataStore getImageStore();

    void setImageStore(DataStore imageStore);

    SnapshotInfo getChild();

    List<SnapshotInfo> getChildren();

    VolumeInfo getBaseVolume();

    void addPayload(Object data);

    Object getPayload();

    void setFullBackup(Boolean fullBackup);

    Boolean getFullBackup();

    Long getDataCenterId();

    ObjectInDataStoreStateMachine.State getStatus();

    boolean isRevertable();

    long getPhysicalSize();

    void markBackedUp() throws CloudRuntimeException;

    String getCheckpointPath();

    void setCheckpointPath(String checkpointPath);

    void setKvmIncrementalSnapshot(boolean isKvmIncrementalSnapshot);

    boolean isKvmIncrementalSnapshot();

    Snapshot getSnapshotVO();

    long getAccountId();
}
