BackupInfo (Hortonworks Data Platform Apache HBase Java API Reference)

java.lang.Object
- org.apache.hadoop.hbase.backup.BackupInfo

All Implemented Interfaces:: Comparable<BackupInfo>

@InterfaceAudience.Private
 @InterfaceStability.Evolving
public class BackupInfo
extends Object
implements Comparable<BackupInfo>

An object to encapsulate the information for each backup request

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class BackupInfo.BackupPhase

static class BackupInfo.BackupState

Nested Classes
Modifier and Type	Class and Description
`static class`	`BackupInfo.BackupPhase`
`static class`	`BackupInfo.BackupState`

Constructor Summary

Constructors
Constructor and Description

BackupInfo()

BackupInfo(String backupId, BackupType type, TableName[] tables, String targetRootDir)

Constructors
Constructor and Description
`BackupInfo()`
`BackupInfo(String backupId, BackupType type, TableName[] tables, String targetRootDir)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addTables(TableName[] tables)`
`int`	`compareTo(BackupInfo o)`
`static BackupInfo`	`fromByteArray(byte[] data)`
`static BackupInfo`	`fromProto(BackupProtos.BackupInfo proto)`
`static BackupInfo`	`fromStream(InputStream stream)`
`String`	`getBackupId()`
`BackupStatus`	`getBackupStatus(TableName table)`
`long`	`getBandwidth()`
`long`	`getEndTs()`
`String`	`getFailedMsg()`
`String`	`getHlogTargetDir()`
`String`	`getHLogTargetDir()`
`List<String>`	`getIncrBackupFileList()`
`HashMap<TableName,HashMap<String,Long>>`	`getIncrTimestampMap()` Get new region server log timestamps after distributed log roll
`String`	`getJobId()`
`BackupInfo.BackupPhase`	`getPhase()`
`int`	`getProgress()` Get current progress
`String`	`getShortDescription()`
`String`	`getSnapshotName(TableName table)`
`List<String>`	`getSnapshotNames()`
`long`	`getStartTs()`
`BackupInfo.BackupState`	`getState()`
`String`	`getStatusAndProgressAsString()`
`TableName`	`getTableBySnapshot(String snapshotName)`
`String`	`getTableListAsString()`
`List<TableName>`	`getTableNames()`
`Set<TableName>`	`getTables()`
`HashMap<TableName,HashMap<String,Long>>`	`getTableSetTimestampMap()`
`String`	`getTargetRootDir()`
`long`	`getTotalBytesCopied()`
`BackupType`	`getType()`
`int`	`getWorkers()`
`void`	`setBackupId(String backupId)`
`void`	`setBackupStatusMap(Map<TableName,BackupStatus> backupStatusMap)`
`void`	`setBandwidth(long bandwidth)`
`void`	`setEndTs(long endTs)`
`void`	`setFailedMsg(String failedMsg)`
`void`	`setHlogTargetDir(String hlogTagetDir)`
`void`	`setIncrBackupFileList(List<String> incrBackupFileList)`
`void`	`setIncrTimestampMap(HashMap<TableName,HashMap<String,Long>> newTableSetTimestampMap)` Set the new region server log timestamps after distributed log roll
`void`	`setJobId(String jobId)`
`void`	`setPhase(BackupInfo.BackupPhase phase)`
`void`	`setProgress(int p)` Set progress (0-100%)
`void`	`setSnapshotName(TableName table, String snapshotName)`
`void`	`setStartTs(long startTs)`
`void`	`setState(BackupInfo.BackupState flag)`
`void`	`setTableSetTimestampMap(HashMap<TableName,HashMap<String,Long>> tableSetTimestampMap)`
`void`	`setTargetRootDir(String targetRootDir)`
`void`	`setTotalBytesCopied(long totalBytesCopied)`
`void`	`setType(BackupType type)`
`void`	`setWorkers(int workers)`
`byte[]`	`toByteArray()`
`BackupProtos.BackupInfo`	`toProtosBackupInfo()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BackupInfo
```
public BackupInfo()
```

BackupInfo

public BackupInfo(String backupId,
                  BackupType type,
                  TableName[] tables,
                  String targetRootDir)

Method Detail

getJobId
```
public String getJobId()
```

setJobId
```
public void setJobId(String jobId)
```

getWorkers
```
public int getWorkers()
```

setWorkers
```
public void setWorkers(int workers)
```

getBandwidth
```
public long getBandwidth()
```

setBandwidth

public void setBandwidth(long bandwidth)

setBackupStatusMap

public void setBackupStatusMap(Map<TableName,BackupStatus> backupStatusMap)

getTableSetTimestampMap

public HashMap<TableName,HashMap<String,Long>> getTableSetTimestampMap()

setTableSetTimestampMap

public void setTableSetTimestampMap(HashMap<TableName,HashMap<String,Long>> tableSetTimestampMap)

getHlogTargetDir
```
public String getHlogTargetDir()
```

setType
```
public void setType(BackupType type)
```

setTargetRootDir

public void setTargetRootDir(String targetRootDir)

setTotalBytesCopied

public void setTotalBytesCopied(long totalBytesCopied)

setProgress
```
public void setProgress(int p)
```
Set progress (0-100%)

Parameters:

msg - progress value

getProgress
```
public int getProgress()
```
Get current progress

getBackupId
```
public String getBackupId()
```

setBackupId

public void setBackupId(String backupId)

getBackupStatus

public BackupStatus getBackupStatus(TableName table)

getFailedMsg
```
public String getFailedMsg()
```

setFailedMsg

public void setFailedMsg(String failedMsg)

getStartTs
```
public long getStartTs()
```

setStartTs
```
public void setStartTs(long startTs)
```

getEndTs
```
public long getEndTs()
```

setEndTs
```
public void setEndTs(long endTs)
```

getTotalBytesCopied
```
public long getTotalBytesCopied()
```

getState

public BackupInfo.BackupState getState()

setState

public void setState(BackupInfo.BackupState flag)

getPhase

public BackupInfo.BackupPhase getPhase()

setPhase

public void setPhase(BackupInfo.BackupPhase phase)

getType
```
public BackupType getType()
```

setSnapshotName

public void setSnapshotName(TableName table,
                            String snapshotName)

getSnapshotName

public String getSnapshotName(TableName table)

getSnapshotNames

public List<String> getSnapshotNames()

getTables
```
public Set<TableName> getTables()
```

getTableNames

public List<TableName> getTableNames()

addTables

public void addTables(TableName[] tables)

getTargetRootDir
```
public String getTargetRootDir()
```

setHlogTargetDir

public void setHlogTargetDir(String hlogTagetDir)

getHLogTargetDir
```
public String getHLogTargetDir()
```

getIncrBackupFileList

public List<String> getIncrBackupFileList()

setIncrBackupFileList

public void setIncrBackupFileList(List<String> incrBackupFileList)

setIncrTimestampMap
```
public void setIncrTimestampMap(HashMap<TableName,HashMap<String,Long>> newTableSetTimestampMap)
```
Set the new region server log timestamps after distributed log roll

Parameters:

newTableSetTimestampMap - table timestamp map

getIncrTimestampMap
```
public HashMap<TableName,HashMap<String,Long>> getIncrTimestampMap()
```
Get new region server log timestamps after distributed log roll

Returns:

new region server log timestamps

getTableBySnapshot

public TableName getTableBySnapshot(String snapshotName)

toProtosBackupInfo

public BackupProtos.BackupInfo toProtosBackupInfo()

toByteArray

public byte[] toByteArray()
                   throws IOException

Throws:: IOException

fromByteArray

public static BackupInfo fromByteArray(byte[] data)
                                throws IOException

Throws:: IOException

fromStream

public static BackupInfo fromStream(InputStream stream)
                             throws IOException

Throws:: IOException

fromProto

public static BackupInfo fromProto(BackupProtos.BackupInfo proto)

getShortDescription
```
public String getShortDescription()
```

getStatusAndProgressAsString

public String getStatusAndProgressAsString()

getTableListAsString
```
public String getTableListAsString()
```

compareTo
```
public int compareTo(BackupInfo o)
```
Specified by:

compareTo in interface Comparable<BackupInfo>

Class BackupInfo

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BackupInfo

BackupInfo

Method Detail

getJobId

setJobId

getWorkers

setWorkers

getBandwidth

setBandwidth

setBackupStatusMap

getTableSetTimestampMap

setTableSetTimestampMap

getHlogTargetDir

setType

setTargetRootDir

setTotalBytesCopied

setProgress

getProgress

getBackupId

setBackupId

getBackupStatus

getFailedMsg

setFailedMsg

getStartTs

setStartTs

getEndTs

setEndTs

getTotalBytesCopied

getState

setState

getPhase

setPhase

getType

setSnapshotName

getSnapshotName

getSnapshotNames

getTables

getTableNames

addTables

getTargetRootDir

setHlogTargetDir

getHLogTargetDir

getIncrBackupFileList

setIncrBackupFileList

setIncrTimestampMap

getIncrTimestampMap

getTableBySnapshot

toProtosBackupInfo

toByteArray

fromByteArray

fromStream

fromProto

getShortDescription

getStatusAndProgressAsString

getTableListAsString

compareTo