org.apache.hadoop.hbase.client

Class SnapshotDescription

java.lang.Object

org.apache.hadoop.hbase.client.SnapshotDescription

@InterfaceAudience.Public
public class SnapshotDescription
extends Object

The POJO equivalent of HBaseProtos.SnapshotDescription

Field Summary

Fields

Modifier and Type	Field and Description
private long	creationTime
private long	maxFileSize
private String	name
private String	owner
private SnapshotType	snapShotType
private TableName	table
private long	ttl
private int	version

Constructor Summary

Constructors

Constructor and Description
SnapshotDescription(String name)
SnapshotDescription(String name, String table) Deprecated. since 2.0.0 and will be removed in 3.0.0. Use the version with the TableName instance instead.
SnapshotDescription(String name, String table, SnapshotType type) Deprecated. since 2.0.0 and will be removed in 3.0.0. Use the version with the TableName instance instead.
SnapshotDescription(String name, String table, SnapshotType type, String owner) Deprecated. since 2.0.0 and will be removed in 3.0.0. Use the version with the TableName instance instead.
SnapshotDescription(String name, String table, SnapshotType type, String owner, long creationTime, int version) Deprecated. since 2.0.0 and will be removed in 3.0.0. Use the version with the TableName instance instead.
SnapshotDescription(String name, TableName table)
SnapshotDescription(String name, TableName table, SnapshotType type)
SnapshotDescription(String snapshotName, TableName tableName, SnapshotType type, Map<String,Object> snapshotProps) SnapshotDescription Parameterized Constructor
SnapshotDescription(String name, TableName table, SnapshotType type, String owner)
SnapshotDescription(String name, TableName table, SnapshotType type, String owner, long creationTime, int version) Deprecated. since 2.3.0 and will be removed in 4.0.0. Use SnapshotDescription(String, TableName, SnapshotType, String, long, int, Map)
SnapshotDescription(String name, TableName table, SnapshotType type, String owner, long creationTime, int version, Map<String,Object> snapshotProps) SnapshotDescription Parameterized Constructor

Method Summary

Modifier and Type	Method and Description
long	getCreationTime()
private long	getLongFromSnapshotProps(Map<String,Object> snapshotProps, String property)
long	getMaxFileSize()
String	getName()
String	getOwner()
String	getTable() Deprecated. since 2.0.0 and will be removed in 3.0.0. Use getTableName() or getTableNameAsString() instead.
TableName	getTableName()
String	getTableNameAsString()
long	getTtl()
SnapshotType	getType()
int	getVersion()
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

name

private final String name

table

private final TableName table

snapShotType

private final SnapshotType snapShotType

owner

private final String owner

creationTime

private final long creationTime

ttl

private final long ttl

version

private final int version

maxFileSize

private final long maxFileSize

Constructor Detail

SnapshotDescription

public SnapshotDescription(String name)

SnapshotDescription

@Deprecated
public SnapshotDescription(String name,
                                       String table)

Deprecated. since 2.0.0 and will be removed in 3.0.0. Use the version with the TableName instance instead.

See Also:

SnapshotDescription(String, TableName), HBASE-16892

SnapshotDescription

public SnapshotDescription(String name,
                           TableName table)

SnapshotDescription

@Deprecated
public SnapshotDescription(String name,
                                       String table,
                                       SnapshotType type)

Deprecated. since 2.0.0 and will be removed in 3.0.0. Use the version with the TableName instance instead.

See Also:

SnapshotDescription(String, TableName, SnapshotType), HBASE-16892

SnapshotDescription

public SnapshotDescription(String name,
                           TableName table,
                           SnapshotType type)

SnapshotDescription

@Deprecated
public SnapshotDescription(String name,
                                       String table,
                                       SnapshotType type,
                                       String owner)

Deprecated. since 2.0.0 and will be removed in 3.0.0. Use the version with the TableName instance instead.

See Also:

SnapshotDescription(String, TableName, SnapshotType, String), HBASE-16892

SnapshotDescription

public SnapshotDescription(String name,
                           TableName table,
                           SnapshotType type,
                           String owner)

SnapshotDescription

@Deprecated
public SnapshotDescription(String name,
                                       String table,
                                       SnapshotType type,
                                       String owner,
                                       long creationTime,
                                       int version)

Deprecated. since 2.0.0 and will be removed in 3.0.0. Use the version with the TableName instance instead.

See Also:

SnapshotDescription(String, TableName, SnapshotType, String, long, int, Map), HBASE-16892

SnapshotDescription

@Deprecated
public SnapshotDescription(String name,
                                       TableName table,
                                       SnapshotType type,
                                       String owner,
                                       long creationTime,
                                       int version)

Deprecated. since 2.3.0 and will be removed in 4.0.0. Use SnapshotDescription(String, TableName, SnapshotType, String, long, int, Map)

SnapshotDescription Parameterized Constructor

Parameters:

name - Name of the snapshot

table - TableName associated with the snapshot

type - Type of the snapshot - enum SnapshotType

owner - Snapshot Owner

creationTime - Creation time for Snapshot

version - Snapshot Version

SnapshotDescription

public SnapshotDescription(String name,
                           TableName table,
                           SnapshotType type,
                           String owner,
                           long creationTime,
                           int version,
                           Map<String,Object> snapshotProps)

SnapshotDescription Parameterized Constructor

Parameters:

name - Name of the snapshot

table - TableName associated with the snapshot

type - Type of the snapshot - enum SnapshotType

owner - Snapshot Owner

creationTime - Creation time for Snapshot

version - Snapshot Version

snapshotProps - Additional properties for snapshot e.g. TTL

SnapshotDescription

public SnapshotDescription(String snapshotName,
                           TableName tableName,
                           SnapshotType type,
                           Map<String,Object> snapshotProps)

SnapshotDescription Parameterized Constructor

Parameters:

snapshotName - Name of the snapshot

tableName - TableName associated with the snapshot

type - Type of the snapshot - enum SnapshotType

snapshotProps - Additional properties for snapshot e.g. TTL

Method Detail

getLongFromSnapshotProps

private long getLongFromSnapshotProps(Map<String,Object> snapshotProps,
                                      String property)

getName

public String getName()

getTable

@Deprecated
public String getTable()

Deprecated. since 2.0.0 and will be removed in 3.0.0. Use getTableName() or getTableNameAsString() instead.

Get the table name as a string.

See Also:

getTableName(), getTableNameAsString(), HBASE-16892

getTableNameAsString

public String getTableNameAsString()

getTableName

public TableName getTableName()

getType

public SnapshotType getType()

getOwner

public String getOwner()

getCreationTime

public long getCreationTime()

getTtl

public long getTtl()

getVersion

public int getVersion()

getMaxFileSize

public long getMaxFileSize()

toString

public String toString()

Overrides:

toString in class Object