Module org.yamcs.api

Package org.yamcs.protobuf

Class TimelineApiClient

java.lang.Object

org.yamcs.protobuf.AbstractTimelineApi<Void>

org.yamcs.protobuf.TimelineApiClient

All Implemented Interfaces:

Api<Void>

@Generated(value="org.yamcs.maven.ServiceGenerator",
           date="2026-08-07T12:09:14.411058859Z")
public class TimelineApiClient
extends AbstractTimelineApi<Void>

 Methods related to the Timeline Service.
 

Constructor Summary

Constructors

Constructor	Description
TimelineApiClient(MethodHandler handler)

Method Summary

Modifier and Type	Method	Description
final void	addItemLog(Void ctx, AddItemLogRequest request, Observer<LogEntry> observer)	add an entry to the item log table The timestamp from the messages is used if specified; if not specified, the current mission time will be used
final void	batchDeleteItems(Void ctx, BatchDeleteItemsRequest request, Observer<com.google.protobuf.Empty> observer)
final void	cancelActivity(Void ctx, CancelActivityRequest request, Observer<com.google.protobuf.Empty> observer)	Cancel a planned activity
final void	deleteBand(Void ctx, DeleteBandRequest request, Observer<TimelineBand> observer)	Delete a band
final void	deleteItem(Void ctx, DeleteItemRequest request, Observer<TimelineItem> observer)	Delete an item
final void	deleteTimelineGroup(Void ctx, DeleteTimelineGroupRequest request, Observer<TimelineItem> observer)	Delete a group
final void	deleteView(Void ctx, DeleteViewRequest request, Observer<TimelineView> observer)	Delete a view
final void	getBand(Void ctx, GetBandRequest request, Observer<TimelineBand> observer)	Get a band
final void	getItem(Void ctx, GetItemRequest request, Observer<TimelineItem> observer)	Get an item
final void	getItemLog(Void ctx, GetItemLogRequest request, Observer<TimelineItemLog> observer)	Get an item log
final void	getView(Void ctx, GetViewRequest request, Observer<TimelineView> observer)	Get a view
final void	listBands(Void ctx, ListBandsRequest request, Observer<ListBandsResponse> observer)	List all bands
final void	listItems(Void ctx, ListItemsRequest request, Observer<ListItemsResponse> observer)	List items Two alternative URI forms can be used.
final void	listSources(Void ctx, ListSourcesRequest request, Observer<ListSourcesResponse> observer)	List timeline sources Usually there is a source named 'rdb' which provides items from an internal RocksDB database.
final void	listTags(Void ctx, ListTimelineTagsRequest request, Observer<ListTimelineTagsResponse> observer)	List all tags available for the 'rdb' source.
final void	listViews(Void ctx, ListViewsRequest request, Observer<ListViewsResponse> observer)	List all views
final void	saveBand(Void ctx, SaveBandRequest request, Observer<TimelineBand> observer)	Create or update a band
final void	saveItem(Void ctx, SaveItemRequest request, Observer<TimelineItem> observer)	Create or update an item
final void	saveView(Void ctx, SaveViewRequest request, Observer<TimelineView> observer)	Create or update a view
final void	startActivity(Void ctx, StartActivityRequest request, Observer<ActivityInfo> observer)	Manually start an activity
final void	subscribeItemChanges(Void ctx, SubscribeItemChangesRequest request, Observer<com.google.protobuf.Empty> observer)	Receive item change notifications When any item has changed (create-update-delete), an empty notification message is sent.

Methods inherited from class org.yamcs.protobuf.AbstractTimelineApi

callMethod, callMethod, getDescriptorForType, getRequestPrototype, getResponsePrototype

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

TimelineApiClient

public TimelineApiClient(MethodHandler handler)

Method Details

saveItem

public final void saveItem(Void ctx,
 SaveItemRequest request,
 Observer<TimelineItem> observer)

  Create or update an item
 

Specified by:

saveItem in class AbstractTimelineApi<Void>

getItem

public final void getItem(Void ctx,
 GetItemRequest request,
 Observer<TimelineItem> observer)

  Get an item
 

Specified by:

getItem in class AbstractTimelineApi<Void>

listItems

public final void listItems(Void ctx,
 ListItemsRequest request,
 Observer<ListItemsResponse> observer)

  List items
 
  Two alternative URI forms can be used. The `GET` method is convenient, while
  the `POST` method allows passing long filter expressions.  
 

Specified by:

listItems in class AbstractTimelineApi<Void>

deleteItem

public final void deleteItem(Void ctx,
 DeleteItemRequest request,
 Observer<TimelineItem> observer)

  Delete an item
 

Specified by:

deleteItem in class AbstractTimelineApi<Void>

batchDeleteItems

public final void batchDeleteItems(Void ctx,
 BatchDeleteItemsRequest request,
 Observer<com.google.protobuf.Empty> observer)

Specified by:

batchDeleteItems in class AbstractTimelineApi<Void>

getItemLog

public final void getItemLog(Void ctx,
 GetItemLogRequest request,
 Observer<TimelineItemLog> observer)

  Get an item log
 

Specified by:

getItemLog in class AbstractTimelineApi<Void>

addItemLog

public final void addItemLog(Void ctx,
 AddItemLogRequest request,
 Observer<LogEntry> observer)

 add an entry to the item log table
  The timestamp from the messages is used if specified; if not specified, the current mission time will be used 
 

Specified by:

addItemLog in class AbstractTimelineApi<Void>

deleteTimelineGroup

public final void deleteTimelineGroup(Void ctx,
 DeleteTimelineGroupRequest request,
 Observer<TimelineItem> observer)

  Delete a group
 

Specified by:

deleteTimelineGroup in class AbstractTimelineApi<Void>

listSources

public final void listSources(Void ctx,
 ListSourcesRequest request,
 Observer<ListSourcesResponse> observer)

  List timeline sources
 
  Usually there is a source named 'rdb' which provides items from an internal RocksDB database.
  Other external sources may be created by adding plugins (e.g. a shift planner)
 

Specified by:

listSources in class AbstractTimelineApi<Void>

listTags

public final void listTags(Void ctx,
 ListTimelineTagsRequest request,
 Observer<ListTimelineTagsResponse> observer)

  List all tags available for the 'rdb' source.
 
  Note that currently the 'rdb' source does not discard unused tags
  (e.g. if all item using one tag have been deleted, the tag will still be returned by this call)
 

Specified by:

listTags in class AbstractTimelineApi<Void>

saveBand

public final void saveBand(Void ctx,
 SaveBandRequest request,
 Observer<TimelineBand> observer)

  Create or update a band
 

Specified by:

saveBand in class AbstractTimelineApi<Void>

getBand

public final void getBand(Void ctx,
 GetBandRequest request,
 Observer<TimelineBand> observer)

  Get a band
 

Specified by:

getBand in class AbstractTimelineApi<Void>

listBands

public final void listBands(Void ctx,
 ListBandsRequest request,
 Observer<ListBandsResponse> observer)

  List all bands
 

Specified by:

listBands in class AbstractTimelineApi<Void>

deleteBand

public final void deleteBand(Void ctx,
 DeleteBandRequest request,
 Observer<TimelineBand> observer)

  Delete a band
 

Specified by:

deleteBand in class AbstractTimelineApi<Void>

saveView

public final void saveView(Void ctx,
 SaveViewRequest request,
 Observer<TimelineView> observer)

  Create or update a view
 

Specified by:

saveView in class AbstractTimelineApi<Void>

getView

public final void getView(Void ctx,
 GetViewRequest request,
 Observer<TimelineView> observer)

  Get a view
 

Specified by:

getView in class AbstractTimelineApi<Void>

listViews

public final void listViews(Void ctx,
 ListViewsRequest request,
 Observer<ListViewsResponse> observer)

  List all views
 

Specified by:

listViews in class AbstractTimelineApi<Void>

deleteView

public final void deleteView(Void ctx,
 DeleteViewRequest request,
 Observer<TimelineView> observer)

  Delete a view
 

Specified by:

deleteView in class AbstractTimelineApi<Void>

startActivity

public final void startActivity(Void ctx,
 StartActivityRequest request,
 Observer<ActivityInfo> observer)

  Manually start an activity
 

Specified by:

startActivity in class AbstractTimelineApi<Void>

cancelActivity

public final void cancelActivity(Void ctx,
 CancelActivityRequest request,
 Observer<com.google.protobuf.Empty> observer)

  Cancel a planned activity
 

Specified by:

cancelActivity in class AbstractTimelineApi<Void>

subscribeItemChanges

public final void subscribeItemChanges(Void ctx,
 SubscribeItemChangesRequest request,
 Observer<com.google.protobuf.Empty> observer)

  Receive item change notifications
 
  When any item has changed (create-update-delete), an empty notification message
  is sent. Messages are bundled over a 5 second interval. 
 

Specified by:

subscribeItemChanges in class AbstractTimelineApi<Void>