Package com.github.workerframework.api

Class TrackingInfo

java.lang.Object

com.github.workerframework.api.TrackingInfo

public class TrackingInfo
extends Object

Holds fields used in tracking task messages, for Progress Reporting and Job Control.

Constructor Summary

Constructors

Constructor	Description
TrackingInfo()
TrackingInfo(TrackingInfo trackingInfo)
TrackingInfo(String jobTaskId, Date lastStatusCheckTime, long statusCheckIntervalMillis, String statusCheckUrl, String trackingPipe, String trackTo)

Method Summary

Modifier and Type	Method	Description
String	getJobId()	Extracts the job identifier from the tracking info's job task identifier.
String	getJobTaskId()
Date	getLastStatusCheckTime()
long	getStatusCheckIntervalMillis()
String	getStatusCheckUrl()
String	getTrackingPipe()
String	getTrackTo()
void	setJobTaskId(String jobTaskId)
void	setLastStatusCheckTime(Date lastStatusCheckTime)
void	setStatusCheckIntervalMillis(long statusCheckIntervalMillis)
void	setStatusCheckUrl(String statusCheckUrl)
void	setTrackingPipe(String trackingPipe)
void	setTrackTo(String trackTo)

Methods inherited from class java.lang.Object

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

Constructor Details

TrackingInfo

public TrackingInfo()

TrackingInfo

public TrackingInfo(String jobTaskId,
 Date lastStatusCheckTime,
 long statusCheckIntervalMillis,
 String statusCheckUrl,
 String trackingPipe,
 String trackTo)

TrackingInfo

public TrackingInfo(TrackingInfo trackingInfo)

Method Details

getJobTaskId

public String getJobTaskId()

setJobTaskId

public void setJobTaskId(String jobTaskId)

getLastStatusCheckTime

public Date getLastStatusCheckTime()

setLastStatusCheckTime

public void setLastStatusCheckTime(Date lastStatusCheckTime)

getStatusCheckIntervalMillis

public long getStatusCheckIntervalMillis()

setStatusCheckIntervalMillis

public void setStatusCheckIntervalMillis(long statusCheckIntervalMillis)

getStatusCheckUrl

public String getStatusCheckUrl()

setStatusCheckUrl

public void setStatusCheckUrl(String statusCheckUrl)

getTrackingPipe

public String getTrackingPipe()

setTrackingPipe

public void setTrackingPipe(String trackingPipe)

getTrackTo

public String getTrackTo()

setTrackTo

public void setTrackTo(String trackTo)

getJobId

public String getJobId()
                throws InvalidJobTaskIdException

Extracts the job identifier from the tracking info's job task identifier.

Returns:

the extracted job identifier

Throws:

InvalidJobTaskIdException