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.protoc.ServiceGenerator",
           date="2024-03-05T16:49:10.422442178Z")
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	addBand(Void ctx, AddBandRequest request, Observer<TimelineBand> observer)	Add a band.
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	addView(Void ctx, AddViewRequest request, Observer<TimelineView> observer)	Add a view
final void	createItem(Void ctx, CreateItemRequest request, Observer<TimelineItem> observer)	Create an item
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
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	updateBand(Void ctx, UpdateBandRequest request, Observer<TimelineBand> observer)	Update a band
final void	updateItem(Void ctx, UpdateItemRequest request, Observer<TimelineItem> observer)	Update an item
final void	updateView(Void ctx, UpdateViewRequest request, Observer<TimelineView> observer)	Update a view

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

createItem

public final void createItem(Void ctx,
 CreateItemRequest request,
 Observer<TimelineItem> observer)

  Create an item
 

Specified by:

createItem 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>

updateItem

public final void updateItem(Void ctx,
 UpdateItemRequest request,
 Observer<TimelineItem> observer)

  Update an item
 

Specified by:

updateItem in class AbstractTimelineApi<Void>

listItems

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

  List items
 

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>

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>

addBand

public final void addBand(Void ctx,
 AddBandRequest request,
 Observer<TimelineBand> observer)

  Add a band.
 

Specified by:

addBand 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>

updateBand

public final void updateBand(Void ctx,
 UpdateBandRequest request,
 Observer<TimelineBand> observer)

  Update a band
 

Specified by:

updateBand 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>

addView

public final void addView(Void ctx,
 AddViewRequest request,
 Observer<TimelineView> observer)

  Add a view
 

Specified by:

addView 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>

updateView

public final void updateView(Void ctx,
 UpdateViewRequest request,
 Observer<TimelineView> observer)

  Update a view
 

Specified by:

updateView 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>