across.client.apis.schedule

Classes

Schedule

Client for interacting with Schedule resources in the Across API.

Module Contents

class Schedule(across_client: across.sdk.v1.api_client_wrapper.ApiClientWrapper)[source]

Client for interacting with Schedule resources in the Across API.

Provides methods to retrieve single or multiple schedules by ID, name, instrument information, or creation date.

across_client[source]
get(id: str) → across.sdk.v1.Schedule[source]

Retrieve a single Schedule by ID.

Parameters:

id (str) – The unique identifier of the Schedule to retrieve.

Returns:

The requested Schedule object.

Return type:

sdk.Schedule

get_many(page: int | None = None, page_limit: int | None = None, date_range_begin: datetime.datetime | None = None, date_range_end: datetime.datetime | None = None, status: across.sdk.v1.ScheduleStatus | None = None, external_id: str | None = None, fidelity: across.sdk.v1.ScheduleFidelity | None = None, created_on: datetime.datetime | None = None, observatory_ids: list[str | None] | None = None, observatory_names: list[str | None] | None = None, telescope_ids: list[str | None] | None = None, telescope_names: list[str | None] | None = None, name: str | None = None, include_observations: bool | None = None) → across.sdk.v1.PageSchedule[source]
Retrieve all unique schedules filtered by optional criteria.

  • unique is defined as the most-recently submitted schedule per

telescope in a specified date-range

Parameters:

  • page (int | None, optional) – Page number for paginated results.

  • page_limit (int | None, optional) – Maximum number of results to return per page.

  • date_range_begin (datetime | None, optional) – Filter for schedules starting on or after this date.

  • date_range_end (datetime | None, optional) – Filter for schedules ending on or before this date.

  • status (sdk.ScheduleStatus | None, optional) – Filter by schedule status.

  • external_id (str | None, optional) – Filter by external identifier.

  • fidelity (sdk.ScheduleFidelity | None, optional) – Filter by schedule fidelity level.

  • created_on (datetime | None, optional) – Filter by creation timestamp.

  • observatory_ids (list[str | None] | None, optional) – Filter by one or more observatory IDs.

  • observatory_names (list[UUID | None] | None, optional) – Filter by one or more observatory names.

  • telescope_ids (list[str | None] | None, optional) – Filter by one or more telescope IDs.

  • telescope_names (list[str | None] | None, optional) – Filter by one or more telescope names.

  • name (str | None, optional) – Filter by schedule name.

  • include_observations (bool | None, optional) – Include observations in returned schedules (defaults to False)

Returns:

A paginated collection of schedules matching the given filters.

Return type:

sdk.PageSchedule

get_history(page: int | None = None, page_limit: int | None = None, date_range_begin: datetime.datetime | None = None, date_range_end: datetime.datetime | None = None, status: across.sdk.v1.ScheduleStatus | None = None, external_id: str | None = None, fidelity: across.sdk.v1.ScheduleFidelity | None = None, created_on: datetime.datetime | None = None, observatory_ids: list[str | None] | None = None, observatory_names: list[str | None] | None = None, telescope_ids: list[str | None] | None = None, telescope_names: list[str | None] | None = None, name: str | None = None, include_observations: bool | None = None) → across.sdk.v1.PageSchedule[source]

Retrieve all schedules filtered by optional criteria.

Parameters:

  • page (int | None, optional) – Page number for paginated results.

  • page_limit (int | None, optional) – Maximum number of results to return per page.

  • date_range_begin (datetime | None, optional) – Filter for schedules starting on or after this date.

  • date_range_end (datetime | None, optional) – Filter for schedules ending on or before this date.

  • status (sdk.ScheduleStatus | None, optional) – Filter by schedule status.

  • external_id (str | None, optional) – Filter by external identifier.

  • fidelity (sdk.ScheduleFidelity | None, optional) – Filter by schedule fidelity level.

  • created_on (datetime | None, optional) – Filter by creation timestamp.

  • observatory_ids (list[str | None] | None, optional) – Filter by one or more observatory IDs.

  • observatory_names (list[str | None] | None, optional) – Filter by one or more observatory names.

  • telescope_ids (list[str | None] | None, optional) – Filter by one or more telescope IDs.

  • telescope_names (list[str | None] | None, optional) – Filter by one or more telescope names.

  • name (str | None, optional) – Filter by schedule name.

  • include_observations (bool | None, optional) – Include observations in returned schedules (defaults to False)

Returns:

A paginated collection of schedules matching the given filters.

Return type:

sdk.PageSchedule

post(schedule: across.sdk.v1.ScheduleCreate) → str[source]

Creates a schedule in the across api.

Parameters:

schedule (sdk.ScheduleCreate) –

a ScheduleCreate object with the following arguments:

telescope_id: StrictStr, name: StrictStr, date_range: DateRange, status: ScheduleStatus, external_id: StrictStr | None, fidelity: ScheduleFidelity | None, observations: List[ObservationCreate]

Returns:

schedule_id (str | uuid)

model id for the newly created schedule

post_many(schedules: across.sdk.v1.ScheduleCreateMany) → list[str][source]

Creates many schedules in the across api.

Parameters:

schedules (sdk.ScheduleCreateMany) –

a ScheduleCreateMany object with the following arguments:

schedules: list[sdk.ScheduleCreate]

Returns:

list[str]

model ids for the newly created schedules