public final class JobHandle extends Object implements Serializable
Modifier and Type | Method and Description |
---|---|
void |
delete()
Deletes the job.
|
List<String> |
getCompilerErrors()
Return any errors from trying to compile the job.
|
CompileStatus |
getCompilerStatus()
Returns the compiler status for the job.
|
InputHandle |
getDataset()
Returns the input dataset the job queried.
|
Date |
getDate()
Returns the
Date the job was last submitted. |
ExecutionStatus |
getExecutionStatus()
Returns the execution status for the job.
|
int |
getId()
Returns the job's unique identifier.
|
String |
getOutput()
Return the output for this job, if it finished successfully and has output.
|
boolean |
getPublic()
Get the job's public/private status.
|
URL |
getPublicUrl()
Get the job's public page URL.
|
String |
getSource()
Return the source query for this job.
|
URL |
getUrl()
Get the job's URL.
|
void |
refresh()
Refreshes the cached data for this job.
|
void |
resubmit()
Resubmits the job.
|
void |
setPublic(boolean isPublic)
Marks a job as public/private.
|
void |
stop()
Stops the job, if it is running.
|
String |
toString() |
public final int getId()
public final Date getDate()
Date
the job was last submitted.Date
public final InputHandle getDataset()
InputHandle
to the input dataset queriedpublic final CompileStatus getCompilerStatus()
public final ExecutionStatus getExecutionStatus()
public void stop() throws BoaException, NotLoggedInException
BoaException
- if the command fails for any reasonNotLoggedInException
- if not already logged in to the APIpublic void resubmit() throws BoaException, NotLoggedInException
BoaException
- if the command fails for any reasonNotLoggedInException
- if not already logged in to the APIpublic void delete() throws BoaException, NotLoggedInException
BoaException
- if the command fails for any reasonNotLoggedInException
- if not already logged in to the APIpublic void setPublic(boolean isPublic) throws BoaException, NotLoggedInException
isPublic
- should the job be public (true
) or private (false
)BoaException
- if the command fails for any reasonNotLoggedInException
- if not already logged in to the APIpublic boolean getPublic() throws BoaException, NotLoggedInException
true
if the job is public, else false
BoaException
- if the command fails for any reasonNotLoggedInException
- if not already logged in to the APIpublic URL getUrl() throws BoaException, NotLoggedInException
URL
to view the jobBoaException
- if the command fails for any reasonNotLoggedInException
- if not already logged in to the APIpublic URL getPublicUrl() throws BoaException, NotLoggedInException
getPublic()
to verify the URL is valid.URL
to view the job's public pageBoaException
- if the command fails for any reasonNotLoggedInException
- if not already logged in to the APIgetPublic()
public List<String> getCompilerErrors() throws BoaException, NotLoggedInException
List
of compiler error messagesBoaException
- if the command fails for any reasonNotLoggedInException
- if not already logged in to the APIpublic String getSource() throws BoaException, NotLoggedInException
BoaException
- if the command fails for any reasonNotLoggedInException
- if not already logged in to the APIpublic String getOutput() throws BoaException, NotLoggedInException
BoaException
- if the command fails for any reasonNotLoggedInException
- if not already logged in to the APIpublic void refresh() throws BoaException, NotLoggedInException
BoaException
- if the command fails for any reasonNotLoggedInException
- if not already logged in to the API