com.hazelcast.jet

Interface LightJob

All Known Subinterfaces:

Job

public interface LightJob

A handle to a submitted job. See JetInstance.newLightJob(Pipeline).

Method Summary

Modifier and Type	Method and Description
void	cancel() Makes a request to cancel this job and returns.
CompletableFuture<Void>	getFuture() Gets the future associated with the job.
long	getId() Returns the ID of this job.
default String	getIdString() Returns the string representation of this job's ID.
default void	join() Waits for the job to complete and throws an exception if the job completes with an error.

Method Detail

getId

long getId()

Returns the ID of this job.

getIdString

@Nonnull
default String getIdString()

Returns the string representation of this job's ID.

join

default void join()

Waits for the job to complete and throws an exception if the job completes with an error. Never returns for streaming (unbounded) jobs, unless they fail or are cancelled. In rare cases it can happen that after this method returns, the job is not fully cleaned up.

Shorthand for job.getFuture().join().

Throws:

CancellationException - if the job was cancelled

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

void cancel()

Makes a request to cancel this job and returns. The job will complete after its execution has stopped on all the nodes.

After cancellation, join() will throw a CancellationException.