com.netflix.genie.core.services

Interface JobPersistenceService

All Known Implementing Classes:

JpaJobPersistenceServiceImpl

@Validated
public interface JobPersistenceService

Interfaces for providing persistence functions for jobs other than search.

Since:

3.0.0

Method Summary

Modifier and Type	Method and Description
void	createJob(JobRequest jobRequest, JobMetadata jobMetadata, Job job, JobExecution jobExecution) Save all the initial job fields in the data store.
long	deleteAllJobsCreatedBeforeDate(java.util.Date date) This method will delete all jobs whose created time is less than date.
void	setJobCompletionInformation(java.lang.String id, int exitCode, JobStatus status, java.lang.String statusMessage, java.lang.Long stdOutSize, java.lang.Long stdErrSize) Method to set all job completion information for a job execution.
void	setJobRunningInformation(java.lang.String id, int processId, long checkDelay, java.util.Date timeout) Update the job with information for the running job process.
void	updateJobStatus(java.lang.String id, JobStatus jobStatus, java.lang.String statusMsg) Update the status and status message of the job.
void	updateJobWithRuntimeEnvironment(java.lang.String jobId, java.lang.String clusterId, java.lang.String commandId, java.util.List<java.lang.String> applicationIds, int memory) Update the job with the various resources used to run the job including the cluster, command and applications.

Method Detail

createJob

void createJob(@NotNull
               JobRequest jobRequest,
               @NotNull
               JobMetadata jobMetadata,
               @NotNull
               Job job,
               @NotNull
               JobExecution jobExecution)
        throws GenieException

Save all the initial job fields in the data store.

Parameters:

jobRequest - the Job request object to save. Not null

jobMetadata - metadata about the job request. Not null

job - The Job object to create

jobExecution - The job execution object to create

Throws:

GenieException - if there is an error

updateJobWithRuntimeEnvironment

void updateJobWithRuntimeEnvironment(@NotBlank
                                     java.lang.String jobId,
                                     @NotBlank
                                     java.lang.String clusterId,
                                     @NotBlank
                                     java.lang.String commandId,
                                     @NotNull
                                     java.util.List<java.lang.String> applicationIds,
                                     @Min(value=1L)
                                     int memory)
                              throws GenieException

Update the job with the various resources used to run the job including the cluster, command and applications.

Parameters:

jobId - The id of the job to update

clusterId - The id of the cluster the job runs on

commandId - The id of the command the job runs with

applicationIds - The ids of the applications used to run the job

memory - The amount of memory (in MB) to run the job with

Throws:

GenieException - For any problems while updating

updateJobStatus

void updateJobStatus(@NotBlank(message="No job id entered. Unable to update.")
                     java.lang.String id,
                     @NotNull(message="Status cannot be null.")
                     JobStatus jobStatus,
                     @NotBlank(message="Status message cannot be empty.")
                     java.lang.String statusMsg)
              throws GenieException

Update the status and status message of the job.

Parameters:

id - The id of the job to update the status for.

jobStatus - The updated status of the job.

statusMsg - The updated status message of the job.

Throws:

GenieException - if there is an error

setJobRunningInformation

void setJobRunningInformation(@NotBlank
                              java.lang.String id,
                              @Min(value=0L,message="Must be no lower than zero")
                              int processId,
                              @Min(value=1L,message="Must be at least 1 millisecond, preferably much more")
                              long checkDelay,
                              @NotNull
                              java.util.Date timeout)
                       throws GenieException

Update the job with information for the running job process.

Parameters:

id - the id of the job to update the process id for

processId - The id of the process on the box for this job

checkDelay - The delay to check the process with

timeout - The date at which this job should timeout

Throws:

GenieException - if there is an error

setJobCompletionInformation

void setJobCompletionInformation(@NotBlank(message="No job id entered. Unable to update.")
                                 java.lang.String id,
                                 int exitCode,
                                 @NotNull(message="No job status entered. Unable to update")
                                 JobStatus status,
                                 @NotBlank(message="Status message can\'t be blank. Unable to update")
                                 java.lang.String statusMessage,
                                 @Nullable
                                 java.lang.Long stdOutSize,
                                 @Nullable
                                 java.lang.Long stdErrSize)
                          throws GenieException

Method to set all job completion information for a job execution.

Parameters:

id - the id of the job to update the exit code

exitCode - The exit code of the process

status - The final job status for the job

statusMessage - The final job status message

stdOutSize - The size (in bytes) of the standard out file or null if there isn't one

stdErrSize - The size (in bytes) of the standard error file or null if there isn't one

Throws:

GenieException - if there is an error

deleteAllJobsCreatedBeforeDate

long deleteAllJobsCreatedBeforeDate(@NotNull
                                    java.util.Date date)

This method will delete all jobs whose created time is less than date.

Parameters:

date - The date before which all jobs should be deleted

Returns:

the number of deleted jobs