Package org.yamcs.http.api

Class TimelineApi

java.lang.Object

org.yamcs.protobuf.AbstractTimelineApi<Context>

org.yamcs.http.api.TimelineApi

All Implemented Interfaces:

Api<Context>

public class TimelineApi
extends AbstractTimelineApi<Context>

Constructor Summary

Constructors

Constructor	Description
TimelineApi()

Method Summary

Modifier and Type	Method	Description
void	addBand(Context ctx, AddBandRequest request, Observer<TimelineBand> observer)	Add a band.
void	addItemLog(Context 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
void	addView(Context ctx, AddViewRequest request, Observer<TimelineView> observer)	Add a view
void	createItem(Context ctx, CreateItemRequest request, Observer<TimelineItem> observer)	Create an item
void	deleteBand(Context ctx, DeleteBandRequest request, Observer<TimelineBand> observer)	Delete a band
void	deleteItem(Context ctx, DeleteItemRequest request, Observer<TimelineItem> observer)	Delete an item
void	deleteTimelineGroup(Context ctx, DeleteTimelineGroupRequest request, Observer<TimelineItem> observer)	Delete a group
void	deleteView(Context ctx, DeleteViewRequest request, Observer<TimelineView> observer)	Delete a view
void	getBand(Context ctx, GetBandRequest request, Observer<TimelineBand> observer)	Get a band
void	getItem(Context ctx, GetItemRequest request, Observer<TimelineItem> observer)	Get an item
void	getItemLog(Context ctx, GetItemLogRequest request, Observer<TimelineItemLog> observer)	Get an item log
void	getView(Context ctx, GetViewRequest request, Observer<TimelineView> observer)	Get a view
void	listBands(Context ctx, ListBandsRequest request, Observer<ListBandsResponse> observer)	List all bands
void	listItems(Context ctx, ListItemsRequest request, Observer<ListItemsResponse> observer)	List items
void	listSources(Context ctx, ListSourcesRequest request, Observer<ListSourcesResponse> observer)	List timeline sources Usually there is a source named 'rdb' which provides items from an internal RocksDB database.
void	listTags(Context ctx, ListTimelineTagsRequest request, Observer<ListTimelineTagsResponse> observer)	List all tags available for the 'rdb' source.
void	listViews(Context ctx, ListViewsRequest request, Observer<ListViewsResponse> observer)	List all views
void	updateBand(Context ctx, UpdateBandRequest request, Observer<TimelineBand> observer)	Update a band
void	updateItem(Context ctx, UpdateItemRequest request, Observer<TimelineItem> observer)	Update an item
void	updateView(Context 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

TimelineApi

public TimelineApi()

Method Details

createItem

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

Description copied from class: AbstractTimelineApi

  Create an item
 

Specified by:

createItem in class AbstractTimelineApi<Context>

getItem

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

Description copied from class: AbstractTimelineApi

  Get an item
 

Specified by:

getItem in class AbstractTimelineApi<Context>

updateItem

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

Description copied from class: AbstractTimelineApi

  Update an item
 

Specified by:

updateItem in class AbstractTimelineApi<Context>

listItems

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

Description copied from class: AbstractTimelineApi

  List items
 

Specified by:

listItems in class AbstractTimelineApi<Context>

getItemLog

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

Description copied from class: AbstractTimelineApi

  Get an item log
 

Specified by:

getItemLog in class AbstractTimelineApi<Context>

addItemLog

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

Description copied from class: AbstractTimelineApi

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

listSources

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

Description copied from class: AbstractTimelineApi

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

listTags

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

Description copied from class: AbstractTimelineApi

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

addBand

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

Description copied from class: AbstractTimelineApi

  Add a band.
 

Specified by:

addBand in class AbstractTimelineApi<Context>

getBand

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

Description copied from class: AbstractTimelineApi

  Get a band
 

Specified by:

getBand in class AbstractTimelineApi<Context>

listBands

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

Description copied from class: AbstractTimelineApi

  List all bands
 

Specified by:

listBands in class AbstractTimelineApi<Context>

updateBand

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

Description copied from class: AbstractTimelineApi

  Update a band
 

Specified by:

updateBand in class AbstractTimelineApi<Context>

deleteBand

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

Description copied from class: AbstractTimelineApi

  Delete a band
 

Specified by:

deleteBand in class AbstractTimelineApi<Context>

addView

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

Description copied from class: AbstractTimelineApi

  Add a view
 

Specified by:

addView in class AbstractTimelineApi<Context>

getView

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

Description copied from class: AbstractTimelineApi

  Get a view
 

Specified by:

getView in class AbstractTimelineApi<Context>

listViews

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

Description copied from class: AbstractTimelineApi

  List all views
 

Specified by:

listViews in class AbstractTimelineApi<Context>

updateView

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

Description copied from class: AbstractTimelineApi

  Update a view
 

Specified by:

updateView in class AbstractTimelineApi<Context>

deleteView

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

Description copied from class: AbstractTimelineApi

  Delete a view
 

Specified by:

deleteView in class AbstractTimelineApi<Context>

deleteItem

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

Description copied from class: AbstractTimelineApi

  Delete an item
 

Specified by:

deleteItem in class AbstractTimelineApi<Context>

deleteTimelineGroup

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

Description copied from class: AbstractTimelineApi

  Delete a group
 

Specified by:

deleteTimelineGroup in class AbstractTimelineApi<Context>