hbase-client/src/main/java/org/apache/hadoop/hbase/client/SnapshotDescription.java

   1 /*
   2  * Licensed to the Apache Software Foundation (ASF) under one
   3  * or more contributor license agreements.  See the NOTICE file
   4  * distributed with this work for additional information
   5  * regarding copyright ownership.  The ASF licenses this file
   6  * to you under the Apache License, Version 2.0 (the
   7  * "License"); you may not use this file except in compliance
   8  * with the License.  You may obtain a copy of the License at
   9  *
  10  *     http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  */
  18 package org.apache.hadoop.hbase.client;
  19
  20 import java.util.Map;
  21
  22 import org.apache.commons.lang3.builder.ToStringBuilder;
  23 import org.apache.hadoop.hbase.TableName;
  24 import org.apache.yetus.audience.InterfaceAudience;
  25
  26 import org.apache.hbase.thirdparty.org.apache.commons.collections4.MapUtils;
  27
  28 /**
  29  * The POJO equivalent of HBaseProtos.SnapshotDescription
  30  */
  31 @InterfaceAudience.Public
  32 public class SnapshotDescription {
  33   private final String name;
  34   private final TableName table;
  35   private final SnapshotType snapShotType;
  36   private final String owner;
  37   private final long creationTime;
  38   private final long ttl;
  39   private final int version;
  40
  41   private final long maxFileSize;
  42
  43   public SnapshotDescription(String name) {
  44     this(name, null);
  45   }
  46
  47   public SnapshotDescription(String name, TableName table) {
  48     this(name, table, SnapshotType.DISABLED, null, -1, -1, null);
  49   }
  50
  51   public SnapshotDescription(String name, TableName table, SnapshotType type) {
  52     this(name, table, type, null, -1, -1, null);
  53   }
  54
  55   public SnapshotDescription(String name, TableName table, SnapshotType type, String owner) {
  56     this(name, table, type, owner, -1, -1, null);
  57   }
  58
  59   /**
  60    * SnapshotDescription Parameterized Constructor
  61    *
  62    * @param name Name of the snapshot
  63    * @param table TableName associated with the snapshot
  64    * @param type Type of the snapshot - enum SnapshotType
  65    * @param owner Snapshot Owner
  66    * @param creationTime Creation time for Snapshot
  67    * @param version Snapshot Version
  68    * @deprecated since 2.3.0 and will be removed in 4.0.0. Use
  69    *   {@link #SnapshotDescription(String, TableName, SnapshotType, String, long, int, Map)}
  70    */
  71   @Deprecated
  72   public SnapshotDescription(String name, TableName table, SnapshotType type, String owner,
  73       long creationTime, int version) {
  74     this(name, table, type, owner, creationTime, version, null);
  75   }
  76
  77   /**
  78    * SnapshotDescription Parameterized Constructor
  79    *
  80    * @param name          Name of the snapshot
  81    * @param table         TableName associated with the snapshot
  82    * @param type          Type of the snapshot - enum SnapshotType
  83    * @param owner         Snapshot Owner
  84    * @param creationTime  Creation time for Snapshot
  85    * @param version       Snapshot Version
  86    * @param snapshotProps Additional properties for snapshot e.g. TTL
  87    */
  88   public SnapshotDescription(String name, TableName table, SnapshotType type, String owner,
  89       long creationTime, int version, Map<String, Object> snapshotProps) {
  90     this.name = name;
  91     this.table = table;
  92     this.snapShotType = type;
  93     this.owner = owner;
  94     this.creationTime = creationTime;
  95     this.ttl = getLongFromSnapshotProps(snapshotProps, "TTL");
  96     this.version = version;
  97     this.maxFileSize = getLongFromSnapshotProps(snapshotProps, TableDescriptorBuilder.MAX_FILESIZE);
  98   }
  99
 100   private long getLongFromSnapshotProps(Map<String, Object> snapshotProps, String property) {
 101     return MapUtils.getLongValue(snapshotProps, property, -1);
 102   }
 103
 104
 105
 106   /**
 107    * SnapshotDescription Parameterized Constructor
 108    *
 109    * @param snapshotName  Name of the snapshot
 110    * @param tableName     TableName associated with the snapshot
 111    * @param type          Type of the snapshot - enum SnapshotType
 112    * @param snapshotProps Additional properties for snapshot e.g. TTL
 113    */
 114   public SnapshotDescription(String snapshotName, TableName tableName, SnapshotType type,
 115                              Map<String, Object> snapshotProps) {
 116     this(snapshotName, tableName, type, null, -1, -1, snapshotProps);
 117   }
 118
 119   public String getName() {
 120     return this.name;
 121   }
 122
 123   public String getTableNameAsString() {
 124     return this.table.getNameAsString();
 125   }
 126
 127   public TableName getTableName() {
 128     return this.table;
 129   }
 130
 131   public SnapshotType getType() {
 132     return this.snapShotType;
 133   }
 134
 135   public String getOwner() {
 136     return this.owner;
 137   }
 138
 139   public long getCreationTime() {
 140     return this.creationTime;
 141   }
 142
 143   // get snapshot ttl in sec
 144   public long getTtl() {
 145     return ttl;
 146   }
 147
 148   public int getVersion() {
 149     return this.version;
 150   }
 151
 152   public long getMaxFileSize() { return maxFileSize; }
 153
 154   @Override
 155   public String toString() {
 156     return new ToStringBuilder(this)
 157       .append("name", name)
 158       .append("table", table)
 159       .append("snapShotType", snapShotType)
 160       .append("owner", owner)
 161       .append("creationTime", creationTime)
 162       .append("ttl", ttl)
 163       .append("version", version)
 164       .append("maxFileSize", maxFileSize)
 165       .toString();
 166   }
 167 }