org.apache.flink.runtime.dispatcher.cleanup

Interface GloballyCleanableResource

All Known Subinterfaces:

HighAvailabilityServices, JobGraphStore, JobGraphWriter

All Known Implementing Classes:

AbstractHaServices, AbstractNonHaServices, BlobServer, DefaultJobGraphStore, EmbeddedHaServices, EmbeddedHaServicesWithLeadershipControl, KubernetesLeaderElectionHaServices, SingleJobJobGraphStore, StandaloneHaServices, StandaloneJobGraphStore, ThrowingJobGraphWriter, ZooKeeperLeaderElectionHaServices

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface GloballyCleanableResource

GloballyCleanableResource is supposed to be implemented by any class that provides artifacts for a given job that need to be cleaned up after the job reached a global terminal state.

See Also:

LocallyCleanableResource, JobStatus

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Void>	globalCleanupAsync(JobID jobId, Executor cleanupExecutor) globalCleanupAsync is expected to be called from the main thread.

Method Detail

globalCleanupAsync

CompletableFuture<Void> globalCleanupAsync(JobID jobId,
                                           Executor cleanupExecutor)

globalCleanupAsync is expected to be called from the main thread. Heavy IO tasks should be outsourced into the passed cleanupExecutor. Thread-safety must be ensured.

Parameters:

jobId - The JobID of the job for which the local data should be cleaned up.

cleanupExecutor - The fallback executor for IO-heavy operations.

Returns:

The cleanup result future.