Add code documentation on how the snapshot actions interact

-------------
Created by MOE: https://github.com/google/moe
MOE_MIGRATED_REVID=120707865
This commit is contained in:
mcilwain 2016-04-25 08:13:25 -07:00 committed by Justine Tunney
parent 7c43b1d89b
commit 894aaa5d68

View file

@ -33,7 +33,17 @@ import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse; 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 { public class ExportSnapshotServlet extends HttpServlet {
private static final RegistryEnvironment ENVIRONMENT = RegistryEnvironment.get(); private static final RegistryEnvironment ENVIRONMENT = RegistryEnvironment.get();