com.netflix.genie.core.jpa.entities

Class JobEntity

java.lang.Object

com.netflix.genie.core.jpa.entities.BaseEntity

com.netflix.genie.core.jpa.entities.CommonFieldsEntity

com.netflix.genie.core.jpa.entities.JobEntity

All Implemented Interfaces:

java.io.Serializable

@Entity
public class JobEntity
extends CommonFieldsEntity

Representation of the state of a Genie 3.0 job.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	DEFAULT_VERSION Used as default version when one not entered.
static java.lang.String	QUERY_GET_STATUS_BY_ID Query name to get job status.

Fields inherited from class com.netflix.genie.core.jpa.entities.CommonFieldsEntity

GENIE_ID_TAG_NAMESPACE, GENIE_NAME_TAG_NAMESPACE, GENIE_TAG_NAMESPACE, TAG_DELIMITER, TAG_DELIMITER_REGEX

Constructor Summary

Constructors

Constructor and Description
JobEntity() Default Constructor.

Method Summary

Modifier and Type	Method and Description
java.util.Optional<java.lang.String>	getArchiveLocation() Get location where logs are archived.
java.util.Optional<java.lang.String>	getClusterName() Gets the name of the cluster on which this job was run.
java.util.Optional<java.lang.String>	getCommandName() Gets the command name for this job.
Job	getDTO() Get a DTO representing this job.
java.util.Optional<java.util.Date>	getFinished() Gets the finish time for this job.
protected JobRequestEntity	getRequest() Get the job request for this job.
java.util.Optional<java.util.Date>	getStarted() Gets the start time for this job.
java.util.Optional<java.lang.String>	getStatusMsg() Gets the status message or this job.
void	setApplications(java.util.List<ApplicationEntity> applications) Set the applications used to run this job.
void	setCluster(ClusterEntity cluster) Set the cluster this job ran on.
protected void	setClusterName(java.lang.String clusterName) Sets the name of the cluster on which this job is run.
void	setCommand(CommandEntity command) Set the command used to run this job.
protected void	setCommandName(java.lang.String commandName) Set command Name with which this job is run.
void	setFinished(java.util.Date finished) Set the finishTime for the job.
void	setJobStatus(JobStatus jobStatus) Set job status, and update start/update/finish times, if needed.
void	setJobStatus(JobStatus newStatus, java.lang.String msg) Sets job status and human-readable message.
void	setRequest(JobRequestEntity request) Set the job request for this job.
void	setStarted(java.util.Date started) Set the startTime for the job.

Methods inherited from class com.netflix.genie.core.jpa.entities.CommonFieldsEntity

getDescription, getFinalTags, getTags, setTags

Methods inherited from class com.netflix.genie.core.jpa.entities.BaseEntity

getCreated, getEntityVersion, getId, getUpdated, onCreateBaseEntity, onUpdateBaseEntity, setCreated, setEntityVersion, setId, setUpdated

Methods inherited from class java.lang.Object

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

Field Detail

QUERY_GET_STATUS_BY_ID

public static final java.lang.String QUERY_GET_STATUS_BY_ID

Query name to get job status.

See Also:

Constant Field Values

DEFAULT_VERSION

protected static final java.lang.String DEFAULT_VERSION

Used as default version when one not entered.

See Also:

Constant Field Values

Constructor Detail

JobEntity

public JobEntity()

Default Constructor.

Method Detail

getClusterName

public java.util.Optional<java.lang.String> getClusterName()

Gets the name of the cluster on which this job was run.

Returns:

the cluster name

setClusterName

protected void setClusterName(java.lang.String clusterName)

Sets the name of the cluster on which this job is run.

Parameters:

clusterName - Name of the cluster on which job was executed.

getCommandName

public java.util.Optional<java.lang.String> getCommandName()

Gets the command name for this job.

Returns:

The command name

setCommandName

protected void setCommandName(java.lang.String commandName)

Set command Name with which this job is run.

Parameters:

commandName - Name of the command used to run the job

getStatusMsg

public java.util.Optional<java.lang.String> getStatusMsg()

Gets the status message or this job.

Returns:

statusMsg

getStarted

public java.util.Optional<java.util.Date> getStarted()

Gets the start time for this job.

Returns:

startTime as a java.util.Date or null if not yet started

setStarted

public void setStarted(@Nullable
                       java.util.Date started)

Set the startTime for the job.

Parameters:

started - epoch time as java.util.Date or null

getFinished

public java.util.Optional<java.util.Date> getFinished()

Gets the finish time for this job.

Returns:

finished. The job finish timestamp.

setFinished

public void setFinished(@Nullable
                        java.util.Date finished)

Set the finishTime for the job.

Parameters:

finished - The finished time.

getArchiveLocation

public java.util.Optional<java.lang.String> getArchiveLocation()

Get location where logs are archived.

Returns:

s3/hdfs location where logs are archived

setJobStatus

public void setJobStatus(@NotNull
                         JobStatus jobStatus)

Set job status, and update start/update/finish times, if needed.

Parameters:

jobStatus - status for job

setJobStatus

public void setJobStatus(JobStatus newStatus,
                         java.lang.String msg)

Sets job status and human-readable message.

Parameters:

newStatus - predefined status

msg - human-readable message

getRequest

protected JobRequestEntity getRequest()

Get the job request for this job.

Returns:

The original job request

setRequest

public void setRequest(JobRequestEntity request)

Set the job request for this job.

Parameters:

request - The job request. Not null.

setCluster

public void setCluster(ClusterEntity cluster)

Set the cluster this job ran on.

Parameters:

cluster - The cluster this job ran on

setCommand

public void setCommand(CommandEntity command)

Set the command used to run this job.

Parameters:

command - The command

setApplications

public void setApplications(java.util.List<ApplicationEntity> applications)

Set the applications used to run this job.

Parameters:

applications - The applications

getDTO

public Job getDTO()

Get a DTO representing this job.

Returns:

The read-only DTO.