foundry_dev_tools.clients.scheduler module

foundry_dev_tools.clients.scheduler module#

Implementation of the scheduler API.

class foundry_dev_tools.clients.scheduler.SchedulerClient[source]#

Bases: APIClient

SchedulerClient class that implements methods from the ‘scheduler’ API.

api_name: ClassVar[str] = 'scheduler'#
get_schedules_by_run_build(rid, branch='master', **kwargs)[source]#

Gets the schedules of the resource dataset.

Parameters:

  • rid (api_types.Rid) – the identifier of the datset

  • branch (api_types.DatasetBranch) – the branch name of the dataset

  • **kwargs – gets passed to APIClient.api_request()

Return type:

requests.Response

get_schedule(rid, **kwargs)[source]#

Gets the schedule details of a given schedule.

Parameters:

  • rid (api_types.Rid) – the identifier of the scheduler

  • **kwargs – gets passed to APIClient.api_request()

Return type:

requests.Response

Contents