Scheduler¶

The scheduler domain provides access to scheduler-specific program data.

Use scheduler to query programs used by the scheduler.

Quick Example¶

async with GPPClient() as client:
   programs = await client.scheduler.get_programs()

Get scheduler programs:

result = await client.scheduler.get_programs()

Optionally filter by program IDs:

result = await client.scheduler.get_programs(
   programs_list=["p-123", "p-456"]
)

Get all scheduler program IDs:

result = await client.scheduler.get_program_ids()

All scheduler operations use GraphQL and return generated response models.

class gpp_client.domains.scheduler.SchedulerDomain(*, graphql: GraphQLClient, rest: RESTClient, settings: GPPSettings)[source]¶

Bases: BaseDomain

Domain for retrieving scheduler information.

async get_all(programs_list: list | None = None) → list[dict[str, Any]][source]¶

Fetch all programs with a complete group tree and observations.

Parameters:: programs_list (list, optional) – Optional filtering clause.
Returns:: A list of dictionaries representing the programs and their elements.
Return type:: list[dict[str, Any]]

async get_all_reference_labels(date: str | None = None) → list[tuple[str, str]][source]¶

Get all scheduler program reference labels and IDs.

Parameters:: date (str | None, optional) – Date to use for the active-end filter. Defaults to today’s date.
Returns:: List of tuples containing the program reference label and ID.
Return type:: list[tuple[str, str]]

async get_program_ids(*, today: str | None = None) → GetSchedulerAllProgramsId[source]¶

Get all scheduler program IDs.

Parameters:: today (str | None, optional) – Optional date string to filter programs by today’s date.
Returns:: The generated GraphQL response model.
Return type:: GetSchedulerAllProgramsId

async get_programs(*, programs_list: list[str] | None = None) → GetSchedulerPrograms[source]¶

Get scheduler programs.

Parameters:: programs_list (list[str] | None, optional) – Optional list of program IDs to restrict the result set.
Returns:: The generated GraphQL response model.
Return type:: GetSchedulerPrograms