com.hazelcast.jet

Interface Job

public interface Job

A Jet computation job created from a DAG or Pipeline. Once submitted, Jet starts executing the job automatically.

Method Summary

Modifier and Type	Method and Description
boolean	cancel() Attempts to cancel execution of this job.
JobConfig	getConfig() Returns the configuration this job was submitted with.
CompletableFuture<Void>	getFuture() Gets the future associated with the job.
long	getId() Returns the ID of this job.
default String	getName() Returns the name of this job or null if no name was supplied.
JobStatus	getStatus() Returns the current status of this job.
long	getSubmissionTime() Returns the time when the job was submitted to the cluster.
default void	join() Waits for the job to complete and throws exception if job is completed with an error.
boolean	restart() Cancels the current execution if the job is currently running and schedules a new execution with the current member list of the Jet cluster

Method Detail

getId

long getId()

Returns the ID of this job.

Throws:

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

getConfig

@Nonnull
JobConfig getConfig()

Returns the configuration this job was submitted with. Changes made to the returned config object will not have any affect.

getName

@Nullable
default String getName()

Returns the name of this job or null if no name was supplied.

Jobs can be named through JobConfig.setName(String) prior to submission.

getSubmissionTime

long getSubmissionTime()

Returns the time when the job was submitted to the cluster.

getStatus

@Nonnull
JobStatus getStatus()

Returns the current status of this job.

getFuture

@Nonnull
CompletableFuture<Void> getFuture()

Gets the future associated with the job. The returned future is not cancellable. To cancel the job, the cancel() method should be used.

Throws:

IllegalStateException - if the job has not started yet.

cancel

boolean cancel()

Attempts to cancel execution of this job. The job will be completed after the job has been stopped on all the nodes. Starting from version 0.6, job.getFuture().cancel() fails with an exception.

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()

restart

boolean restart()

Cancels the current execution if the job is currently running and schedules a new execution with the current member list of the Jet cluster

Returns:

true if the current execution of the job is cancelled

Throws:

IllegalStateException - if the job has been already completed