001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */
018package org.apache.hadoop.hbase.backup.impl;
019
020import java.util.List;
021import org.apache.hadoop.hbase.TableName;
022import org.apache.hadoop.hbase.backup.BackupInfo;
023import org.apache.hadoop.hbase.backup.impl.BackupManifest.BackupImage;
024import org.apache.yetus.audience.InterfaceAudience;
025
026/**
027 * A unified abstraction over backup metadata used during Point-In-Time Restore (PITR).
028 * <p>
029 * This interface allows the PITR algorithm to operate uniformly over different types of backup
030 * metadata sources, such as {@link BackupInfo} (system table) and {@link BackupImage} (custom
031 * backup location), without knowing their specific implementations.
032 */
033@InterfaceAudience.Private
034public interface PitrBackupMetadata {
035
036  /** Returns List of table names included in the backup */
037  List<TableName> getTableNames();
038
039  /** Returns Start timestamp of the backup */
040  long getStartTs();
041
042  /** Returns Completion timestamp of the backup */
043  long getCompleteTs();
044
045  /** Returns Unique identifier for the backup */
046  String getBackupId();
047
048  /** Returns Root directory where the backup is stored */
049  String getRootDir();
050}