ClientSnapshotDescriptionUtils (Apache HBase 1.4.11 API)

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- org.apache.hadoop.hbase.snapshot.ClientSnapshotDescriptionUtils

```
@InterfaceAudience.Private
public final class ClientSnapshotDescriptionUtils
extends Object
```
Class to help with dealing with a snapshot description on the client side. There is a corresponding class on the server side.

Method Summary

Methods
Modifier and Type	Method and Description
`static void`	`assertSnapshotRequestIsValid(org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription snapshot)` Check to make sure that the description of the snapshot requested is valid
`static String`	`toString(org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription snapshot)` Returns a single line (no \n) representation of snapshot metadata.

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

- Method Detail
  - assertSnapshotRequestIsValid
```
public static void assertSnapshotRequestIsValid(org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription snapshot)
                                         throws IllegalArgumentException
```
    Check to make sure that the description of the snapshot requested is valid
    
    Parameters:
    snapshot - description of the snapshot
    
    Throws:
    
    IllegalArgumentException - if the name of the snapshot or the name of the table to snapshot are not valid names
  - toString
```
public static String toString(org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription snapshot)
```
    Returns a single line (no \n) representation of snapshot metadata. Use this instead of AbstractMessage.toString(). We don't replace HBaseProtos.SnapshotDescription's toString, because it is auto-generated by protoc.
    
    Parameters:
    snapshot - description of the snapshot
    
    Returns:
    single line string with a summary of the snapshot parameters

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Copyright © 2007–2019 The Apache Software Foundation. All rights reserved.