org.apache.samza.job

Interface StreamJob

public interface StreamJob

A StreamJob runs Samza StreamTasks in its specific environment. Users generally do not need to implement a StreamJob themselves, rather it is a framework-level interface meant for those extending Samza itself. This class, and its accompanying factory, allow Samza to run on other service providers besides YARN and LocalJob, such as Mesos or Sun Grid Engine.

Method Summary

Modifier and Type	Method and Description
ApplicationStatus	getStatus() Get current ApplicationStatus of the job
StreamJob	kill() Kill this job immediately.
StreamJob	submit() Submit this job to be run.
ApplicationStatus	waitForFinish(long timeoutMs) Block on this job until either it finishes or reaches its timeout value
ApplicationStatus	waitForStatus(ApplicationStatus status, long timeoutMs) Block on this job until either it transitions to the specified status or reaches it timeout value

Method Detail

submit

StreamJob submit()

Submit this job to be run.

Returns:

An instance of this job after it has been submitted.

kill

StreamJob kill()

Kill this job immediately.

Returns:

An instance of this job after it has been killed.

waitForFinish

ApplicationStatus waitForFinish(long timeoutMs)

Block on this job until either it finishes or reaches its timeout value

Parameters:

timeoutMs - How many milliseconds to wait before returning, assuming the job has not yet finished

Returns:

ApplicationStatus of the job after finishing or timing out

waitForStatus

ApplicationStatus waitForStatus(ApplicationStatus status,
                                long timeoutMs)

Block on this job until either it transitions to the specified status or reaches it timeout value

Parameters:

status - Target ApplicationStatus to wait upon

timeoutMs - How many milliseconds to wait before returning, assuming the job has not transitioned to the specified value

Returns:

ApplicationStatus of the job after finishing or reaching target state

getStatus

ApplicationStatus getStatus()

Get current ApplicationStatus of the job

Returns:

Current job status