You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@ozone.apache.org by GitBox <gi...@apache.org> on 2022/07/14 04:09:14 UTC
[GitHub] [ozone] nandakumar131 commented on a diff in pull request #3582: HDDS-6849. OM changes for tracking Snapshot Metadata
nandakumar131 commented on code in PR #3582:
URL: https://github.com/apache/ozone/pull/3582#discussion_r920729842
##########
hadoop-ozone/interface-client/src/main/proto/OmClientProtocol.proto:
##########
@@ -711,6 +711,31 @@ message PrefixInfo {
optional uint64 updateID = 5;
}
+/**
+ * SnapshotStatus - snapshot states.
+ * Snapshot in one of : active, deleted, or reclaimed state
+ */
+enum SnapshotStatusProto {
+ SNAPSHOT_ACTIVE = 1;
+ SNAPSHOT_DELETED = 2;
+ SNAPSHOT_RECLAIMED = 3;
+}
+
+/**
+ * SnapshotInfo table entry for Bucket/Volume snapshot metadata
+ */
+message SnapshotInfoEntry {
Review Comment:
Suggestion: Can we have just _SnapshotInfo_ instead of _SnapshotInfoEntry_
##########
hadoop-ozone/common/src/main/java/org/apache/hadoop/ozone/om/helpers/SnapshotInfo.java:
##########
@@ -0,0 +1,321 @@
+package org.apache.hadoop.ozone.om.helpers;
+
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos.SnapshotInfoEntry;
+import org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos.SnapshotStatusProto;
+
+import com.google.common.base.Preconditions;
+
+/**
+ * This class is used for storing info related to Snapshots.
+ *
+ * Each snapshot created has an associated SnapshotInfo entry
+ * containing the snapshotid, snapshot path,
+ * snapshot checkpoint directory, previous snapshotid
+ * for the snapshot path & global amongst other necessary fields.
+ */
+public final class SnapshotInfo {
+
+ /**
+ * SnapshotStatus enum composed of
+ * active, deleted and reclaimed statues.
+ */
+ public enum SnapshotStatus {
+ SNAPSHOT_ACTIVE,
+ SNAPSHOT_DELETED,
+ SNAPSHOT_RECLAIMED;
+
+ public static final SnapshotStatus DEFAULT = SNAPSHOT_ACTIVE;
+
+ public SnapshotStatusProto toProto() {
+ switch (this) {
+ case SNAPSHOT_ACTIVE:
+ return SnapshotStatusProto.SNAPSHOT_ACTIVE;
+ case SNAPSHOT_DELETED:
+ return SnapshotStatusProto.SNAPSHOT_DELETED;
+ case SNAPSHOT_RECLAIMED:
+ return SnapshotStatusProto.SNAPSHOT_RECLAIMED;
+ default:
+ throw new IllegalStateException(
+ "BUG: missing valid SnapshotStatus, found status=" + this);
+ }
+ }
+
+ public static SnapshotStatus valueOf(SnapshotStatusProto status) {
+ switch (status) {
+ case SNAPSHOT_ACTIVE:
+ return SNAPSHOT_ACTIVE;
+ case SNAPSHOT_DELETED:
+ return SNAPSHOT_DELETED;
+ case SNAPSHOT_RECLAIMED:
+ return SNAPSHOT_RECLAIMED;
+ default:
+ throw new IllegalStateException(
+ "BUG: missing valid SnapshotStatus, found status=" + status);
+ }
+ }
+ };
+
+ private final String snapshotID; // UUID
+ private String name;
+ private SnapshotStatus snapshotStatus;
+ private final long creationTime;
+ private long deletionTime;
+ private String pathPreviousSnapshotID;
+ private String globalPreviousSnapshotID;
+ private String snapshotPath; // snapshot mask
+ private String checkpointDir;
+
+ /**
+ * Private constructor, constructed via builder.
+ * @param snapshotID - Snapshot UUID.
+ * @param name - snapshot name.
+ * @param snapshotStatus - status: SNAPSHOT_ACTIVE, SNAPSHOT_DELETED,
+ * SNAPSHOT_RECLAIMED
+ * @param creationTime - Snapshot creation time.
+ * @param deletionTime - Snapshot deletion time.
+ * @param pathPreviousSnapshotID - Snapshot path previous snapshot id.
+ * @param globalPreviousSnapshotID - Snapshot global previous snapshot id.
+ * @param snapshotPath - Snapshot path, bucket .snapshot path.
+ * @param checkpointDir - Snapshot checkpoint directory.
+ */
+ @SuppressWarnings("checkstyle:ParameterNumber")
+ private SnapshotInfo(String snapshotID,
+ String name,
+ SnapshotStatus snapshotStatus,
+ long creationTime,
+ long deletionTime,
+ String pathPreviousSnapshotID,
+ String globalPreviousSnapshotID,
+ String snapshotPath,
+ String checkpointDir) {
+ this.snapshotID = snapshotID;
+ this.name = name;
+ this.snapshotStatus = snapshotStatus;
+ this.creationTime = creationTime;
+ this.deletionTime = deletionTime;
+ this.pathPreviousSnapshotID = pathPreviousSnapshotID;
+ this.globalPreviousSnapshotID = globalPreviousSnapshotID;
+ this.snapshotPath = snapshotPath;
+ this.checkpointDir = checkpointDir;
+ }
+
+ public void setName(String name) {
+ this.name = name;
+ }
+
+ public void setSnapshotStatus(SnapshotStatus snapshotStatus) {
+ this.snapshotStatus = snapshotStatus;
+ }
+
+ public void setDeletionTime(long delTime) {
+ this.deletionTime = delTime;
+ }
+
+ public void setPathPreviousSnapshotID(String pathPreviousSnapshotID) {
+ this.pathPreviousSnapshotID = pathPreviousSnapshotID;
+ }
+
+ public void setGlobalPreviousSnapshotID(String globalPreviousSnapshotID) {
+ this.globalPreviousSnapshotID = globalPreviousSnapshotID;
+ }
+
+ public void setSnapshotPath(String snapshotPath) {
+ this.snapshotPath = snapshotPath;
+ }
+
+ public void setCheckpointDir(String checkpointDir) {
+ this.checkpointDir = checkpointDir;
+ }
+
+ public String getSnapshotID() {
+ return snapshotID;
+ }
+
+ public String getName() {
+ return name;
+ }
+
+ public SnapshotStatus getSnapshotStatus() {
+ return snapshotStatus;
+ }
+
+ public long getCreationTime() {
+ return creationTime;
+ }
+
+ public long getDeletionTime() {
+ return deletionTime;
+ }
+
+ public String getPathPreviousSnapshotID() {
+ return pathPreviousSnapshotID;
+ }
+
+ public String getGlobalPreviousSnapshotID() {
+ return globalPreviousSnapshotID;
+ }
+
+ public String getSnapshotPath() {
+ return snapshotPath;
+ }
+
+ public String getCheckpointDir() {
+ return checkpointDir;
+ }
+
+ public static SnapshotInfo.Builder newBuilder() {
+ return new SnapshotInfo.Builder();
+ }
+
+ public SnapshotInfo.Builder toBuilder() {
+ return new SnapshotInfo.Builder()
+ .setSnapshotID(snapshotID)
+ .setSnapshotStatus(snapshotStatus)
+ .setCreationTime(creationTime)
+ .setDeletionTime(deletionTime)
+ .setPathPreviousSnapshotID(pathPreviousSnapshotID)
+ .setGlobalPreviousSnapshotID(globalPreviousSnapshotID)
+ .setSnapshotPath(snapshotPath)
+ .setCheckpointDir(checkpointDir);
+ }
+
+ /**
+ * Builder of SnapshotInfo.
+ */
+ public static class Builder {
+ private String snapshotID;
+ private String name;
+ private SnapshotStatus snapshotStatus;
+ private long creationTime;
+ private long deletionTime;
+ private String pathPreviousSnapshotID;
+ private String globalPreviousSnapshotID;
+ private String snapshotPath;
+ private String checkpointDir;
+
+ public Builder() {
+ // default values
+ this.snapshotStatus = SnapshotStatus.DEFAULT;
+ }
+
+ public Builder setSnapshotID(String snapshotID) {
+ this.snapshotID = snapshotID;
+ return this;
+ }
+
+ public Builder setName(String name) {
+ this.name = name;
+ return this;
+ }
+
+ public Builder setSnapshotStatus(SnapshotStatus snapshotStatus) {
+ this.snapshotStatus = snapshotStatus;
+ return this;
+ }
+
+ public Builder setCreationTime(long crTime) {
+ this.creationTime = crTime;
+ return this;
+ }
+
+ public Builder setDeletionTime(long delTime) {
+ this.deletionTime = delTime;
+ return this;
+ }
+
+ public Builder setPathPreviousSnapshotID(String pathPreviousSnapshotID) {
+ this.pathPreviousSnapshotID = pathPreviousSnapshotID;
+ return this;
+ }
+
+ public Builder setGlobalPreviousSnapshotID(
+ String globalPreviousSnapshotID) {
+ this.globalPreviousSnapshotID = globalPreviousSnapshotID;
+ return this;
+ }
+
+ public Builder setSnapshotPath(String snapshotPath) {
+ this.snapshotPath = snapshotPath;
+ return this;
+ }
+
+ public Builder setCheckpointDir(String checkpointDir) {
+ this.checkpointDir = checkpointDir;
+ return this;
+ }
+
+ public SnapshotInfo build() {
+ Preconditions.checkNotNull(name);
+ return new SnapshotInfo(
+ snapshotID,
+ name,
+ snapshotStatus,
+ creationTime,
+ deletionTime,
+ pathPreviousSnapshotID,
+ globalPreviousSnapshotID,
+ snapshotPath,
+ checkpointDir
+ );
+ }
+ }
+
+ /**
+ * Creates SnapshotInfo protobuf from OmBucketInfo.
Review Comment:
Typo: _OmBucketInfo_ -> _SnapshotInfo_
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@ozone.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@ozone.apache.org
For additional commands, e-mail: issues-help@ozone.apache.org