From 894aaa5d688385b9f6d9145ae9f29f0100fe35eb Mon Sep 17 00:00:00 2001
From: mcilwain <mcilwain@google.com>
Date: Mon, 25 Apr 2016 08:13:25 -0700
Subject: [PATCH] Add code documentation on how the snapshot actions interact
 ------------- Created by MOE: https://github.com/google/moe
 MOE_MIGRATED_REVID=120707865

---
 .../registry/export/ExportSnapshotServlet.java       | 12 +++++++++++-
 1 file changed, 11 insertions(+), 1 deletion(-)

diff --git a/java/com/google/domain/registry/export/ExportSnapshotServlet.java b/java/com/google/domain/registry/export/ExportSnapshotServlet.java
index 5455a7521..936170c3c 100644
--- a/java/com/google/domain/registry/export/ExportSnapshotServlet.java
+++ b/java/com/google/domain/registry/export/ExportSnapshotServlet.java
@@ -33,7 +33,17 @@ import javax.servlet.http.HttpServlet;
 import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletResponse;
 
-/** Trigger a backup-as-a-service job that writes a snapshot to Google Cloud Storage. */
+/**
+ * Trigger a backup-as-a-service job that writes a snapshot to Google Cloud Storage.
+ *
+ * <p>This is the first step of a four step workflow for exporting snapshots, with each step calling
+ * the next upon successful completion:<ol>
+ *   <li>The snapshot is exported to Google Cloud Storage (this servlet).
+ *   <li>The {@link CheckSnapshotServlet} polls until the export is completed.
+ *   <li>The {@link LoadSnapshotAction} imports the data from GCS to BigQuery.
+ *   <li>The {@link UpdateSnapshotViewAction} updates the view in latest_snapshot.
+ * </ol>
+ */
 public class ExportSnapshotServlet extends HttpServlet {
 
   private static final RegistryEnvironment ENVIRONMENT = RegistryEnvironment.get();