org.apache.samza.rest.proxy.job

Interface JobProxy

All Known Implementing Classes:

AbstractJobProxy, ScriptJobProxy, SimpleYarnJobProxy

public interface JobProxy

Job proxy is the primary abstraction used by the REST API to interact with jobs. Concrete implementations of this interface may vary in the APIs they use to discover, start, stop, and stat jobs, how to interact with the installed jobs on disk, etc.

Method Summary

Modifier and Type	Method and Description
java.util.List<Job>	getAllJobStatuses()
Job	getJobStatus(JobInstance jobInstance)
boolean	jobExists(JobInstance jobInstance)
void	start(JobInstance jobInstance) Starts the job instance specified by jobName and jobId.
void	stop(JobInstance jobInstance) Stops the job instance specified by jobName and jobId.

Method Detail

jobExists

boolean jobExists(JobInstance jobInstance)

Parameters:

jobInstance - the instance of the job

Returns:

true if the job exists and can be started, stopped, etc.

getAllJobStatuses

java.util.List<Job> getAllJobStatuses()
                               throws java.io.IOException,
                                      java.lang.InterruptedException

Returns:

a Job for each Samza job instance installed on this host.

Throws:

java.io.IOException - if there was a problem executing the command to get the status.

java.lang.InterruptedException - if the thread was interrupted while waiting for the status result.

getJobStatus

Job getJobStatus(JobInstance jobInstance)
          throws java.io.IOException,
                 java.lang.InterruptedException

Parameters:

jobInstance - the instance of the job for which the status is needed.

Returns:

a Job containing the status for the job specified by jobName and jobId.

Throws:

java.io.IOException - if there was a problem executing the command to get the status.

java.lang.InterruptedException - if the thread was interrupted while waiting for the status result.

start

void start(JobInstance jobInstance)
    throws java.lang.Exception

Starts the job instance specified by jobName and jobId. When this method returns, the status of the job should be JobStatus.STARTING or JobStatus.STARTED depending on the implementation.

Parameters:

jobInstance - the instance of the job to start.

Throws:

java.lang.Exception - if the job could not be successfully started.

stop

void stop(JobInstance jobInstance)
   throws java.lang.Exception

Stops the job instance specified by jobName and jobId. When this method returns, the status of the job should be JobStatus.STOPPED.

Parameters:

jobInstance - the instance of the job to stop.

Throws:

java.lang.Exception - if the job could not be successfully stopped.