alluxio.client.job

Class RetryHandlingJobMasterClient

java.lang.Object

alluxio.AbstractClient

alluxio.AbstractMasterClient

alluxio.AbstractJobMasterClient

alluxio.client.job.RetryHandlingJobMasterClient

All Implemented Interfaces:

Client, JobMasterClient, Closeable, AutoCloseable

@ThreadSafe
public final class RetryHandlingJobMasterClient
extends AbstractJobMasterClient
implements JobMasterClient

A wrapper for the gRPC client to interact with the job service master, used by job service clients.

Nested Class Summary

Nested classes/interfaces inherited from class alluxio.AbstractClient

AbstractClient.RpcCallable<V>

Nested classes/interfaces inherited from interface alluxio.client.job.JobMasterClient

JobMasterClient.Factory

Field Summary

Fields inherited from class alluxio.AbstractJobMasterClient

mConfAddress

Fields inherited from class alluxio.AbstractClient

mChannel, mClosed, mConnected, mContext, mServerAddress, mServiceVersion, mVersionService

Constructor Summary

Constructors

Constructor and Description
RetryHandlingJobMasterClient(JobMasterClientContext conf) Creates a new job master client.

Method Summary

Modifier and Type	Method and Description
protected void	afterConnect() This method is called after the connection is made to the remote.
void	cancel(long jobId) Cancels the given job.
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.
protected ServiceType	getRemoteServiceType()
protected String	getServiceName()
protected long	getServiceVersion()
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 class alluxio.AbstractJobMasterClient

getConfAddress

Methods inherited from class alluxio.AbstractMasterClient

afterDisconnect, beforeConnect, queryGrpcServerAddress

Methods inherited from class alluxio.AbstractClient

beforeDisconnect, checkVersion, close, connect, connectWithRuntimeException, disconnect, getRemoteHostName, getRemoteServiceVersion, getRemoteSockAddress, isClosed, isConnected, retryRPC, retryRPC

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface alluxio.client.job.JobMasterClient

list

Methods inherited from interface alluxio.Client

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

Methods inherited from interface java.io.Closeable

close

Constructor Detail

RetryHandlingJobMasterClient

public RetryHandlingJobMasterClient(JobMasterClientContext conf)

Creates a new job master client.

Parameters:

conf - master client configuration

Method Detail

getRemoteServiceType

protected ServiceType getRemoteServiceType()

Specified by:

getRemoteServiceType in class AbstractClient

Returns:

the expected type of remote service

getServiceName

protected String getServiceName()

Specified by:

getServiceName in class AbstractClient

Returns:

a string representing the specific service

getServiceVersion

protected long getServiceVersion()

Specified by:

getServiceVersion in class AbstractClient

Returns:

the client service version

afterConnect

protected void afterConnect()
                     throws IOException

Description copied from class: AbstractClient

This method is called after the connection is made to the remote. Implementations should create internal state to finish the connection process.

Overrides:

afterConnect in class AbstractClient

Throws:

IOException

cancel

public void cancel(long jobId)
            throws IOException

Description copied from interface: JobMasterClient

Cancels the given job.

Specified by:

cancel in interface JobMasterClient

Parameters:

jobId - the job id

Throws:

IOException

getJobStatus

public JobInfo getJobStatus(long id)
                     throws IOException

Description copied from interface: JobMasterClient

Gets the status of the given job id.

Specified by:

getJobStatus in interface JobMasterClient

Parameters:

id - the job id

Returns:

the job information

Throws:

IOException

getJobStatusDetailed

public JobInfo getJobStatusDetailed(long id)
                             throws IOException

Description copied from interface: JobMasterClient

Gets detailed status of the given job id.

Specified by:

getJobStatusDetailed in interface JobMasterClient

Parameters:

id - the job id

Returns:

the detailed job information

Throws:

IOException

getJobServiceSummary

public JobServiceSummary getJobServiceSummary()
                                       throws IOException

Description copied from interface: JobMasterClient

Gets the job service summary.

Specified by:

getJobServiceSummary in interface JobMasterClient

Returns:

the job service summary

Throws:

IOException

list

public List<Long> list(ListAllPOptions option)
                throws IOException

Specified by:

list in interface JobMasterClient

Parameters:

option - list options

Returns:

the list of ids of all jobs

Throws:

IOException

listDetailed

public List<JobInfo> listDetailed()
                           throws IOException

Specified by:

listDetailed in interface JobMasterClient

Returns:

the list of all jobInfos

Throws:

IOException

run

public long run(JobConfig jobConfig)
         throws IOException

Description copied from interface: JobMasterClient

Starts a plan based on the given configuration.

Specified by:

run in interface JobMasterClient

Parameters:

jobConfig - the job configuration

Returns:

the plan id

Throws:

IOException

submit

public long submit(CmdConfig cmdConfig)
            throws IOException

Description copied from interface: JobMasterClient

Submit a Cmd Job based on the given configuration.

Specified by:

submit in interface JobMasterClient

Parameters:

cmdConfig - the Cmd job config

Returns:

the jobControlId

Throws:

IOException

getAllWorkerHealth

public List<JobWorkerHealth> getAllWorkerHealth()
                                         throws IOException

Description copied from interface: JobMasterClient

Gets all worker health.

Specified by:

getAllWorkerHealth in interface JobMasterClient

Returns:

list of all worker health information

Throws:

IOException

getCmdStatus

public Status getCmdStatus(long id)
                    throws IOException

Description copied from interface: JobMasterClient

Gets the status of the given command jobControlId.

Specified by:

getCmdStatus in interface JobMasterClient

Parameters:

id - the jobControl id

Returns:

the command status

Throws:

IOException

getCmdStatusDetailed

public CmdStatusBlock getCmdStatusDetailed(long id)
                                    throws IOException

Description copied from interface: JobMasterClient

Gets the detailed status of the given command jobControlId.

Specified by:

getCmdStatusDetailed in interface JobMasterClient

Parameters:

id - the jobControl id

Returns:

the detailed command status information

Throws:

IOException