org.apache.hive.hcatalog.templeton.tool

Class JobState

java.lang.Object

org.apache.hive.hcatalog.templeton.tool.JobState

public class JobState
extends java.lang.Object

The persistent state of a job. The state is stored in one of the supported storage systems.

Constructor Summary

Constructors

Constructor and Description
JobState(java.lang.String id, Configuration conf)

Method Summary

Modifier and Type	Method and Description
void	addChild(java.lang.String jobid) Add a jobid to the list of children of this job.
void	close() For storage methods that require a connection, this is a hint that it's time to close the connection.
void	delete()
java.lang.String	getCallback() The url callback
java.lang.String	getChildId() The child id of TempletonControllerJob
java.util.List<JobState>	getChildren() Get a list of jobstates for jobs that are children of this job.
java.lang.String	getCompleteStatus() The status of a job once it is completed.
java.lang.Long	getCreated() When this job was created.
java.lang.Long	getExitValue() The system exit value of the job.
java.lang.String	getField(java.lang.String name)
java.lang.String	getId() This job id.
static java.util.List<java.lang.String>	getJobs(Configuration conf) Get an id for each currently existing job, which can be used to create a JobState object.
java.lang.Long	getLongField(java.lang.String name) Fetch an integer field from the store.
java.lang.Long	getNotifiedTime() The time when the callback was sent.
java.lang.String	getPercentComplete() The percent complete of a job
static TempletonStorage	getStorage(Configuration conf) Get an open instance of the selected storage class.
static TempletonStorage	getStorageInstance(Configuration conf) Get an instance of the selected storage class.
java.lang.String	getUser() The user who started this job.
java.util.Map<java.lang.String,java.lang.Object>	getUserArgs()
void	setCallback(java.lang.String callback)
void	setChildId(java.lang.String childid)
void	setChildren(java.util.List<JobState> children) Set the list of child jobs of this job
void	setChildren(java.lang.String jobids) Save a comma-separated list of jobids that are children of this job.
void	setCompleteStatus(java.lang.String complete)
void	setCreated(long created)
void	setExitValue(long exitValue)
void	setField(java.lang.String name, java.lang.String val) Store a String field from the store.
void	setLongField(java.lang.String name, long val) Store a long field.
void	setNotifiedTime(long notified)
void	setPercentComplete(java.lang.String percent)
void	setUser(java.lang.String user)
void	setUserArgs(java.util.Map<java.lang.String,java.lang.Object> userArgs)

Methods inherited from class java.lang.Object

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

Constructor Detail

JobState

public JobState(java.lang.String id,
                Configuration conf)
         throws java.io.IOException

Throws:

java.io.IOException

Method Detail

delete

public void delete()
            throws java.io.IOException

Throws:

java.io.IOException

getStorageInstance

public static TempletonStorage getStorageInstance(Configuration conf)

Get an instance of the selected storage class. Defaults to HDFS storage if none is specified.

getStorage

public static TempletonStorage getStorage(Configuration conf)
                                   throws java.io.IOException

Get an open instance of the selected storage class. Defaults to HDFS storage if none is specified.

Throws:

java.io.IOException

close

public void close()
           throws java.io.IOException

For storage methods that require a connection, this is a hint that it's time to close the connection.

Throws:

java.io.IOException

getId

public java.lang.String getId()

This job id.

getPercentComplete

public java.lang.String getPercentComplete()
                                    throws java.io.IOException

The percent complete of a job

Throws:

java.io.IOException

setPercentComplete

public void setPercentComplete(java.lang.String percent)
                        throws java.io.IOException

Throws:

java.io.IOException

getChildId

public java.lang.String getChildId()
                            throws java.io.IOException

The child id of TempletonControllerJob

Throws:

java.io.IOException

setChildId

public void setChildId(java.lang.String childid)
                throws java.io.IOException

Throws:

java.io.IOException

addChild

public void addChild(java.lang.String jobid)
              throws java.io.IOException

Add a jobid to the list of children of this job.

Parameters:

jobid -

Throws:

java.io.IOException

getChildren

public java.util.List<JobState> getChildren()
                                     throws java.io.IOException

Get a list of jobstates for jobs that are children of this job.

Throws:

java.io.IOException

setChildren

public void setChildren(java.lang.String jobids)
                 throws java.io.IOException

Save a comma-separated list of jobids that are children of this job.

Parameters:

jobids -

Throws:

java.io.IOException

setChildren

public void setChildren(java.util.List<JobState> children)
                 throws java.io.IOException

Set the list of child jobs of this job

Parameters:

children -

Throws:

java.io.IOException

getExitValue

public java.lang.Long getExitValue()
                            throws java.io.IOException

The system exit value of the job.

Throws:

java.io.IOException

setExitValue

public void setExitValue(long exitValue)
                  throws java.io.IOException

Throws:

java.io.IOException

getCreated

public java.lang.Long getCreated()
                          throws java.io.IOException

When this job was created.

Throws:

java.io.IOException

setCreated

public void setCreated(long created)
                throws java.io.IOException

Throws:

java.io.IOException

getUser

public java.lang.String getUser()
                         throws java.io.IOException

The user who started this job.

Throws:

java.io.IOException

setUser

public void setUser(java.lang.String user)
             throws java.io.IOException

Throws:

java.io.IOException

getUserArgs

public java.util.Map<java.lang.String,java.lang.Object> getUserArgs()
                                                             throws java.io.IOException

Throws:

java.io.IOException

setUserArgs

public void setUserArgs(java.util.Map<java.lang.String,java.lang.Object> userArgs)
                 throws java.io.IOException

Throws:

java.io.IOException

getCallback

public java.lang.String getCallback()
                             throws java.io.IOException

The url callback

Throws:

java.io.IOException

setCallback

public void setCallback(java.lang.String callback)
                 throws java.io.IOException

Throws:

java.io.IOException

getCompleteStatus

public java.lang.String getCompleteStatus()
                                   throws java.io.IOException

The status of a job once it is completed.

Throws:

java.io.IOException

setCompleteStatus

public void setCompleteStatus(java.lang.String complete)
                       throws java.io.IOException

Throws:

java.io.IOException

getNotifiedTime

public java.lang.Long getNotifiedTime()
                               throws java.io.IOException

The time when the callback was sent.

Throws:

java.io.IOException

setNotifiedTime

public void setNotifiedTime(long notified)
                     throws java.io.IOException

Throws:

java.io.IOException

getLongField

public java.lang.Long getLongField(java.lang.String name)
                            throws java.io.IOException

Fetch an integer field from the store.

Throws:

java.io.IOException

setField

public void setField(java.lang.String name,
                     java.lang.String val)
              throws java.io.IOException

Store a String field from the store.

Throws:

java.io.IOException

getField

public java.lang.String getField(java.lang.String name)
                          throws java.io.IOException

Throws:

java.io.IOException

setLongField

public void setLongField(java.lang.String name,
                         long val)
                  throws java.io.IOException

Store a long field.

Parameters:

name -

val -

Throws:

java.io.IOException

getJobs

public static java.util.List<java.lang.String> getJobs(Configuration conf)
                                                throws java.io.IOException

Get an id for each currently existing job, which can be used to create a JobState object.

Parameters:

conf -

Throws:

java.io.IOException