This is an automated email from the ASF dual-hosted git repository.
dongjoon pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/spark-kubernetes-operator.git
The following commit(s) were added to refs/heads/main by this push:
new 88180b6 [SPARK-55912] Add `since` Javadoc tag for all public
`spark-operator-api` classes
88180b6 is described below
commit 88180b684e6c0512902a7bb00a94b150ae65f6ea
Author: Dongjoon Hyun <[email protected]>
AuthorDate: Tue Mar 10 09:10:29 2026 -0700
[SPARK-55912] Add `since` Javadoc tag for all public `spark-operator-api`
classes
### What changes were proposed in this pull request?
This PR adds `since` Javadoc tags to all 42 public classes in
`spark-operator-api/src/main/java`.
The version for each class was determined by analyzing the git history:
- `0.1.0`: 39 classes (initial API module and same-release additions)
- `0.6.0`: 1 class (`StringUtils`, SPARK-53820)
- `0.8.0`: 2 classes (`BaseAttemptInfo`, `ApplicationAttemptInfo`,
SPARK-55623)
### Why are the changes needed?
The `since` Javadoc tag helps users understand which version introduced
each API class, improving API discoverability and compatibility tracking.
Currently, none of the public classes in `spark-operator-api` have this tag.
### Does this PR introduce _any_ user-facing change?
No. This only adds Javadoc metadata.
### How was this patch tested?
I manually verified one by one.
### Was this patch authored or co-authored using generative AI tooling?
Generated-by: `Gemini 3.1 Pro (High)` on `Antigravity`.
Closes #545 from dongjoon-hyun/SPARK-55912.
Authored-by: Dongjoon Hyun <[email protected]>
Signed-off-by: Dongjoon Hyun <[email protected]>
---
.../src/main/java/org/apache/spark/k8s/operator/BaseResource.java | 1 +
.../src/main/java/org/apache/spark/k8s/operator/Constants.java | 6 +++++-
.../main/java/org/apache/spark/k8s/operator/SparkApplication.java | 6 +++++-
.../java/org/apache/spark/k8s/operator/SparkApplicationList.java | 6 +++++-
.../src/main/java/org/apache/spark/k8s/operator/SparkCluster.java | 6 +++++-
.../main/java/org/apache/spark/k8s/operator/SparkClusterList.java | 6 +++++-
.../org/apache/spark/k8s/operator/decorators/ResourceDecorator.java | 6 +++++-
.../src/main/java/org/apache/spark/k8s/operator/diff/Diffable.java | 1 +
.../java/org/apache/spark/k8s/operator/spec/ApplicationSpec.java | 6 +++++-
.../apache/spark/k8s/operator/spec/ApplicationTimeoutConfig.java | 6 +++++-
.../org/apache/spark/k8s/operator/spec/ApplicationTolerations.java | 6 +++++-
.../apache/spark/k8s/operator/spec/BaseApplicationTemplateSpec.java | 6 +++++-
.../src/main/java/org/apache/spark/k8s/operator/spec/BaseSpec.java | 6 +++++-
.../main/java/org/apache/spark/k8s/operator/spec/ClusterSpec.java | 6 +++++-
.../java/org/apache/spark/k8s/operator/spec/ClusterTolerations.java | 6 +++++-
.../main/java/org/apache/spark/k8s/operator/spec/ConfigMapSpec.java | 6 +++++-
.../java/org/apache/spark/k8s/operator/spec/DeploymentMode.java | 6 +++++-
.../apache/spark/k8s/operator/spec/DriverServiceIngressSpec.java | 6 +++++-
.../org/apache/spark/k8s/operator/spec/ExecutorInstanceConfig.java | 2 ++
.../main/java/org/apache/spark/k8s/operator/spec/MasterSpec.java | 6 +++++-
.../org/apache/spark/k8s/operator/spec/ResourceRetainPolicy.java | 2 ++
.../main/java/org/apache/spark/k8s/operator/spec/RestartConfig.java | 6 +++++-
.../main/java/org/apache/spark/k8s/operator/spec/RestartPolicy.java | 6 +++++-
.../java/org/apache/spark/k8s/operator/spec/RuntimeVersions.java | 6 +++++-
.../org/apache/spark/k8s/operator/spec/WorkerInstanceConfig.java | 6 +++++-
.../main/java/org/apache/spark/k8s/operator/spec/WorkerSpec.java | 6 +++++-
.../apache/spark/k8s/operator/status/ApplicationAttemptInfo.java | 1 +
.../apache/spark/k8s/operator/status/ApplicationAttemptSummary.java | 6 +++++-
.../java/org/apache/spark/k8s/operator/status/ApplicationState.java | 6 +++++-
.../apache/spark/k8s/operator/status/ApplicationStateSummary.java | 5 +++++
.../org/apache/spark/k8s/operator/status/ApplicationStatus.java | 6 +++++-
.../java/org/apache/spark/k8s/operator/status/BaseAttemptInfo.java | 2 ++
.../org/apache/spark/k8s/operator/status/BaseAttemptSummary.java | 6 +++++-
.../main/java/org/apache/spark/k8s/operator/status/BaseState.java | 1 +
.../java/org/apache/spark/k8s/operator/status/BaseStateSummary.java | 6 +++++-
.../main/java/org/apache/spark/k8s/operator/status/BaseStatus.java | 1 +
.../org/apache/spark/k8s/operator/status/ClusterAttemptSummary.java | 6 +++++-
.../java/org/apache/spark/k8s/operator/status/ClusterState.java | 6 +++++-
.../org/apache/spark/k8s/operator/status/ClusterStateSummary.java | 5 +++++
.../java/org/apache/spark/k8s/operator/status/ClusterStatus.java | 6 +++++-
.../main/java/org/apache/spark/k8s/operator/utils/ModelUtils.java | 6 +++++-
.../main/java/org/apache/spark/k8s/operator/utils/StringUtils.java | 6 +++++-
42 files changed, 181 insertions(+), 32 deletions(-)
diff --git
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/BaseResource.java
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/BaseResource.java
index ecca1af..696b31d 100644
---
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/BaseResource.java
+++
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/BaseResource.java
@@ -36,6 +36,7 @@ import org.apache.spark.k8s.operator.status.BaseStatus;
* @param <STATE> The type of the state.
* @param <SPEC> The type of the spec.
* @param <STATUS> The type of the status.
+ * @since 0.1.0
*/
public class BaseResource<
S,
diff --git
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/Constants.java
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/Constants.java
index 7109761..898286e 100644
---
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/Constants.java
+++
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/Constants.java
@@ -19,7 +19,11 @@
package org.apache.spark.k8s.operator;
-/** Constants used in the Spark Kubernetes Operator. */
+/**
+ * Constants used in the Spark Kubernetes Operator.
+ *
+ * @since 0.1.0
+ */
@SuppressWarnings("PMD.DataClass")
public class Constants {
/** The API group for Spark K8s Operator CRD resources. */
diff --git
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/SparkApplication.java
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/SparkApplication.java
index 4b197ac..07f97b0 100644
---
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/SparkApplication.java
+++
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/SparkApplication.java
@@ -32,7 +32,11 @@ import org.apache.spark.k8s.operator.status.ApplicationState;
import org.apache.spark.k8s.operator.status.ApplicationStateSummary;
import org.apache.spark.k8s.operator.status.ApplicationStatus;
-/** SparkApplication is the Custom Resource Definition (CRD) for a Spark
application. */
+/**
+ * SparkApplication is the Custom Resource Definition (CRD) for a Spark
application.
+ *
+ * @since 0.1.0
+ */
@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonDeserialize()
@Group(Constants.API_GROUP)
diff --git
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/SparkApplicationList.java
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/SparkApplicationList.java
index db54f6b..59be8dd 100644
---
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/SparkApplicationList.java
+++
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/SparkApplicationList.java
@@ -22,6 +22,10 @@ package org.apache.spark.k8s.operator;
import io.fabric8.kubernetes.api.model.DefaultKubernetesResourceList;
import lombok.NoArgsConstructor;
-/** List of SparkApplications. */
+/**
+ * List of SparkApplications.
+ *
+ * @since 0.1.0
+ */
@NoArgsConstructor
public class SparkApplicationList extends
DefaultKubernetesResourceList<SparkApplication> {}
diff --git
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/SparkCluster.java
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/SparkCluster.java
index 3981c37..6f8af2c 100644
---
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/SparkCluster.java
+++
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/SparkCluster.java
@@ -32,7 +32,11 @@ import org.apache.spark.k8s.operator.status.ClusterState;
import org.apache.spark.k8s.operator.status.ClusterStateSummary;
import org.apache.spark.k8s.operator.status.ClusterStatus;
-/** SparkCluster is the Custom Resource Definition (CRD) for a Spark cluster.
*/
+/**
+ * SparkCluster is the Custom Resource Definition (CRD) for a Spark cluster.
+ *
+ * @since 0.1.0
+ */
@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonDeserialize()
@Group(Constants.API_GROUP)
diff --git
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/SparkClusterList.java
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/SparkClusterList.java
index 78883f5..e093754 100644
---
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/SparkClusterList.java
+++
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/SparkClusterList.java
@@ -22,6 +22,10 @@ package org.apache.spark.k8s.operator;
import io.fabric8.kubernetes.api.model.DefaultKubernetesResourceList;
import lombok.NoArgsConstructor;
-/** List of SparkClusters. */
+/**
+ * List of SparkClusters.
+ *
+ * @since 0.1.0
+ */
@NoArgsConstructor
public class SparkClusterList extends
DefaultKubernetesResourceList<SparkCluster> {}
diff --git
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/decorators/ResourceDecorator.java
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/decorators/ResourceDecorator.java
index 2029650..5dbdcd0 100644
---
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/decorators/ResourceDecorator.java
+++
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/decorators/ResourceDecorator.java
@@ -21,7 +21,11 @@ package org.apache.spark.k8s.operator.decorators;
import io.fabric8.kubernetes.api.model.HasMetadata;
-/** Interface for decorating Kubernetes resources. */
+/**
+ * Interface for decorating Kubernetes resources.
+ *
+ * @since 0.1.0
+ */
public interface ResourceDecorator {
/**
* Decorates a Kubernetes resource.
diff --git
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/diff/Diffable.java
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/diff/Diffable.java
index e9b90b4..256bca4 100644
---
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/diff/Diffable.java
+++
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/diff/Diffable.java
@@ -23,5 +23,6 @@ package org.apache.spark.k8s.operator.diff;
* Represents an entity that can be compared for differences.
*
* @param <T> the type of the entity to compare with
+ * @since 0.1.0
*/
public interface Diffable<T> {}
diff --git
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/spec/ApplicationSpec.java
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/spec/ApplicationSpec.java
index f8fd531..56599b8 100644
---
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/spec/ApplicationSpec.java
+++
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/spec/ApplicationSpec.java
@@ -31,7 +31,11 @@ import lombok.Data;
import lombok.EqualsAndHashCode;
import lombok.NoArgsConstructor;
-/** Spec for a Spark application. */
+/**
+ * Spec for a Spark application.
+ *
+ * @since 0.1.0
+ */
@Data
@NoArgsConstructor
@AllArgsConstructor
diff --git
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/spec/ApplicationTimeoutConfig.java
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/spec/ApplicationTimeoutConfig.java
index b2bbcc7..54911cf 100644
---
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/spec/ApplicationTimeoutConfig.java
+++
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/spec/ApplicationTimeoutConfig.java
@@ -26,7 +26,11 @@ import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;
-/** Application timeout configuration. */
+/**
+ * Application timeout configuration.
+ *
+ * @since 0.1.0
+ */
@Data
@NoArgsConstructor
@AllArgsConstructor
diff --git
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/spec/ApplicationTolerations.java
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/spec/ApplicationTolerations.java
index 77b6539..3a98f49 100644
---
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/spec/ApplicationTolerations.java
+++
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/spec/ApplicationTolerations.java
@@ -32,7 +32,11 @@ import lombok.NoArgsConstructor;
import org.apache.spark.k8s.operator.status.ApplicationState;
-/** Toleration settings for a Spark application. */
+/**
+ * Toleration settings for a Spark application.
+ *
+ * @since 0.1.0
+ */
@Data
@NoArgsConstructor
@AllArgsConstructor
diff --git
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/spec/BaseApplicationTemplateSpec.java
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/spec/BaseApplicationTemplateSpec.java
index 35c7226..aa60f4a 100644
---
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/spec/BaseApplicationTemplateSpec.java
+++
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/spec/BaseApplicationTemplateSpec.java
@@ -27,7 +27,11 @@ import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;
-/** Base class for application template specs for driver and executors. */
+/**
+ * Base class for application template specs for driver and executors.
+ *
+ * @since 0.1.0
+ */
@Data
@NoArgsConstructor
@AllArgsConstructor
diff --git
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/spec/BaseSpec.java
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/spec/BaseSpec.java
index bfef359..e9d3770 100644
---
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/spec/BaseSpec.java
+++
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/spec/BaseSpec.java
@@ -28,7 +28,11 @@ import lombok.Data;
import org.apache.spark.k8s.operator.diff.Diffable;
-/** Base spec for all custom resources. */
+/**
+ * Base spec for all custom resources.
+ *
+ * @since 0.1.0
+ */
@Data
@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonIgnoreProperties(ignoreUnknown = true)
diff --git
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/spec/ClusterSpec.java
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/spec/ClusterSpec.java
index 12b0644..d373600 100644
---
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/spec/ClusterSpec.java
+++
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/spec/ClusterSpec.java
@@ -28,7 +28,11 @@ import lombok.Data;
import lombok.EqualsAndHashCode;
import lombok.NoArgsConstructor;
-/** Spec for a Spark cluster. */
+/**
+ * Spec for a Spark cluster.
+ *
+ * @since 0.1.0
+ */
@Data
@NoArgsConstructor
@AllArgsConstructor
diff --git
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/spec/ClusterTolerations.java
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/spec/ClusterTolerations.java
index e59cd24..5972342 100644
---
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/spec/ClusterTolerations.java
+++
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/spec/ClusterTolerations.java
@@ -25,7 +25,11 @@ import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;
-/** Toleration settings for a Spark cluster. */
+/**
+ * Toleration settings for a Spark cluster.
+ *
+ * @since 0.1.0
+ */
@Data
@NoArgsConstructor
@AllArgsConstructor
diff --git
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/spec/ConfigMapSpec.java
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/spec/ConfigMapSpec.java
index bdf00a1..8a5ca89 100644
---
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/spec/ConfigMapSpec.java
+++
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/spec/ConfigMapSpec.java
@@ -28,7 +28,11 @@ import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;
-/** Spec for a ConfigMap. */
+/**
+ * Spec for a ConfigMap.
+ *
+ * @since 0.1.0
+ */
@Data
@NoArgsConstructor
@AllArgsConstructor
diff --git
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/spec/DeploymentMode.java
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/spec/DeploymentMode.java
index bf6a298..077217b 100644
---
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/spec/DeploymentMode.java
+++
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/spec/DeploymentMode.java
@@ -19,7 +19,11 @@
package org.apache.spark.k8s.operator.spec;
-/** Represents the deployment mode for a Spark application. */
+/**
+ * Represents the deployment mode for a Spark application.
+ *
+ * @since 0.1.0
+ */
public enum DeploymentMode {
ClusterMode,
ClientMode
diff --git
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/spec/DriverServiceIngressSpec.java
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/spec/DriverServiceIngressSpec.java
index e04f994..a173cc5 100644
---
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/spec/DriverServiceIngressSpec.java
+++
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/spec/DriverServiceIngressSpec.java
@@ -30,7 +30,11 @@ import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;
-/** Spec for a driver service ingress. */
+/**
+ * Spec for a driver service ingress.
+ *
+ * @since 0.1.0
+ */
@Data
@Builder
@JsonInclude(JsonInclude.Include.NON_NULL)
diff --git
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/spec/ExecutorInstanceConfig.java
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/spec/ExecutorInstanceConfig.java
index 611d76b..1d08de4 100644
---
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/spec/ExecutorInstanceConfig.java
+++
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/spec/ExecutorInstanceConfig.java
@@ -55,6 +55,8 @@ import lombok.NoArgsConstructor;
* <li>Spark app would be marked as 'RunningHealthy' if it has at least min
executors after
* successfully start up.
* </ul>
+ *
+ * @since 0.1.0
*/
@Data
@NoArgsConstructor
diff --git
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/spec/MasterSpec.java
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/spec/MasterSpec.java
index a459a9a..ad8655c 100644
---
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/spec/MasterSpec.java
+++
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/spec/MasterSpec.java
@@ -28,7 +28,11 @@ import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;
-/** Spec for a Spark master. */
+/**
+ * Spec for a Spark master.
+ *
+ * @since 0.1.0
+ */
@Data
@NoArgsConstructor
@AllArgsConstructor
diff --git
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/spec/ResourceRetainPolicy.java
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/spec/ResourceRetainPolicy.java
index 4cce4c8..2ce47e3 100644
---
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/spec/ResourceRetainPolicy.java
+++
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/spec/ResourceRetainPolicy.java
@@ -31,6 +31,8 @@ package org.apache.spark.k8s.operator.spec;
* configured to make sure it's garbage collected by k8s. Please be advised
that resource would
* not be retained if application is configured to restart, this is to avoid
resource quota usage
* increase unexpectedly or resource conflicts among multiple attempts.
+ *
+ * @since 0.1.0
*/
public enum ResourceRetainPolicy {
Always,
diff --git
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/spec/RestartConfig.java
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/spec/RestartConfig.java
index 51fb5fb..fb54275 100644
---
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/spec/RestartConfig.java
+++
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/spec/RestartConfig.java
@@ -29,7 +29,11 @@ import lombok.NoArgsConstructor;
import org.apache.spark.k8s.operator.status.ApplicationStateSummary;
-/** Restart configuration for a Spark application. */
+/**
+ * Restart configuration for a Spark application.
+ *
+ * @since 0.1.0
+ */
@Data
@NoArgsConstructor
@AllArgsConstructor
diff --git
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/spec/RestartPolicy.java
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/spec/RestartPolicy.java
index 651f5c2..b6c2d4f 100644
---
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/spec/RestartPolicy.java
+++
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/spec/RestartPolicy.java
@@ -21,7 +21,11 @@ package org.apache.spark.k8s.operator.spec;
import org.apache.spark.k8s.operator.status.BaseStateSummary;
-/** Defines the restart policy for a Spark application. */
+/**
+ * Defines the restart policy for a Spark application.
+ *
+ * @since 0.1.0
+ */
public enum RestartPolicy {
Always,
Never,
diff --git
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/spec/RuntimeVersions.java
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/spec/RuntimeVersions.java
index 11abbe9..9c9b13a 100644
---
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/spec/RuntimeVersions.java
+++
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/spec/RuntimeVersions.java
@@ -27,7 +27,11 @@ import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;
-/** Runtime versions for a Spark application or cluster. */
+/**
+ * Runtime versions for a Spark application or cluster.
+ *
+ * @since 0.1.0
+ */
@Data
@NoArgsConstructor
@AllArgsConstructor
diff --git
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/spec/WorkerInstanceConfig.java
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/spec/WorkerInstanceConfig.java
index 914ccca..e7ad563 100644
---
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/spec/WorkerInstanceConfig.java
+++
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/spec/WorkerInstanceConfig.java
@@ -25,7 +25,11 @@ import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;
-/** Config tolerations of worker instances for the cluster. */
+/**
+ * Config tolerations of worker instances for the cluster.
+ *
+ * @since 0.1.0
+ */
@Data
@NoArgsConstructor
@AllArgsConstructor
diff --git
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/spec/WorkerSpec.java
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/spec/WorkerSpec.java
index 7094195..e8ed538 100644
---
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/spec/WorkerSpec.java
+++
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/spec/WorkerSpec.java
@@ -29,7 +29,11 @@ import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;
-/** Spec for a Spark worker. */
+/**
+ * Spec for a Spark worker.
+ *
+ * @since 0.1.0
+ */
@Data
@NoArgsConstructor
@AllArgsConstructor
diff --git
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/status/ApplicationAttemptInfo.java
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/status/ApplicationAttemptInfo.java
index 1577e16..c9bf414 100644
---
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/status/ApplicationAttemptInfo.java
+++
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/status/ApplicationAttemptInfo.java
@@ -37,6 +37,7 @@ import lombok.ToString;
* against maxRestartOnSchedulingFailure</li>
* </ul>
*
+ * @since 0.8.0
*/
@Setter
@Getter
diff --git
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/status/ApplicationAttemptSummary.java
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/status/ApplicationAttemptSummary.java
index 3c680a1..37ff296 100644
---
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/status/ApplicationAttemptSummary.java
+++
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/status/ApplicationAttemptSummary.java
@@ -27,7 +27,11 @@ import lombok.EqualsAndHashCode;
import lombok.Getter;
import lombok.ToString;
-/** Summary of a Spark application attempt. */
+/**
+ * Summary of a Spark application attempt.
+ *
+ * @since 0.1.0
+ */
@EqualsAndHashCode(callSuper = true)
@ToString(callSuper = true)
@JsonInclude(JsonInclude.Include.NON_NULL)
diff --git
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/status/ApplicationState.java
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/status/ApplicationState.java
index b4dcdfb..1386086 100644
---
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/status/ApplicationState.java
+++
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/status/ApplicationState.java
@@ -32,7 +32,11 @@ import lombok.Getter;
import lombok.Setter;
import lombok.ToString;
-/** Represents the state of a Spark application. */
+/**
+ * Represents the state of a Spark application.
+ *
+ * @since 0.1.0
+ */
@ToString(callSuper = true)
@EqualsAndHashCode(callSuper = true)
@JsonInclude(JsonInclude.Include.NON_NULL)
diff --git
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/status/ApplicationStateSummary.java
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/status/ApplicationStateSummary.java
index e526b98..ffeaa0a 100644
---
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/status/ApplicationStateSummary.java
+++
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/status/ApplicationStateSummary.java
@@ -21,6 +21,11 @@ package org.apache.spark.k8s.operator.status;
import java.util.Set;
+/**
+ * State summary for a Spark application.
+ *
+ * @since 0.1.0
+ */
public enum ApplicationStateSummary implements BaseStateSummary {
/** Spark application is submitted to the cluster but yet scheduled */
Submitted,
diff --git
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/status/ApplicationStatus.java
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/status/ApplicationStatus.java
index 5ee6830..26dc36d 100644
---
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/status/ApplicationStatus.java
+++
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/status/ApplicationStatus.java
@@ -36,7 +36,11 @@ import
org.apache.spark.k8s.operator.spec.ResourceRetainPolicy;
import org.apache.spark.k8s.operator.spec.RestartConfig;
import org.apache.spark.k8s.operator.spec.RestartPolicy;
-/** Represents the status of a Spark application. */
+/**
+ * Represents the status of a Spark application.
+ *
+ * @since 0.1.0
+ */
@EqualsAndHashCode(callSuper = true)
@ToString(callSuper = true)
@JsonInclude(JsonInclude.Include.NON_NULL)
diff --git
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/status/BaseAttemptInfo.java
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/status/BaseAttemptInfo.java
index 6f415da..44a8783 100644
---
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/status/BaseAttemptInfo.java
+++
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/status/BaseAttemptInfo.java
@@ -31,6 +31,8 @@ import lombok.ToString;
/**
* Basic information about an attempt.
+ *
+ * @since 0.8.0
*/
@Getter
@NoArgsConstructor
diff --git
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/status/BaseAttemptSummary.java
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/status/BaseAttemptSummary.java
index 85e07e8..f0e701c 100644
---
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/status/BaseAttemptSummary.java
+++
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/status/BaseAttemptSummary.java
@@ -26,7 +26,11 @@ import lombok.Getter;
import lombok.RequiredArgsConstructor;
import lombok.ToString;
-/** Base class for attempt summaries. */
+/**
+ * Base class for attempt summaries.
+ *
+ * @since 0.1.0
+ */
@EqualsAndHashCode
@ToString
@Getter
diff --git
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/status/BaseState.java
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/status/BaseState.java
index 82d8623..0ae4c03 100644
---
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/status/BaseState.java
+++
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/status/BaseState.java
@@ -30,6 +30,7 @@ import lombok.Data;
* Base class for state information.
*
* @param <T> The type of the current state summary.
+ * @since 0.1.0
*/
@Data
@AllArgsConstructor
diff --git
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/status/BaseStateSummary.java
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/status/BaseStateSummary.java
index c8faed0..61cf0ce 100644
---
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/status/BaseStateSummary.java
+++
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/status/BaseStateSummary.java
@@ -19,7 +19,11 @@
package org.apache.spark.k8s.operator.status;
-/** State for Spark Custom Resource */
+/**
+ * State for Spark Custom Resource.
+ *
+ * @since 0.1.0
+ */
public interface BaseStateSummary {
/**
* Checks if the CustomResource has failed.
diff --git
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/status/BaseStatus.java
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/status/BaseStatus.java
index 0bd618b..4e04253 100644
---
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/status/BaseStatus.java
+++
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/status/BaseStatus.java
@@ -35,6 +35,7 @@ import lombok.ToString;
* @param <S> The type of the state summary.
* @param <STATE> The type of the state.
* @param <AS> The type of the attempt summary.
+ * @since 0.1.0
*/
@ToString
@EqualsAndHashCode
diff --git
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/status/ClusterAttemptSummary.java
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/status/ClusterAttemptSummary.java
index d2b46c5..d8fbaf3 100644
---
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/status/ClusterAttemptSummary.java
+++
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/status/ClusterAttemptSummary.java
@@ -27,7 +27,11 @@ import lombok.EqualsAndHashCode;
import lombok.Getter;
import lombok.ToString;
-/** Summary of a Spark cluster attempt. */
+/**
+ * Summary of a Spark cluster attempt.
+ *
+ * @since 0.1.0
+ */
@Getter
@EqualsAndHashCode(callSuper = true)
@ToString(callSuper = true)
diff --git
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/status/ClusterState.java
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/status/ClusterState.java
index 1ccd8e6..23811ca 100644
---
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/status/ClusterState.java
+++
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/status/ClusterState.java
@@ -29,7 +29,11 @@ import com.fasterxml.jackson.annotation.JsonInclude;
import lombok.EqualsAndHashCode;
import lombok.ToString;
-/** Represents the state of a Spark cluster. */
+/**
+ * Represents the state of a Spark cluster.
+ *
+ * @since 0.1.0
+ */
@ToString(callSuper = true)
@EqualsAndHashCode(callSuper = true)
@JsonInclude(JsonInclude.Include.NON_NULL)
diff --git
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/status/ClusterStateSummary.java
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/status/ClusterStateSummary.java
index c614624..fb8b22b 100644
---
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/status/ClusterStateSummary.java
+++
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/status/ClusterStateSummary.java
@@ -19,6 +19,11 @@
package org.apache.spark.k8s.operator.status;
+/**
+ * State summary for a Spark cluster.
+ *
+ * @since 0.1.0
+ */
public enum ClusterStateSummary implements BaseStateSummary {
/** Spark cluster is submitted but yet scheduled */
Submitted,
diff --git
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/status/ClusterStatus.java
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/status/ClusterStatus.java
index 4d45210..4962590 100644
---
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/status/ClusterStatus.java
+++
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/status/ClusterStatus.java
@@ -27,7 +27,11 @@ import com.fasterxml.jackson.annotation.JsonInclude;
import lombok.EqualsAndHashCode;
import lombok.ToString;
-/** Represents the status of a Spark cluster. */
+/**
+ * Represents the status of a Spark cluster.
+ *
+ * @since 0.1.0
+ */
@EqualsAndHashCode(callSuper = true)
@ToString(callSuper = true)
@JsonInclude(JsonInclude.Include.NON_NULL)
diff --git
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/utils/ModelUtils.java
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/utils/ModelUtils.java
index 022a9bb..7f16203 100644
---
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/utils/ModelUtils.java
+++
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/utils/ModelUtils.java
@@ -39,7 +39,11 @@ import io.fabric8.kubernetes.api.model.PodTemplateSpec;
import org.apache.spark.k8s.operator.SparkApplication;
import org.apache.spark.k8s.operator.spec.ApplicationSpec;
-/** Utility class for Kubernetes model operations. */
+/**
+ * Utility class for Kubernetes model operations.
+ *
+ * @since 0.1.0
+ */
public final class ModelUtils {
public static final ObjectMapper objectMapper = new ObjectMapper();
diff --git
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/utils/StringUtils.java
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/utils/StringUtils.java
index cf35409..37f3795 100644
---
a/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/utils/StringUtils.java
+++
b/spark-operator-api/src/main/java/org/apache/spark/k8s/operator/utils/StringUtils.java
@@ -22,7 +22,11 @@ package org.apache.spark.k8s.operator.utils;
import java.io.PrintWriter;
import java.io.StringWriter;
-/** Utility class for string operations. */
+/**
+ * Utility class for string operations.
+ *
+ * @since 0.6.0
+ */
public final class StringUtils {
private StringUtils() {}
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
