phet commented on code in PR #3878: URL: https://github.com/apache/gobblin/pull/3878#discussion_r1492831854
########## gobblin-service/src/main/java/org/apache/gobblin/service/modules/orchestration/DagManagementStateStore.java: ########## @@ -0,0 +1,167 @@ +/* + * 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. + */ + +package org.apache.gobblin.service.modules.orchestration; + +import java.io.IOException; +import java.util.Collection; +import java.util.List; +import java.util.Set; + +import org.apache.gobblin.annotation.Alpha; +import org.apache.gobblin.exception.QuotaExceededException; +import org.apache.gobblin.service.modules.flowgraph.Dag; +import org.apache.gobblin.service.modules.flowgraph.DagNodeId; +import org.apache.gobblin.service.modules.spec.JobExecutionPlan; + + +/** + * An interface to provide abstractions for managing {@link Dag} and {@link org.apache.gobblin.service.modules.flowgraph.Dag.DagNode} states + * and allows add/delete and other functions. + */ +@Alpha +public interface DagManagementStateStore { + /** + * Checkpoints any changes in {@link Dag} or in its {@link Dag.DagNode}s. + * e.g. on adding a failed dag in store to retry later, on submitting a dag node to spec producer because that changes + * dag node's state, on resuming a dag, on receiving a new dag from orchestrator. + * Opposite of this is {@link DagManagementStateStore#deleteDag} that removes the Dag from the store. + * @param dag The dag to checkpoint + */ + void checkpointDag(Dag<JobExecutionPlan> dag) throws IOException; + + /** + * Returns true if the dag is present in the store. + * @param dagId DagId of the dag Review Comment: take it or leave it, but this is how I write brief javadoc (e.g. by presuming `dagId` to be self-explanatory): ``` @return whether `dagId` is currently known due to {@link checkpointDag} but not yet {@link deleteDag} ``` or for the one below: ``` @return the {@link Dag}, if present ``` -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
