Package org.apache.flink.runtime.dispatcher.cleanup

Class DefaultResourceCleaner<T>

java.lang.Object

org.apache.flink.runtime.dispatcher.cleanup.DefaultResourceCleaner<T>

All Implemented Interfaces:

ResourceCleaner

public class DefaultResourceCleaner<T>
extends Object
implements ResourceCleaner

DefaultResourceCleaner is the default implementation of ResourceCleaner. It will try to clean up any resource that was added. Failure will result in an individual retry of the cleanup. The overall cleanup result succeeds after all subtasks succeeded.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DefaultResourceCleaner.Builder<T>	Builder for creating DefaultResourceCleaner instances.

Method Summary

Modifier and Type	Method	Description
CompletableFuture<Void>	cleanupAsync(JobID jobId)	Cleans job-related data from resources asynchronously.
static DefaultResourceCleaner.Builder<GloballyCleanableResource>	forGloballyCleanableResources(ComponentMainThreadExecutor mainThreadExecutor, Executor cleanupExecutor, RetryStrategy retryStrategy)
static DefaultResourceCleaner.Builder<LocallyCleanableResource>	forLocallyCleanableResources(ComponentMainThreadExecutor mainThreadExecutor, Executor cleanupExecutor, RetryStrategy retryStrategy)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

forLocallyCleanableResources

public static DefaultResourceCleaner.Builder<LocallyCleanableResource> forLocallyCleanableResources(ComponentMainThreadExecutor mainThreadExecutor,
                                                                                                    Executor cleanupExecutor,
                                                                                                    RetryStrategy retryStrategy)

forGloballyCleanableResources

public static DefaultResourceCleaner.Builder<GloballyCleanableResource> forGloballyCleanableResources(ComponentMainThreadExecutor mainThreadExecutor,
                                                                                                      Executor cleanupExecutor,
                                                                                                      RetryStrategy retryStrategy)

cleanupAsync

public CompletableFuture<Void> cleanupAsync(JobID jobId)

Description copied from interface: ResourceCleaner

Cleans job-related data from resources asynchronously.

Specified by:

cleanupAsync in interface ResourceCleaner

Parameters:

jobId - The JobID referring to the job for which the data shall be cleaned up.

Returns:

the cleanup result future.