This is an automated email from the ASF dual-hosted git repository.

saadurrahman pushed a commit to branch 
saadurrahman/3846-Refactoring-K8s-Shim-dev
in repository https://gitbox.apache.org/repos/asf/incubator-heron.git

commit 59dbacdb408b7d4620d482cde09716c5a504d2a1
Author: Saad Ur Rahman <[email protected]>
AuthorDate: Wed Jul 20 23:02:07 2022 -0400

    [StatefulSet] added javadoc for Configs constructor.
---
 .../java/org/apache/heron/scheduler/kubernetes/StatefulSet.java   | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git 
a/heron/schedulers/src/java/org/apache/heron/scheduler/kubernetes/StatefulSet.java
 
b/heron/schedulers/src/java/org/apache/heron/scheduler/kubernetes/StatefulSet.java
index 154f816867d..256885abb2b 100644
--- 
a/heron/schedulers/src/java/org/apache/heron/scheduler/kubernetes/StatefulSet.java
+++ 
b/heron/schedulers/src/java/org/apache/heron/scheduler/kubernetes/StatefulSet.java
@@ -88,6 +88,14 @@ final class StatefulSet {
     private final V1PodTemplateSpec managerPodTemplateSpec;
     private final V1PodTemplateSpec executorPodTemplateSpec;
 
+    /**
+     * <code>Configs</code> contains the Kubernetes cluster configurations as 
well as the
+     * <code>Pod Templates</code> for the <code>Executor</code>s and 
<code>Manager</code>.
+     * @param configuration The cluster configurations contains items 
relating/stored in the Kubernetes cluster.
+     * @param runtimeConfiguration The runtime configurations contain items 
such as the topology name.
+     * @param managerPodTemplateSpec The <code>Pod Template Spec</code> 
configurations for a <code>Manager</code>.
+     * @param executorPodTemplateSpec The <code>Pod Template Spec</code> 
configurations for the <code>Executor</code>s.
+     */
     Configs(Config configuration, Config runtimeConfiguration,
             V1PodTemplateSpec managerPodTemplateSpec, V1PodTemplateSpec 
executorPodTemplateSpec) {
       this.topologyName = Runtime.topologyName(runtimeConfiguration);

Reply via email to