com.netflix.genie.core.jpa.entities

Class JobEntity

java.lang.Object

com.netflix.genie.core.jpa.entities.IdEntity

com.netflix.genie.core.jpa.entities.AuditEntity

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

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

All Implemented Interfaces:

AuditProjection, BaseProjection, IdProjection, JobApplicationsProjection, JobClusterProjection, JobCommandProjection, JobCommonFieldsProjection, JobExecutionProjection, JobHostNameProjection, JobMetadataProjection, JobProjection, JobRequestProjection, JobSearchProjection, JobStatusProjection, SetupFileProjection, java.io.Serializable

@Entity
public class JobEntity
extends BaseEntity
implements JobProjection, JobRequestProjection, JobMetadataProjection, JobExecutionProjection, JobApplicationsProjection, JobClusterProjection, JobCommandProjection, JobSearchProjection

Representation of the state of a Genie job.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
JobEntity() Default Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
java.util.Optional<java.lang.String>	getArchiveLocation() Get location where logs are archived.
java.util.Optional<java.lang.Long>	getCheckDelay() Get the amount of time (in milliseconds) to delay the check for the job status.
java.util.Optional<java.lang.String>	getClientHost() Get the client host.
java.util.Optional<ClusterEntity>	getCluster() Get the cluster that is running or did run this job.
java.util.Optional<java.lang.String>	getClusterName() Gets the name of the cluster on which this job was run.
java.util.Optional<CommandEntity>	getCommand() Get the command that is executing this job.
java.util.Optional<CriterionEntity>	getCommandCriterion() Get the command criterion if one exists.
java.util.Optional<java.lang.String>	getCommandName() Gets the command name for this job.
java.util.Optional<java.lang.Integer>	getCpuRequested() Get the number of CPU's requested to run this job.
java.util.Optional<java.lang.String>	getEmail() Get the email of the user associated with this job if they desire an email notification at completion of the job.
java.util.Optional<java.lang.Integer>	getExitCode() Get the exit code from the process that ran the job.
java.util.Optional<java.util.Date>	getFinished() Gets the finish time for this job.
java.util.Optional<java.lang.String>	getGenieUserGroup() Get the user group for this job.
java.util.Optional<java.lang.String>	getGrouping() Get the grouping this job is a part of.
java.util.Optional<java.lang.String>	getGroupingInstance() Get the instance identifier of a grouping.
java.util.Optional<java.lang.Integer>	getMemoryRequested() Get the memory requested to run this job with.
java.util.Optional<java.lang.Integer>	getMemoryUsed() Get the amount of memory (in MB) that this job is/was run with.
java.util.Optional<java.lang.Integer>	getNumAttachments() Get the number of attachments.
java.util.Optional<java.lang.Integer>	getProcessId() Get the process id of the 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.
java.util.Optional<java.lang.Long>	getStdErrSize() Get the size of standard error for this job.
java.util.Optional<java.lang.Long>	getStdOutSize() Get the size of standard out for this job.
java.util.Optional<java.util.Date>	getTimeout() Get the date this job will be killed due to exceeding its set timeout duration.
java.util.Optional<java.lang.Integer>	getTimeoutRequested() Get the timeout (in seconds) requested by the user for this job.
java.util.Optional<java.lang.Long>	getTotalSizeOfAttachments() Get the total size of the attachments.
java.util.Optional<java.lang.String>	getUserAgent() Get the user agent.
int	hashCode()
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.
void	setClusterCriteria(java.util.List<CriterionEntity> clusterCriteria) Set the cluster criteria set for this job.
void	setCommand(CommandEntity command) Set the command used to run this job.
void	setCommandArgs(java.util.List<java.lang.String> commandArgs) Set the command arguments to use with this job.
void	setCommandCriterion(CriterionEntity commandCriterion) Set the command criterion.
void	setConfigs(java.util.Set<FileEntity> configs) Set all the files associated as configuration files for this job.
void	setDependencies(java.util.Set<FileEntity> dependencies) Set all the files associated as dependency files for this job.
void	setFinished(java.util.Date finished) Set the finishTime for the job.
void	setStarted(java.util.Date started) Set the startTime for the job.
void	setStdErrSize(java.lang.Long stdErrSize) Set the total size in bytes of the std err file for this job.
void	setStdOutSize(java.lang.Long stdOutSize) Set the total size in bytes of the std out file for this job.
void	setTags(java.util.Set<TagEntity> tags) Set all the tags associated to this job.
void	setTimeout(java.util.Date timeout) Set the date this job will be killed due to exceeding its set timeout duration.

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

getDescription, getMetadata, getSetupFile, setDescription, setMetadata, setSetupFile

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

getCreated, getUpdated, onCreateBaseEntity, onUpdateBaseEntity

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.netflix.genie.core.jpa.entities.projections.JobProjection

getApplications

Methods inherited from interface com.netflix.genie.core.jpa.entities.projections.JobRequestProjection

getApplicationsRequested, getClusterCriteria, getConfigs, getDependencies, isDisableLogArchival

Methods inherited from interface com.netflix.genie.core.jpa.entities.projections.JobCommonFieldsProjection

getCommandArgs, getTags

Methods inherited from interface com.netflix.genie.core.jpa.entities.projections.BaseProjection

getDescription, getMetadata, getName, getUniqueId, getUser, getVersion

Methods inherited from interface com.netflix.genie.core.jpa.entities.projections.AuditProjection

getCreated, getUpdated

Methods inherited from interface com.netflix.genie.core.jpa.entities.projections.IdProjection

getId

Methods inherited from interface com.netflix.genie.core.jpa.entities.projections.SetupFileProjection

getSetupFile

Methods inherited from interface com.netflix.genie.core.jpa.entities.projections.JobMetadataProjection

getUniqueId

Methods inherited from interface com.netflix.genie.core.jpa.entities.projections.JobExecutionProjection

getUniqueId

Methods inherited from interface com.netflix.genie.core.jpa.entities.projections.JobHostNameProjection

getHostName

Methods inherited from interface com.netflix.genie.core.jpa.entities.projections.JobApplicationsProjection

getApplications

Methods inherited from interface com.netflix.genie.core.jpa.entities.projections.JobSearchProjection

getName, getUniqueId, getUser

Methods inherited from interface com.netflix.genie.core.jpa.entities.projections.JobStatusProjection

getStatus

Constructor Detail

JobEntity

public JobEntity()

Default Constructor.

Method Detail

getGenieUserGroup

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

Get the user group for this job.

Specified by:

getGenieUserGroup in interface JobRequestProjection

Returns:

the user group

getCommandCriterion

public java.util.Optional<CriterionEntity> getCommandCriterion()

Get the command criterion if one exists.

Specified by:

getCommandCriterion in interface JobRequestProjection

Returns:

The command criterion if one exists

getEmail

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

Get the email of the user associated with this job if they desire an email notification at completion of the job.

Specified by:

getEmail in interface JobRequestProjection

Returns:

The email

getCpuRequested

public java.util.Optional<java.lang.Integer> getCpuRequested()

Get the number of CPU's requested to run this job.

Specified by:

getCpuRequested in interface JobRequestProjection

Returns:

The number of CPU's as an Optional

getMemoryRequested

public java.util.Optional<java.lang.Integer> getMemoryRequested()

Get the memory requested to run this job with.

Specified by:

getMemoryRequested in interface JobRequestProjection

Returns:

The amount of memory the user requested for this job in MB as an Optional

getTimeoutRequested

public java.util.Optional<java.lang.Integer> getTimeoutRequested()

Get the timeout (in seconds) requested by the user for this job.

Specified by:

getTimeoutRequested in interface JobRequestProjection

Returns:

The number of seconds before a timeout as an Optional

setCommandCriterion

public void setCommandCriterion(@Nullable
                                CriterionEntity commandCriterion)

Set the command criterion.

Parameters:

commandCriterion - The criterion. Null clears reference.

getGrouping

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

Get the grouping this job is a part of. e.g. scheduler job name for job run many times

Specified by:

getGrouping in interface JobCommonFieldsProjection

Returns:

The grouping

getGroupingInstance

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

Get the instance identifier of a grouping. e.g. the run id of a given scheduled job

Specified by:

getGroupingInstance in interface JobCommonFieldsProjection

Returns:

The grouping instance

getClientHost

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

Get the client host.

Specified by:

getClientHost in interface JobMetadataProjection

Returns:

Optional of the client host

getUserAgent

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

Get the user agent.

Specified by:

getUserAgent in interface JobMetadataProjection

Returns:

Optional of the user agent

getNumAttachments

public java.util.Optional<java.lang.Integer> getNumAttachments()

Get the number of attachments.

Specified by:

getNumAttachments in interface JobMetadataProjection

Returns:

The number of attachments as an optional

getTotalSizeOfAttachments

public java.util.Optional<java.lang.Long> getTotalSizeOfAttachments()

Get the total size of the attachments.

Specified by:

getTotalSizeOfAttachments in interface JobMetadataProjection

Returns:

The total size of attachments as an optional

getStdOutSize

public java.util.Optional<java.lang.Long> getStdOutSize()

Get the size of standard out for this job.

Specified by:

getStdOutSize in interface JobMetadataProjection

Returns:

The size (in bytes) of this jobs standard out file as Optional

getStdErrSize

public java.util.Optional<java.lang.Long> getStdErrSize()

Get the size of standard error for this job.

Specified by:

getStdErrSize in interface JobMetadataProjection

Returns:

The size (in bytes) of this jobs standard error file as Optional

setStdErrSize

public void setStdErrSize(@Nullable
                          java.lang.Long stdErrSize)

Set the total size in bytes of the std err file for this job.

Parameters:

stdErrSize - The size. Null empties database field

setStdOutSize

public void setStdOutSize(@Nullable
                          java.lang.Long stdOutSize)

Set the total size in bytes of the std out file for this job.

Parameters:

stdOutSize - The size. Null empties database field

getStatusMsg

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

Gets the status message or this job.

Specified by:

getStatusMsg in interface JobProjection

Returns:

statusMsg

getStarted

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

Gets the start time for this job.

Specified by:

getStarted in interface JobProjection

Specified by:

getStarted in interface JobSearchProjection

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.

Specified by:

getFinished in interface JobProjection

Specified by:

getFinished in interface JobSearchProjection

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.

Specified by:

getArchiveLocation in interface JobProjection

Returns:

Location where logs are archived

getClusterName

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

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

Specified by:

getClusterName in interface JobProjection

Specified by:

getClusterName in interface JobSearchProjection

Returns:

the cluster name

getCommandName

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

Gets the command name for this job.

Specified by:

getCommandName in interface JobProjection

Specified by:

getCommandName in interface JobSearchProjection

Returns:

The command name

getProcessId

public java.util.Optional<java.lang.Integer> getProcessId()

Get the process id of the job.

Specified by:

getProcessId in interface JobExecutionProjection

Returns:

the process id

getCheckDelay

public java.util.Optional<java.lang.Long> getCheckDelay()

Get the amount of time (in milliseconds) to delay the check for the job status.

Specified by:

getCheckDelay in interface JobExecutionProjection

Returns:

Could be null so return optional of the Long

getExitCode

public java.util.Optional<java.lang.Integer> getExitCode()

Get the exit code from the process that ran the job.

Specified by:

getExitCode in interface JobExecutionProjection

Returns:

The exit code or -1 if the job hasn't finished yet

getMemoryUsed

public java.util.Optional<java.lang.Integer> getMemoryUsed()

Get the amount of memory (in MB) that this job is/was run with.

Specified by:

getMemoryUsed in interface JobExecutionProjection

Returns:

The memory as an optional as it could be null

getTimeout

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

Get the date this job will be killed due to exceeding its set timeout duration.

Specified by:

getTimeout in interface JobExecutionProjection

Returns:

The timeout date

setTimeout

public void setTimeout(@Nullable
                       java.util.Date timeout)

Set the date this job will be killed due to exceeding its set timeout duration.

Parameters:

timeout - The new timeout

setCommandArgs

public void setCommandArgs(@Nullable
                           java.util.List<java.lang.String> commandArgs)

Set the command arguments to use with this job.

Parameters:

commandArgs - The command arguments to use

setConfigs

public void setConfigs(@Nullable
                       java.util.Set<FileEntity> configs)

Set all the files associated as configuration files for this job.

Parameters:

configs - The configuration files to set

setDependencies

public void setDependencies(@Nullable
                            java.util.Set<FileEntity> dependencies)

Set all the files associated as dependency files for this job.

Parameters:

dependencies - The dependency files to set

setTags

public void setTags(@Nullable
                    java.util.Set<TagEntity> tags)

Set all the tags associated to this job.

Parameters:

tags - The tags to set

getCluster

public java.util.Optional<ClusterEntity> getCluster()

Get the cluster that is running or did run this job.

Specified by:

getCluster in interface JobClusterProjection

Returns:

The cluster or empty Optional if it hasn't been set

setCluster

public void setCluster(@Nullable
                       ClusterEntity cluster)

Set the cluster this job ran on.

Parameters:

cluster - The cluster this job ran on

getCommand

public java.util.Optional<CommandEntity> getCommand()

Get the command that is executing this job.

Specified by:

getCommand in interface JobCommandProjection

Returns:

The command or empty Optional if one wasn't set yet

setCommand

public void setCommand(@Nullable
                       CommandEntity command)

Set the command used to run this job.

Parameters:

command - The command

setApplications

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

Set the applications used to run this job.

Parameters:

applications - The applications

setClusterCriteria

public void setClusterCriteria(@Nullable
                               java.util.List<CriterionEntity> clusterCriteria)

Set the cluster criteria set for this job.

Parameters:

clusterCriteria - The cluster criteria in priority order

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class AuditEntity

hashCode

public int hashCode()

Overrides:

hashCode in class AuditEntity