org.yamcs.protobuf.CommandsApiClient 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 com.google.protobuf.Empty;
import org.yamcs.api.HttpBody;
import org.yamcs.api.MethodHandler;
import org.yamcs.api.Observer;
import org.yamcs.protobuf.Commanding.CommandHistoryEntry;

@javax.annotation.processing.Generated(value = "org.yamcs.maven.ServiceGenerator", date = "2025-02-13T11:12:59.915178953Z")
public class CommandsApiClient extends AbstractCommandsApi {

    private final MethodHandler handler;

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

    /**
     *      *  Issue a command
     * 
     *  After validating the input parameters, the command is added to the appropriate
     *  command queue for further dispatch.
     * 
     */
    @Override
    public final void issueCommand(Void ctx, IssueCommandRequest request, Observer observer) {
        handler.call(
            getDescriptorForType().getMethods().get(0),
            request,
            IssueCommandResponse.getDefaultInstance(),
            observer);
    }

    /**
     *      *  Update command history
     * 
     */
    @Override
    public final void updateCommandHistory(Void ctx, UpdateCommandHistoryRequest request, Observer observer) {
        handler.call(
            getDescriptorForType().getMethods().get(1),
            request,
            Empty.getDefaultInstance(),
            observer);
    }

    /**
     *      *  List commands
     * 
     */
    @Override
    public final void listCommands(Void ctx, ListCommandsRequest request, Observer observer) {
        handler.call(
            getDescriptorForType().getMethods().get(2),
            request,
            ListCommandsResponse.getDefaultInstance(),
            observer);
    }

    /**
     *      *  Get a command
     * 
     */
    @Override
    public final void getCommand(Void ctx, GetCommandRequest request, Observer observer) {
        handler.call(
            getDescriptorForType().getMethods().get(3),
            request,
            CommandHistoryEntry.getDefaultInstance(),
            observer);
    }

    /**
     *      *  Streams back commands
     * 
     */
    @Override
    public final void streamCommands(Void ctx, StreamCommandsRequest request, Observer observer) {
        handler.call(
            getDescriptorForType().getMethods().get(4),
            request,
            CommandHistoryEntry.getDefaultInstance(),
            observer);
    }

    /**
     *      *  Receive updates on issued commands
     * 
     */
    @Override
    public final void subscribeCommands(Void ctx, SubscribeCommandsRequest request, Observer observer) {
        handler.call(
            getDescriptorForType().getMethods().get(5),
            request,
            CommandHistoryEntry.getDefaultInstance(),
            observer);
    }

    /**
     *      *  Export a raw command
     * 
     */
    @Override
    public final void exportCommand(Void ctx, ExportCommandRequest request, Observer observer) {
        handler.call(
            getDescriptorForType().getMethods().get(6),
            request,
            HttpBody.getDefaultInstance(),
            observer);
    }

    /**
     *      *  Export commands in CSV format
     * 
     */
    @Override
    public final void exportCommands(Void ctx, ExportCommandsRequest request, Observer observer) {
        handler.call(
            getDescriptorForType().getMethods().get(7),
            request,
            HttpBody.getDefaultInstance(),
            observer);
    }
}