alluxio.client.job

Interface JobMasterClient

All Superinterfaces:

AutoCloseable, Client, Closeable

All Known Implementing Classes:

RetryHandlingJobMasterClient

public interface JobMasterClient
extends Client

Interface for job service clients to communicate with the job master.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	JobMasterClient.Factory Factory for JobMasterClient.

Method Summary

Modifier and Type	Method and Description
void	cancel(long id) Cancels the given job.
List<JobMasterStatus>	getAllMasterStatus() Gets the status of all job masters in the cluster.
List<JobWorkerHealth>	getAllWorkerHealth() Gets all worker health.
Status	getCmdStatus(long id) Gets the status of the given command jobControlId.
CmdStatusBlock	getCmdStatusDetailed(long id) Gets the detailed status of the given command jobControlId.
JobServiceSummary	getJobServiceSummary() Gets the job service summary.
JobInfo	getJobStatus(long id) Gets the status of the given job id.
JobInfo	getJobStatusDetailed(long id) Gets detailed status of the given job id.
default List<Long>	list()
List<Long>	list(ListAllPOptions option)
List<JobInfo>	listDetailed()
long	run(JobConfig jobConfig) Starts a plan based on the given configuration.
long	submit(CmdConfig cmdConfig) Submit a Cmd Job based on the given configuration.

Methods inherited from interface alluxio.Client

connect, disconnect, getConfAddress, getRemoteHostName, getRemoteSockAddress, isClosed, isConnected

Methods inherited from interface java.io.Closeable

close

Method Detail

cancel

void cancel(long id)
     throws IOException

Cancels the given job.

Parameters:

id - the job id

Throws:

IOException

getJobStatus

JobInfo getJobStatus(long id)
              throws IOException

Gets the status of the given job id.

Parameters:

id - the job id

Returns:

the job information

Throws:

IOException

getJobStatusDetailed

JobInfo getJobStatusDetailed(long id)
                      throws IOException

Gets detailed status of the given job id.

Parameters:

id - the job id

Returns:

the detailed job information

Throws:

IOException

getJobServiceSummary

JobServiceSummary getJobServiceSummary()
                                throws IOException

Gets the job service summary.

Returns:

the job service summary

Throws:

IOException

list

default List<Long> list()
                 throws IOException

Returns:

list all job ids

Throws:

IOException

list

List<Long> list(ListAllPOptions option)
         throws IOException

Parameters:

option - list options

Returns:

the list of ids of all jobs

Throws:

IOException

listDetailed

List<JobInfo> listDetailed()
                    throws IOException

Returns:

the list of all jobInfos

Throws:

IOException

run

long run(JobConfig jobConfig)
  throws IOException

Starts a plan based on the given configuration.

Parameters:

jobConfig - the job configuration

Returns:

the plan id

Throws:

IOException

submit

long submit(CmdConfig cmdConfig)
     throws IOException

Submit a Cmd Job based on the given configuration.

Parameters:

cmdConfig - the Cmd job config

Returns:

the jobControlId

Throws:

IOException

getAllMasterStatus

List<JobMasterStatus> getAllMasterStatus()
                                  throws IOException

Gets the status of all job masters in the cluster.

Returns:

a list of status

Throws:

IOException

getCmdStatus

Status getCmdStatus(long id)
             throws IOException

Gets the status of the given command jobControlId.

Parameters:

id - the jobControl id

Returns:

the command status

Throws:

IOException

getCmdStatusDetailed

CmdStatusBlock getCmdStatusDetailed(long id)
                             throws IOException

Gets the detailed status of the given command jobControlId.

Parameters:

id - the jobControl id

Returns:

the detailed command status information

Throws:

IOException

getAllWorkerHealth

List<JobWorkerHealth> getAllWorkerHealth()
                                  throws IOException

Gets all worker health.

Returns:

list of all worker health information

Throws:

IOException