Class defaultAbstract

constructor

• new default(job): default

• constructor *

  Parameters

  • job: Job

  Returns default

connector

envParam

envParamDefault

envParamValidators

hpc

id

initRetry

isEnd

isInit

isPaused

job

jobOnHpc

maintainThresholdInHours

maintainerConfig

slurm

validator

dumpEvents

• dumpEvents(): event[]

• Clear all events in this.events

  Returns event[]

  • List of events that were just deleted.

  Async

dumpLogs

• dumpLogs(): string[]

• Clear all logs in this.logs

  Returns string[]

  • List of jobs that were just deleted.

  Async

emitEvent

• emitEvent(type, message): void

• Update this.events with the new event, and this.isInit or this.isEnd as appropriate

  Parameters

  • type: string

    Type of event to be recorded
  • message: string

    Message associated with the event

  Returns void

emitLog

• emitLog(message): void

• Update this.events with the new event

  Parameters

  • message: string

    Message associated with the event

  Returns void

getBaseConnector

• getBaseConnector(): default

• Return the base connector associated with this job and hpc. Never used.

  Returns default

  • The base connector associated with this job.

getSingCVMFSConnector

• getSingCVMFSConnector(): default

• Return the Singularity connector associated with this job and hpc.

  Returns default

  • The singularity connector associated with this job with cvmfs turned on.

getSingularityConnector

• getSingularityConnector(): default

• Return the singularity connector associated with this job and hpc.

  Returns default

  • The singularity connector associated with this job.

getSlurmConnector

• getSlurmConnector(): default

• Return the slurm connector associated with this job and hpc.

  Returns default

  • The slurm connector associated with this job.

init

• init(): Promise<void>

• Initialize job in the maintainer. If the job has been retried too many times, terminate and update events.

  Returns Promise<void>

  Async

maintain

• maintain(): Promise<void>

• Ensure that the job is still running, and if the runtime has exceeded the maintain threshold, terminate and update events.

  Returns Promise<void>

  Async

Abstract onCancel

• onCancel(): Promise<void>

• This function is called when the supervisor tries to cancel the current job/maintainer. TODO: make a corresponding supervisor-facing function to be nore inline with the other onX functions.

  Returns Promise<void>

  Async

Abstract onDefine

• onDefine(): void

• This function is called when the maintainer is created (during the constructor). Can leave empty.

  Returns void

Abstract onInit

• onInit(): Promise<void>

• This function is called when the maintainer is initialized--i.e., it begins work on maintaining the job. Called in the supervisor-facing init() function.

  Returns Promise<void>

  Async

Abstract onMaintain

• onMaintain(): Promise<void>

• This function is called when the supervisor-facing maintain() function is called to maintain (monitor the status of) the job.

  Returns Promise<void>

  Async

Abstract onPause

• onPause(): Promise<void>

• This function is called when the supervisor tries to pause the current job/maintainer. Not used.

  Returns Promise<void>

  Async

Abstract onResume

• onResume(): Promise<void>

• This function is called when the supervisor tries to resume the current job/maintainer after pause. Not used.

  Returns Promise<void>

  Async

updateJob

• updateJob(job): Promise<void>

• Update this job to reflect the information in the passed job.

  Parameters

  • job: jobMaintainerUpdatable

    New information to update this job with.

  Returns Promise<void>

  Async