Client¶

class yamcs.client.TimelineClient(ctx: Context, instance: str)¶

Client for working with Yamcs timeline.

delete_band(band: str)¶

Delete a band.

Parameters:

band – Band identifier.

delete_item(item: str)¶

Delete an item.

Parameters:

item – Item identifier.

delete_items(start: datetime | None = None, stop: datetime | None = None, filter: str | None = None)¶

Batch-delete items.

Parameters:

• start – Minimum stop time of the returned items (exclusive)

• stop – Maximum start time of the returned items (exclusive)

• filter – Filter string

delete_view(view: str)¶

Delete a view.

Parameters:

view – View identifier.

get_band(id: str) → Band¶

Fetch a band by its identifier.

Parameters:

id – Band identifier

get_item(id: str) → TimelineItem¶

Fetch an item by its identifier.

Parameters:

id – Item identifier

get_view(id: str) → View¶

Fetch a view by its identifier.

Parameters:

id – View identifier

list_bands() → Iterable[Band]¶

List the bands.

list_items(band: str | None = None, start: datetime | None = None, stop: datetime | None = None, page_size: int = 500) → Iterable[TimelineItem]¶

List the items.

Parameters:

• band – Return only items matching the specified band

• start – Minimum stop time of the returned items (exclusive)

• stop – Maximum start time of the returned items (exclusive)

• page_size – Page size of underlying requests. Higher values imply less overhead, but risk hitting the maximum message size limit.

list_views() → Iterable[View]¶

List the views.

save_band(band: Band)¶

Save or update a band.

Parameters:

band – Band object

save_item(item: TimelineItem | Item)¶

Save or update an item.

Parameters:

item – The item to persist. Note: Support for the ‘Item’ type is deprecated and maintained only for migration purposes. Transition to one of the ‘TimelineItem’ subclasses (‘TimelineEvent’, ‘TimelineActivity’, ‘TimelineTask’).

save_view(view: View)¶

Save or update a view.

Parameters:

view – View object