Module org.yamcs.api

Package org.yamcs.protobuf

Class AbstractTimelineApi<T>

java.lang.Object

org.yamcs.protobuf.AbstractTimelineApi<T>

All Implemented Interfaces:

Api<T>

Direct Known Subclasses:

TimelineApiClient

@Generated(value="org.yamcs.maven.ServiceGenerator",
           date="2024-10-06T08:46:13.204622584Z")
public abstract class AbstractTimelineApi<T>
extends Object
implements Api<T>

 Methods related to the Timeline Service.
 

Constructor Summary

Constructors

Constructor	Description
AbstractTimelineApi()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractTimelineApi

public AbstractTimelineApi()

Method Details

createItem

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

  Create an item
 

getItem

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

  Get an item
 

updateItem

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

  Update an item
 

listItems

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

  List items
 

deleteItem

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

  Delete an item
 

getItemLog

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

  Get an item log
 

addItemLog

public abstract void addItemLog(T 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 
 

deleteTimelineGroup

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

  Delete a group
 

listSources

public abstract void listSources(T 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)
 

listTags

public abstract void listTags(T 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)
 

addBand

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

  Add a band
 

getBand

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

  Get a band
 

listBands

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

  List all bands
 

updateBand

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

  Update a band
 

deleteBand

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

  Delete a band
 

addView

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

  Add a view
 

getView

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

  Get a view
 

listViews

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

  List all views
 

updateView

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

  Update a view
 

deleteView

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

  Delete a view
 

getDescriptorForType

public final com.google.protobuf.Descriptors.ServiceDescriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface Api<T>

getRequestPrototype

public final com.google.protobuf.Message getRequestPrototype(com.google.protobuf.Descriptors.MethodDescriptor method)

Specified by:

getRequestPrototype in interface Api<T>

getResponsePrototype

public final com.google.protobuf.Message getResponsePrototype(com.google.protobuf.Descriptors.MethodDescriptor method)

Specified by:

getResponsePrototype in interface Api<T>

callMethod

public final void callMethod(com.google.protobuf.Descriptors.MethodDescriptor method,
 T ctx,
 com.google.protobuf.Message request,
 Observer<com.google.protobuf.Message> future)

Specified by:

callMethod in interface Api<T>

callMethod

public final Observer<com.google.protobuf.Message> callMethod(com.google.protobuf.Descriptors.MethodDescriptor method,
 T ctx,
 Observer<com.google.protobuf.Message> future)

Specified by:

callMethod in interface Api<T>