com.hazelcast.jet

Interface Job

public interface Job

A Jet computation job created from a DAG. Jet will start executing it automatically and its associated future can be used to wait for it to complete or cancel it.

Method Summary

Modifier and Type	Method and Description
default boolean	cancel() Attempts to cancel execution of this job.
default CompletableFuture<Void>	execute() Deprecated. Use getFuture() instead. This method will be removed in the next release.
CompletableFuture<Void>	getFuture() Gets the future associated with the job, used to control the job.
long	getJobId() Returns the ID of this job.
JobStatus	getJobStatus() Returns the status of this job.
default void	join() Waits for the job to complete and throws exception if job is completed with an error.

Method Detail

getJobId

long getJobId()

Returns the ID of this job.

Throws:

IllegalStateException - If the job was not started yet, and thus has no job id.

getFuture

@Nonnull
CompletableFuture<Void> getFuture()

Gets the future associated with the job, used to control the job.

Throws:

IllegalStateException - If the job was not started yet.

getJobStatus

@Nonnull
JobStatus getJobStatus()

Returns the status of this job.

cancel

default boolean cancel()

Attempts to cancel execution of this job. Upon cancellation the job future will be completed immediately as per the contract of Future.cancel(), however the job might still be running on the cluster. You can query the status via getJobStatus() to check for actual completion. Shorthand for job.getFuture().cancel()

join

default void join()

Waits for the job to complete and throws exception if job is completed with an error. Shorthand for job.getFuture().get()

execute

@Deprecated
default CompletableFuture<Void> execute()

Deprecated. Use getFuture() instead. This method will be removed in the next release.

Gets the future associated with the job.

Returns:

a future that can be inspected for job completion status and cancelled to prematurely end the job.