add comment (#3305)

apache · Nov 1, 2023 · beb5c6d · beb5c6d
1 parent c7e5cac
commit beb5c6d
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 5 deletions.
diff --git a/...rc/main/scala/org/apache/streampark/flink/client/impl/KubernetesApplicationClientV2.scala b/...rc/main/scala/org/apache/streampark/flink/client/impl/KubernetesApplicationClientV2.scala
@@ -81,7 +81,7 @@ object KubernetesApplicationClientV2 extends KubernetesClientV2Trait with Logger
     )
   }
 
-  // Generate FlinkDeployment CR definition, it is a pure effect function.
+  /** Generate FlinkDeployment CR definition, it is a pure effect function. */
   private def genFlinkDeployDef(
       submitReq: SubmitRequest,
       originFlinkConfig: Configuration,
@@ -246,6 +246,7 @@ object KubernetesApplicationClientV2 extends KubernetesClientV2Trait with Logger
       ))
   }
 
+  /** Shutdown Flink Application deployment. */
   @throws[Throwable]
   def shutdown(shutDownRequest: ShutDownRequest): ShutDownResponse = {
     val name = shutDownRequest.clusterId

diff --git a/...re/src/main/scala/org/apache/streampark/flink/client/impl/KubernetesSessionClientV2.scala b/...re/src/main/scala/org/apache/streampark/flink/client/impl/KubernetesSessionClientV2.scala
@@ -125,6 +125,7 @@ object KubernetesSessionClientV2 extends KubernetesClientV2Trait with Logger {
       ))
   }
 
+  /** Deploy Flink cluster. */
   @throws[Throwable]
   def deploy(deployRequest: DeployRequest): DeployResponse = {
     logInfo(
@@ -190,6 +191,7 @@ object KubernetesSessionClientV2 extends KubernetesClientV2Trait with Logger {
     }
   }
 
+  /** Generate FlinkDeployment CR definition, it is a pure effect function. */
   private def genFlinkDeployDef(
       deployReq: DeployRequest,
       originFlinkConfig: Configuration): Either[FailureMessage, FlinkDeploymentDef] = {

diff --git a/...ink-client-core/src/main/scala/org/apache/streampark/flink/client/impl/RemoteClient.scala b/...ink-client-core/src/main/scala/org/apache/streampark/flink/client/impl/RemoteClient.scala
@@ -34,10 +34,6 @@ import scala.util.{Failure, Success, Try}
 /** Submit Job to Remote Cluster */
 object RemoteClient extends FlinkClientTrait {
 
-  /**
-   * @param submitRequest
-   * @param flinkConfig
-   */
   override def setConfig(submitRequest: SubmitRequest, flinkConfig: Configuration): Unit = {}
 
   override def doSubmit(

diff --git a/...ore/src/main/scala/org/apache/streampark/flink/client/trait/KubernetesClientV2Trait.scala b/...ore/src/main/scala/org/apache/streampark/flink/client/trait/KubernetesClientV2Trait.scala
@@ -34,6 +34,7 @@ import scala.collection.mutable
 import scala.jdk.CollectionConverters.asScalaBufferConverter
 import scala.util.{Failure, Success, Try}
 
+/** Flink K8s session/application mode cancel and Savepoint */
 trait KubernetesClientV2Trait extends FlinkClientTrait {
 
   protected type FailureMessage = String
@@ -60,6 +61,7 @@ trait KubernetesClientV2Trait extends FlinkClientTrait {
     Try(yamlMapper.readValue(yaml, classOf[Pod]))
   }
 
+  /** Generate JobDef */
   protected def genJobDef(
       flinkConfObj: Configuration,
       jarUriHint: Option[String]): Either[FailureMessage, JobDef] = {