org.yamcs.protobuf.TimelineApiClient Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of yamcs-api Show documentation
Used by external clients to communicate with Yamcs
There is a newer version: 5.10.9
package org.yamcs.protobuf;

import org.yamcs.api.MethodHandler;
import org.yamcs.api.Observer;

/**
 *  * Methods related to the Timeline Service.
 * 
 */
@javax.annotation.processing.Generated(value = "org.yamcs.maven.ServiceGenerator", date = "2025-02-13T11:12:59.905672201Z")
public class TimelineApiClient extends AbstractTimelineApi {

    private final MethodHandler handler;

    public TimelineApiClient(MethodHandler handler) {
        this.handler = handler;
    }

    /**
     *      *  Create an item
     * 
     */
    @Override
    public final void createItem(Void ctx, CreateItemRequest request, Observer observer) {
        handler.call(
            getDescriptorForType().getMethods().get(0),
            request,
            TimelineItem.getDefaultInstance(),
            observer);
    }

    /**
     *      *  Get an item
     * 
     */
    @Override
    public final void getItem(Void ctx, GetItemRequest request, Observer observer) {
        handler.call(
            getDescriptorForType().getMethods().get(1),
            request,
            TimelineItem.getDefaultInstance(),
            observer);
    }

    /**
     *      *  Update an item
     * 
     */
    @Override
    public final void updateItem(Void ctx, UpdateItemRequest request, Observer observer) {
        handler.call(
            getDescriptorForType().getMethods().get(2),
            request,
            TimelineItem.getDefaultInstance(),
            observer);
    }

    /**
     *      *  List items
     * 
     */
    @Override
    public final void listItems(Void ctx, ListItemsRequest request, Observer observer) {
        handler.call(
            getDescriptorForType().getMethods().get(3),
            request,
            ListItemsResponse.getDefaultInstance(),
            observer);
    }

    /**
     *      *  Delete an item
     * 
     */
    @Override
    public final void deleteItem(Void ctx, DeleteItemRequest request, Observer observer) {
        handler.call(
            getDescriptorForType().getMethods().get(4),
            request,
            TimelineItem.getDefaultInstance(),
            observer);
    }

    /**
     *      *  Get an item log
     * 
     */
    @Override
    public final void getItemLog(Void ctx, GetItemLogRequest request, Observer observer) {
        handler.call(
            getDescriptorForType().getMethods().get(5),
            request,
            TimelineItemLog.getDefaultInstance(),
            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 
     * 
     */
    @Override
    public final void addItemLog(Void ctx, AddItemLogRequest request, Observer observer) {
        handler.call(
            getDescriptorForType().getMethods().get(6),
            request,
            LogEntry.getDefaultInstance(),
            observer);
    }

    /**
     *      *  Delete a group
     * 
     */
    @Override
    public final void deleteTimelineGroup(Void ctx, DeleteTimelineGroupRequest request, Observer observer) {
        handler.call(
            getDescriptorForType().getMethods().get(7),
            request,
            TimelineItem.getDefaultInstance(),
            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)
     * 
     */
    @Override
    public final void listSources(Void ctx, ListSourcesRequest request, Observer observer) {
        handler.call(
            getDescriptorForType().getMethods().get(8),
            request,
            ListSourcesResponse.getDefaultInstance(),
            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)
     * 
     */
    @Override
    public final void listTags(Void ctx, ListTimelineTagsRequest request, Observer observer) {
        handler.call(
            getDescriptorForType().getMethods().get(9),
            request,
            ListTimelineTagsResponse.getDefaultInstance(),
            observer);
    }

    /**
     *      *  Add a band
     * 
     */
    @Override
    public final void addBand(Void ctx, AddBandRequest request, Observer observer) {
        handler.call(
            getDescriptorForType().getMethods().get(10),
            request,
            TimelineBand.getDefaultInstance(),
            observer);
    }

    /**
     *      *  Get a band
     * 
     */
    @Override
    public final void getBand(Void ctx, GetBandRequest request, Observer observer) {
        handler.call(
            getDescriptorForType().getMethods().get(11),
            request,
            TimelineBand.getDefaultInstance(),
            observer);
    }

    /**
     *      *  List all bands
     * 
     */
    @Override
    public final void listBands(Void ctx, ListBandsRequest request, Observer observer) {
        handler.call(
            getDescriptorForType().getMethods().get(12),
            request,
            ListBandsResponse.getDefaultInstance(),
            observer);
    }

    /**
     *      *  Update a band
     * 
     */
    @Override
    public final void updateBand(Void ctx, UpdateBandRequest request, Observer observer) {
        handler.call(
            getDescriptorForType().getMethods().get(13),
            request,
            TimelineBand.getDefaultInstance(),
            observer);
    }

    /**
     *      *  Delete a band
     * 
     */
    @Override
    public final void deleteBand(Void ctx, DeleteBandRequest request, Observer observer) {
        handler.call(
            getDescriptorForType().getMethods().get(14),
            request,
            TimelineBand.getDefaultInstance(),
            observer);
    }

    /**
     *      *  Add a view
     * 
     */
    @Override
    public final void addView(Void ctx, AddViewRequest request, Observer observer) {
        handler.call(
            getDescriptorForType().getMethods().get(15),
            request,
            TimelineView.getDefaultInstance(),
            observer);
    }

    /**
     *      *  Get a view
     * 
     */
    @Override
    public final void getView(Void ctx, GetViewRequest request, Observer observer) {
        handler.call(
            getDescriptorForType().getMethods().get(16),
            request,
            TimelineView.getDefaultInstance(),
            observer);
    }

    /**
     *      *  List all views
     * 
     */
    @Override
    public final void listViews(Void ctx, ListViewsRequest request, Observer observer) {
        handler.call(
            getDescriptorForType().getMethods().get(17),
            request,
            ListViewsResponse.getDefaultInstance(),
            observer);
    }

    /**
     *      *  Update a view
     * 
     */
    @Override
    public final void updateView(Void ctx, UpdateViewRequest request, Observer observer) {
        handler.call(
            getDescriptorForType().getMethods().get(18),
            request,
            TimelineView.getDefaultInstance(),
            observer);
    }

    /**
     *      *  Delete a view
     * 
     */
    @Override
    public final void deleteView(Void ctx, DeleteViewRequest request, Observer observer) {
        handler.call(
            getDescriptorForType().getMethods().get(19),
            request,
            TimelineView.getDefaultInstance(),
            observer);
    }
}