Jobs - TrueFoundry Docs

list_runs

List Job Runs for provided Job Id. Filter the data based on parameters passed in the query

Parameters

str

required

Job id of the application

typing.Optional[int]

Number of items per page

typing.Optional[int]

Number of items to skip

typing.Optional[str]

Prefix used to search for job runs by name or identifier

typing.Optional[JobRunsSortBy]

🔗 JobRunsSortByAttribute to sort by

typing.Optional[SortDirection]

🔗 SortDirectionSorting order

typing.Optional[typing.Union[str, typing.Sequence[str]]]

Array of subject slugs

typing.Optional[typing.Union[JobRunStatus, typing.Sequence[JobRunStatus]]]

🔗 JobRunStatusStatus of the job run

typing.Optional[typing.Union[float, typing.Sequence[float]]]

Version number of the deployment

Returns

🔗 ListJobRunResponseReturns all runs of a Job sorted by creation date in “data” key and total count in “totalCount” key

Usage

from truefoundry import TrueFoundry

client = TrueFoundry(
    api_key="YOUR_API_KEY",
    base_url="https://yourhost.com/path/to/api",
)

client.jobs.list_runs(
    job_id="value",
    limit=10,
    offset=10,
    search_prefix="value",
    sort_by="value",
    order="value",
    triggered_by="value",
    status="value",
    version_numbers="value",
)

get_run

Get Job Run for provided jobRunName and jobId

Parameters

str

required

Application Id of JOB

str

required

Job run name of the application

Returns

GetJobRunResponse

🔗 GetJobRunResponseReturn JobRun details of the provided jobRunName

Usage

from truefoundry import TrueFoundry

client = TrueFoundry(
    api_key="YOUR_API_KEY",
    base_url="https://yourhost.com/path/to/api",
)

client.jobs.get_run(
    job_id="value",
    job_run_name="value",
)

delete_run

Delete Job Run for provided jobRunName and jobId

Parameters

str

required

Application Id of JOB

str

required

Job run name of the application

Returns

DeleteJobRunResponse

🔗 DeleteJobRunResponseJob Run deleted

Usage

from truefoundry import TrueFoundry

client = TrueFoundry(
    api_key="YOUR_API_KEY",
    base_url="https://yourhost.com/path/to/api",
)

client.jobs.delete_run(
    job_id="value",
    job_run_name="value",
)

trigger

Trigger Job for provided deploymentId or applicationId

Parameters

typing.Optional[str]

Deployment Id of the job

typing.Optional[str]

Application Id of the job

typing.Optional[TriggerJobRequestInput]

🔗 TriggerJobRequestInputJob trigger input

typing.Optional[Metadata]

🔗 MetadataMetadata for the job run including job_alias_name

Returns

TriggerJobRunResponse

🔗 TriggerJobRunResponseReturns object with message, JobRun Name And Job Details on successful creation of Job

Usage

from truefoundry import TrueFoundry

client = TrueFoundry(
    api_key="YOUR_API_KEY",
    base_url="https://yourhost.com/path/to/api",
)

client.jobs.trigger(
    deployment_id="value",
    application_id="application_id_value",
    input="value",
    metadata="value",
)

terminate

Terminate Job for provided deploymentId and jobRunName

Parameters

str

required

Deployment Id of the Deployment

str

required

Job Run name

Returns

TerminateJobResponse

🔗 TerminateJobResponseReturns object with message and JobRun Status on successful termination of Job

Usage

from truefoundry import TrueFoundry

client = TrueFoundry(
    api_key="YOUR_API_KEY",
    base_url="https://yourhost.com/path/to/api",
)

client.jobs.terminate(
    deployment_id="value",
    job_run_name="value",
)

​Methods

​Parameters

​Returns

​Usage

​Parameters

​Returns

​Usage

​Parameters

​Returns

​Usage

​Parameters

​Returns

​Usage

​Parameters

​Returns

​Usage

Methods

Parameters

Returns

Usage

Parameters

Returns

Usage

Parameters

Returns

Usage

Parameters

Returns

Usage

Parameters

Returns

Usage