`tracdap.rt.metadata.job`¶

Module Contents¶

Classes¶

`ExportDataJob`	Specification for an EXPORT_DATA job
`ImportDataJob`	Specification for an IMPORT_DATA job
`ImportModelJob`	Specification for an IMPORT_MODEL job
`JobDefinition`	Define a job to run on the TRAC platform
`JobGroup`	Specification for a JOB_GROUP job, which runs a collection of other jobs
`JobGroupType`	Specify the group type for a JOB_GROUP job
`JobStatusCode`	Indicate the status of a job in the TRAC platform
`JobType`	Specify the type of an individual TRAC job
`ParallelJobGroup`	A job group where all jobs runs in parallel
`RunFlowJob`	Specification for a RUN_FLOW job
`RunModelJob`	Specification for a RuN_MODEL job
`SequentialJobGroup`	A job group where each job runs in sequence

class tracdap.rt.metadata.job.ExportDataJob¶

Specification for an EXPORT_DATA job

exports¶

exports

Type:: Dict[str, TagSelector]

inputs¶

inputs

Type:: Dict[str, TagSelector]

model¶

model

Type:: TagSelector

outputAttrs¶

outputAttrs

Type:: List[TagUpdate]

outputs¶

outputs

Type:: Dict[str, TagSelector]

parameters¶

parameters

Type:: Dict[str, Value]

priorOutputs¶

priorOutputs

Type:: Dict[str, TagSelector]

storageAccess¶

storageAccess

Type:: List[str]

class tracdap.rt.metadata.job.ImportDataJob¶

Specification for an IMPORT_DATA job

importAttrs¶

importAttrs

Type:: List[TagUpdate]

imports¶

imports

Type:: Dict[str, TagSelector]

inputs¶

inputs

Type:: Dict[str, TagSelector]

model¶

model

Type:: TagSelector

outputAttrs¶

outputAttrs

Type:: List[TagUpdate]

outputs¶

outputs

Type:: Dict[str, TagSelector]

parameters¶

parameters

Type:: Dict[str, Value]

priorOutputs¶

priorOutputs

Type:: Dict[str, TagSelector]

storageAccess¶

storageAccess

Type:: List[str]

class tracdap.rt.metadata.job.ImportModelJob¶

Specification for an IMPORT_MODEL job

entryPoint¶

entryPoint

Type:: str

language¶

language

Type:: str

modelAttrs¶

modelAttrs

Type:: List[TagUpdate]

package¶

package

Type:: str

packageGroup¶

packageGroup

Type:: Optional[str]

path¶

path

Type:: str

repository¶

repository

Type:: str

version¶

version

Type:: str

class tracdap.rt.metadata.job.JobDefinition¶

Define a job to run on the TRAC platform

exportData¶

exportData

Type:: Optional[ExportDataJob]

importData¶

importData

Type:: Optional[ImportDataJob]

importModel¶

importModel

Type:: Optional[ImportModelJob]

jobGroup¶

jobGroup

Type:: Optional[JobGroup]

jobType¶

jobType

Type:: JobType

runFlow¶

runFlow

Type:: Optional[RunFlowJob]

runModel¶

runModel

Type:: Optional[RunModelJob]

class tracdap.rt.metadata.job.JobGroup¶

Specification for a JOB_GROUP job, which runs a collection of other jobs

jobGroupType¶

jobGroupType

Type:: JobGroupType

parallel¶

parallel

Type:: Optional[ParallelJobGroup]

sequential¶

sequential

Type:: Optional[SequentialJobGroup]

class tracdap.rt.metadata.job.JobGroupType(*args, **kwds)¶

Bases: enum.Enum

Specify the group type for a JOB_GROUP job

JOB_GROUP_TYPE_NOT_SET = 0¶

PARALLEL_JOB_GROUP = 2¶

SEQUENTIAL_JOB_GROUP = 1¶

class tracdap.rt.metadata.job.JobStatusCode(*args, **kwds)¶

Bases: enum.Enum

Indicate the status of a job in the TRAC platform

CANCELLED = 10¶: The job was cancelled by a user of the platform

FAILED = 9¶: The job failed and has been terminated or rejected

FINISHING = 7¶: Job execution completed, the platform is cleaning up and validating the outputs

JOB_STATUS_CODE_NOT_SET = 0¶

PENDING = 3¶: The job is being set up

PREPARING = 1¶: The job is being set up

QUEUED = 4¶: The job is queued in TRAC, waiting for available resources

RUNNING = 6¶: The job is currently running

SUBMITTED = 5¶: The job has been submitted for execution but has not yet started

SUCCEEDED = 8¶: The job completed successfully and the results are available

VALIDATED = 2¶: The job has passed validation and is ok to run (dry-run operations may return this status)

class tracdap.rt.metadata.job.JobType(*args, **kwds)¶

Bases: enum.Enum

Specify the type of an individual TRAC job

EXPORT_DATA = 5¶: Export data to external locations

IMPORT_DATA = 4¶: Import data into the platform

IMPORT_MODEL = 3¶: Import a model into the platform

JOB_GROUP = 6¶: A job built from a collection of other jobs

JOB_TYPE_NOT_SET = 0¶

RUN_FLOW = 2¶: Run a flow with all its models, parameters and inputs

RUN_MODEL = 1¶: Run a single model, with parameters and inputs

class tracdap.rt.metadata.job.ParallelJobGroup¶

A job group where all jobs runs in parallel

jobs¶

jobs

Type:: List[JobDefinition]

class tracdap.rt.metadata.job.RunFlowJob¶

Specification for a RUN_FLOW job

flow¶

flow

Type:: TagSelector

inputs¶

inputs

Type:: Dict[str, TagSelector]

models¶

models

Type:: Dict[str, TagSelector]

outputAttrs¶

outputAttrs

Type:: List[TagUpdate]

outputs¶

outputs

Type:: Dict[str, TagSelector]

parameters¶

parameters

Type:: Dict[str, Value]

priorOutputs¶

priorOutputs

Type:: Dict[str, TagSelector]

class tracdap.rt.metadata.job.RunModelJob¶

Specification for a RuN_MODEL job

inputs¶

inputs

Type:: Dict[str, TagSelector]

model¶

model

Type:: TagSelector

outputAttrs¶

outputAttrs

Type:: List[TagUpdate]

outputs¶

outputs

Type:: Dict[str, TagSelector]

parameters¶

parameters

Type:: Dict[str, Value]

priorOutputs¶

priorOutputs

Type:: Dict[str, TagSelector]

class tracdap.rt.metadata.job.SequentialJobGroup¶

A job group where each job runs in sequence

jobs¶

jobs

Type:: List[JobDefinition]

tracdap.rt.metadata.job¶

Module Contents¶

Classes¶

`tracdap.rt.metadata.job`¶