Package org.apache.flink.runtime.minicluster

Class MiniClusterJobClient

java.lang.Object

org.apache.flink.runtime.minicluster.MiniClusterJobClient

All Implemented Interfaces:

org.apache.flink.core.execution.JobClient, CoordinationRequestGateway

public final class MiniClusterJobClient
extends Object
implements org.apache.flink.core.execution.JobClient, CoordinationRequestGateway

A JobClient for a MiniCluster.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MiniClusterJobClient.JobFinalizationBehavior	Determines the behavior of the MiniClusterJobClient when the job finishes.

Constructor Summary

Constructors

Constructor	Description
MiniClusterJobClient(org.apache.flink.api.common.JobID jobID, MiniCluster miniCluster, ClassLoader classLoader, MiniClusterJobClient.JobFinalizationBehavior finalizationBehaviour)	Creates a MiniClusterJobClient for the given JobID and MiniCluster.

Method Summary

Modifier and Type	Method	Description
CompletableFuture<Void>	cancel()
CompletableFuture<Map<String,Object>>	getAccumulators()
CompletableFuture<org.apache.flink.api.common.JobExecutionResult>	getJobExecutionResult()
org.apache.flink.api.common.JobID	getJobID()
CompletableFuture<org.apache.flink.api.common.JobStatus>	getJobStatus()
void	reportHeartbeat(long expiredTimestamp)
CompletableFuture<CoordinationResponse>	sendCoordinationRequest(OperatorID operatorId, CoordinationRequest request)	Send out a request to a specified coordinator and return the response.
CompletableFuture<String>	stopWithSavepoint(boolean terminate, String savepointDirectory, org.apache.flink.core.execution.SavepointFormatType formatType)
CompletableFuture<String>	triggerSavepoint(String savepointDirectory, org.apache.flink.core.execution.SavepointFormatType formatType)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.flink.core.execution.JobClient

stopWithSavepoint, triggerSavepoint

Constructor Detail

MiniClusterJobClient

public MiniClusterJobClient(org.apache.flink.api.common.JobID jobID,
                            MiniCluster miniCluster,
                            ClassLoader classLoader,
                            MiniClusterJobClient.JobFinalizationBehavior finalizationBehaviour)

Creates a MiniClusterJobClient for the given JobID and MiniCluster. This will shut down the MiniCluster after job result retrieval if shutdownCluster is true.

Method Detail

getJobID

public org.apache.flink.api.common.JobID getJobID()

Specified by:

getJobID in interface org.apache.flink.core.execution.JobClient

getJobStatus

public CompletableFuture<org.apache.flink.api.common.JobStatus> getJobStatus()

Specified by:

getJobStatus in interface org.apache.flink.core.execution.JobClient

cancel

public CompletableFuture<Void> cancel()

Specified by:

cancel in interface org.apache.flink.core.execution.JobClient

stopWithSavepoint

public CompletableFuture<String> stopWithSavepoint(boolean terminate,
                                                   @Nullable
                                                   String savepointDirectory,
                                                   org.apache.flink.core.execution.SavepointFormatType formatType)

Specified by:

stopWithSavepoint in interface org.apache.flink.core.execution.JobClient

triggerSavepoint

public CompletableFuture<String> triggerSavepoint(@Nullable
                                                  String savepointDirectory,
                                                  org.apache.flink.core.execution.SavepointFormatType formatType)

Specified by:

triggerSavepoint in interface org.apache.flink.core.execution.JobClient

getAccumulators

public CompletableFuture<Map<String,Object>> getAccumulators()

Specified by:

getAccumulators in interface org.apache.flink.core.execution.JobClient

getJobExecutionResult

public CompletableFuture<org.apache.flink.api.common.JobExecutionResult> getJobExecutionResult()

Specified by:

getJobExecutionResult in interface org.apache.flink.core.execution.JobClient

sendCoordinationRequest

public CompletableFuture<CoordinationResponse> sendCoordinationRequest(OperatorID operatorId,
                                                                       CoordinationRequest request)

Description copied from interface: CoordinationRequestGateway

Send out a request to a specified coordinator and return the response.

Specified by:

sendCoordinationRequest in interface CoordinationRequestGateway

Parameters:

operatorId - specifies which coordinator to receive the request

request - the request to send

Returns:

the response from the coordinator

reportHeartbeat

public void reportHeartbeat(long expiredTimestamp)

Specified by:

reportHeartbeat in interface org.apache.flink.core.execution.JobClient