com.netflix.genie.web.jpa.entities

Class JobEntity

java.lang.Object

com.netflix.genie.web.jpa.entities.IdEntity

com.netflix.genie.web.jpa.entities.AuditEntity

com.netflix.genie.web.jpa.entities.UniqueIdEntity

com.netflix.genie.web.jpa.entities.BaseEntity

com.netflix.genie.web.jpa.entities.JobEntity

All Implemented Interfaces:

AgentHostnameProjection, AuditProjection, BaseProjection, IdProjection, JobApplicationsProjection, JobArchiveLocationProjection, JobClusterProjection, JobCommandProjection, JobCommonFieldsProjection, JobExecutionProjection, JobMetadataProjection, JobProjection, JobRequestProjection, JobSearchProjection, JobStatusProjection, SetupFileProjection, UniqueIdProjection, IsV4JobProjection, JobSpecificationProjection, V4JobRequestProjection, java.io.Serializable

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

A row in jobs table.

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>	getAgentHostname() Get the host name where the agent ran or is running the job.
java.util.Optional<java.lang.Integer>	getAgentPid() Get the pid of the agent that claimed this job.
java.util.Optional<java.lang.String>	getAgentVersion() Get the version of the agent that claimed this job.
java.util.Optional<java.lang.String>	getArchiveLocation() Get the location where the job was 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<ClusterEntity>	getCluster() Get the cluster that ran or is currently running a given job.
java.util.Optional<java.lang.String>	getClusterName() Get the name of the cluster that is running or did run this job.
java.util.Optional<CommandEntity>	getCommand() Get the command that ran or is currently running a given job.
java.util.Optional<java.lang.String>	getCommandName() Get the name of the command that is executing 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.time.Instant>	getFinished() Get when the job was finished.
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.String>	getJobDirectoryLocation() Get the job directory location the agent should use.
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.lang.String>	getRequestAgentClientHostname() Get the hostname of the agent that requested this job be run if there was one.
java.util.Optional<java.lang.Integer>	getRequestAgentClientPid() Get the PID of the agent that requested this job be run if there was one.
java.util.Optional<java.lang.String>	getRequestAgentClientVersion() Get the version of the agent that requested this job be run if there was one.
java.util.Optional<java.lang.String>	getRequestApiClientHostname() Get the request api client hostname.
java.util.Optional<java.lang.String>	getRequestApiClientUserAgent() Get the user agent.
java.util.Optional<java.lang.String>	getRequestedAgentConfigExt() Get the extension configuration of a job agent configuration.
java.util.Optional<java.lang.String>	getRequestedAgentEnvironmentExt() Get the extension configuration of a job agent environment.
java.util.Optional<java.lang.String>	getRequestedArchiveLocationPrefix() Get the archive location prefix uri for a job.
java.util.Optional<java.lang.Integer>	getRequestedCpu() Get the number of CPU's requested to run this job.
java.util.Optional<java.lang.String>	getRequestedJobDirectoryLocation() Get the requested directory on disk where the Genie job working directory should be placed if a user asked to override the default.
java.util.Optional<java.lang.Integer>	getRequestedMemory() Get the memory requested to run this job with.
java.util.Optional<java.lang.Integer>	getRequestedTimeout() Get the timeout (in seconds) requested by the user for this job.
java.util.Optional<java.time.Instant>	getStarted() Get when the job was started.
java.util.Optional<java.lang.String>	getStatusMsg() Get the current status message of the 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.time.Instant>	getTimeout() Get the date this job will be killed due to exceeding its set timeout duration.
java.util.Optional<java.lang.Long>	getTotalSizeOfAttachments() Get the total size of the attachments.
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	setEnvironmentVariables(java.util.Map<java.lang.String,java.lang.String> environmentVariables) Set the environment variables for the job.
void	setFinished(java.time.Instant finished) Set the finishTime for the job.
void	setRequestedEnvironmentVariables(java.util.Map<java.lang.String,java.lang.String> requestedEnvironmentVariables) Set the requested environment variables.
void	setStarted(java.time.Instant started) Set the start time 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.time.Instant timeout) Set the date this job will be killed due to exceeding its set timeout duration.

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

getDescription, getMetadata, getSetupFile, setDescription, setMetadata, setSetupFile

Methods inherited from class com.netflix.genie.web.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.web.jpa.entities.projections.JobProjection

getApplications

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

getClusterCriteria, getCommandCriterion, getConfigs, getDependencies, getRequestedApplications, isArchivingDisabled

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

getCommandArgs, getTags

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

getDescription, getMetadata, getName, getUser, getVersion

Methods inherited from interface com.netflix.genie.web.jpa.entities.projections.UniqueIdProjection

getUniqueId

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

getCreated, getUpdated

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

getId

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

getSetupFile

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

getUniqueId

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

getUniqueId

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

getApplications

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

getName, getUniqueId, getUser

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

getStatus

Methods inherited from interface com.netflix.genie.web.jpa.entities.projections.v4.V4JobRequestProjection

getClusterCriteria, getCommandArgs, getCommandCriterion, getConfigs, getDependencies, getDescription, getMetadata, getName, getRequestedApplications, getRequestedEnvironmentVariables, getSetupFile, getTags, getUniqueId, getUser, getVersion, isArchivingDisabled, isInteractive, isRequestedId

Methods inherited from interface com.netflix.genie.web.jpa.entities.projections.v4.JobSpecificationProjection

getApplications, getCommandArgs, getConfigs, getDependencies, getEnvironmentVariables, getSetupFile, isInteractive, isResolved

Methods inherited from interface com.netflix.genie.web.jpa.entities.projections.v4.IsV4JobProjection

isV4

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

Specified by:

getGenieUserGroup in interface V4JobRequestProjection

Returns:

the user group

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

Specified by:

getEmail in interface V4JobRequestProjection

Returns:

The email

getRequestedCpu

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

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

Specified by:

getRequestedCpu in interface JobRequestProjection

Specified by:

getRequestedCpu in interface V4JobRequestProjection

Returns:

The number of CPU's as an Optional

getRequestedMemory

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

Get the memory requested to run this job with.

Specified by:

getRequestedMemory in interface JobRequestProjection

Specified by:

getRequestedMemory in interface V4JobRequestProjection

Returns:

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

getRequestedTimeout

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

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

Specified by:

getRequestedTimeout in interface JobRequestProjection

Specified by:

getRequestedTimeout in interface V4JobRequestProjection

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

Specified by:

getGrouping in interface V4JobRequestProjection

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

Specified by:

getGroupingInstance in interface V4JobRequestProjection

Returns:

The grouping instance

getRequestApiClientHostname

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

Get the request api client hostname.

Specified by:

getRequestApiClientHostname in interface JobMetadataProjection

Returns:

Optional of the client host

getRequestApiClientUserAgent

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

Get the user agent.

Specified by:

getRequestApiClientUserAgent 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

getRequestAgentClientHostname

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

Get the hostname of the agent that requested this job be run if there was one.

Returns:

The hostname wrapped in an Optional

getRequestAgentClientVersion

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

Get the version of the agent that requested this job be run if there was one.

Returns:

The version wrapped in an Optional

getRequestAgentClientPid

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

Get the PID of the agent that requested this job be run if there was one.

Returns:

The PID wrapped in an Optional

getStatusMsg

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

Get the current status message of the job.

Specified by:

getStatusMsg in interface JobProjection

Returns:

The status message

getStarted

public java.util.Optional<java.time.Instant> getStarted()

Get when the job was started.

Specified by:

getStarted in interface JobProjection

Specified by:

getStarted in interface JobSearchProjection

Returns:

The start date

setStarted

public void setStarted(@Nullable
                       java.time.Instant started)

Set the start time for the job.

Parameters:

started - The started time.

getFinished

public java.util.Optional<java.time.Instant> getFinished()

Get when the job was finished.

Specified by:

getFinished in interface JobProjection

Specified by:

getFinished in interface JobSearchProjection

Returns:

The finish date

setFinished

public void setFinished(@Nullable
                        java.time.Instant finished)

Set the finishTime for the job.

Parameters:

finished - The finished time.

getClusterName

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

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

Specified by:

getClusterName in interface JobProjection

Specified by:

getClusterName in interface JobSearchProjection

Returns:

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

getCommandName

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

Get the name of the command that is executing this job.

Specified by:

getCommandName in interface JobProjection

Specified by:

getCommandName in interface JobSearchProjection

Returns:

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

getArchiveLocation

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

Get the location where the job was archived.

Specified by:

getArchiveLocation in interface JobArchiveLocationProjection

Returns:

The archive location

getAgentHostname

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

Get the host name where the agent ran or is running the job.

Specified by:

getAgentHostname in interface AgentHostnameProjection

Returns:

The host name where the job agent is running or was run wrapped in an Optional

getAgentVersion

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

Get the version of the agent that claimed this job.

Returns:

The version wrapped in an Optional in case it wasn't set yet in which case it will be Optional.empty()

getAgentPid

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

Get the pid of the agent that claimed this job.

Returns:

The pid wrapped in an Optional in case it wasn't set yet in which case it will be Optional.empty()

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.time.Instant> 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.time.Instant 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

setRequestedEnvironmentVariables

public void setRequestedEnvironmentVariables(@Nullable
                                             java.util.Map<java.lang.String,java.lang.String> requestedEnvironmentVariables)

Set the requested environment variables.

Parameters:

requestedEnvironmentVariables - The environment variables the user requested be added to the job runtime

setEnvironmentVariables

public void setEnvironmentVariables(@Nullable
                                    java.util.Map<java.lang.String,java.lang.String> environmentVariables)

Set the environment variables for the job.

Parameters:

environmentVariables - The final set of environment variables that were set in the job runtime

getRequestedJobDirectoryLocation

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

Get the requested directory on disk where the Genie job working directory should be placed if a user asked to override the default.

Specified by:

getRequestedJobDirectoryLocation in interface V4JobRequestProjection

Returns:

The requested job directory location wrapped in an Optional

getRequestedAgentEnvironmentExt

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

Get the extension configuration of a job agent environment.

Specified by:

getRequestedAgentEnvironmentExt in interface V4JobRequestProjection

Returns:

The extension configuration (as valid JSON string) if it exists wrapped in an Optional

getRequestedAgentConfigExt

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

Get the extension configuration of a job agent configuration.

Specified by:

getRequestedAgentConfigExt in interface V4JobRequestProjection

Returns:

The extension configuration (as valid JSON string) if it exists wrapped in an Optional

getRequestedArchiveLocationPrefix

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

Get the archive location prefix uri for a job.

Specified by:

getRequestedArchiveLocationPrefix in interface V4JobRequestProjection

Returns:

archive location prefix uri for a job wrapped in a Optional

getJobDirectoryLocation

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

Get the job directory location the agent should use.

Specified by:

getJobDirectoryLocation in interface JobSpecificationProjection

Returns:

The job directory location if its been set wrapped in an Optional

getCluster

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

Get the cluster that ran or is currently running a given job.

Specified by:

getCluster in interface JobClusterProjection

Specified by:

getCluster in interface JobSpecificationProjection

Returns:

The cluster entity

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 ran or is currently running a given job.

Specified by:

getCommand in interface JobCommandProjection

Specified by:

getCommand in interface JobSpecificationProjection

Returns:

The command entity

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 BaseEntity

hashCode

public int hashCode()

Overrides:

hashCode in class BaseEntity