org.apache.flink.runtime.rest.handler.legacy

Interface ExecutionGraphCache

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

DefaultExecutionGraphCache

public interface ExecutionGraphCache
extends Closeable

Cache for ExecutionGraphInfo which are obtained from the Flink cluster. Every cache entry has an associated time to live after which a new request will trigger the reloading of the ExecutionGraphInfo from the cluster.

Method Summary

Modifier and Type	Method and Description
void	cleanup() Perform the cleanup of out dated cache entries.
void	close() Closes the execution graph cache.
CompletableFuture<ExecutionGraphInfo>	getExecutionGraphInfo(JobID jobId, RestfulGateway restfulGateway) Gets the ExecutionGraphInfo for the given JobID and caches it.
int	size() Gets the number of cache entries.

Method Detail

size

int size()

Gets the number of cache entries.

getExecutionGraphInfo

CompletableFuture<ExecutionGraphInfo> getExecutionGraphInfo(JobID jobId,
                                                            RestfulGateway restfulGateway)

Gets the ExecutionGraphInfo for the given JobID and caches it. The ExecutionGraphInfo will be requested again after the refresh interval has passed or if the graph could not be retrieved from the given gateway.

Parameters:

jobId - identifying the ExecutionGraphInfo to get

restfulGateway - to request the ExecutionGraphInfo from

Returns:

Future containing the requested ExecutionGraphInfo

cleanup

void cleanup()

Perform the cleanup of out dated cache entries.

close

void close()

Closes the execution graph cache.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable