javadoc

Author: wind57

spring-cloud-kubernetes-commons/src/main/java/org/springframework/cloud/kubernetes/commons/PodReady.java

@@ -36,6 +36,11 @@ public final class PodReady {
 	private final CachedSingleThreadScheduler podReadyScheduler = new CachedSingleThreadScheduler(
 			TimeUnit.SECONDS.toMillis(10));
 
+	/**
+	 * The resulting CompletableFuture is completed when pod is ready according to the BooleanSupplier.
+	 * You are supposed to properly get rid of this task, but calling the other public method
+	 * getPodReadyTask and cancel it, this will take care to shutdown the executor it was running in.
+	 */
 	public CompletableFuture<Void> podReady(BooleanSupplier isPodReady, String holderIdentity, String podNamespace) {
 
 		CompletableFuture<Void> podReadyFuture = new CompletableFuture<>();