Module org.yamcs.api

Package org.yamcs.protobuf

Class CommandsApiClient

java.lang.Object

org.yamcs.protobuf.AbstractCommandsApi<Void>

org.yamcs.protobuf.CommandsApiClient

All Implemented Interfaces:

Api<Void>

@Generated(value="org.yamcs.maven.ServiceGenerator",
           date="2024-10-06T09:24:24.158163562Z")
public class CommandsApiClient
extends AbstractCommandsApi<Void>

Constructor Summary

Constructors

Constructor	Description
CommandsApiClient(MethodHandler handler)

Method Summary

Modifier and Type	Method	Description
final void	exportCommand(Void ctx, ExportCommandRequest request, Observer<HttpBody> observer)	Export a raw command
final void	exportCommands(Void ctx, ExportCommandsRequest request, Observer<HttpBody> observer)	Export commands in CSV format
final void	getCommand(Void ctx, GetCommandRequest request, Observer<Commanding.CommandHistoryEntry> observer)	Get a command
final void	issueCommand(Void ctx, IssueCommandRequest request, Observer<IssueCommandResponse> observer)	Issue a command After validating the input parameters, the command is added to the appropriate command queue for further dispatch.
final void	listCommands(Void ctx, ListCommandsRequest request, Observer<ListCommandsResponse> observer)	List commands
final void	streamCommands(Void ctx, StreamCommandsRequest request, Observer<Commanding.CommandHistoryEntry> observer)	Streams back commands
final void	subscribeCommands(Void ctx, SubscribeCommandsRequest request, Observer<Commanding.CommandHistoryEntry> observer)	Receive updates on issued commands
final void	updateCommandHistory(Void ctx, UpdateCommandHistoryRequest request, Observer<com.google.protobuf.Empty> observer)	Update command history

Methods inherited from class org.yamcs.protobuf.AbstractCommandsApi

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

CommandsApiClient

public CommandsApiClient(MethodHandler handler)

Method Details

issueCommand

public final void issueCommand(Void ctx,
 IssueCommandRequest request,
 Observer<IssueCommandResponse> observer)

  Issue a command
 
  After validating the input parameters, the command is added to the appropriate
  command queue for further dispatch.
 

Specified by:

issueCommand in class AbstractCommandsApi<Void>

updateCommandHistory

public final void updateCommandHistory(Void ctx,
 UpdateCommandHistoryRequest request,
 Observer<com.google.protobuf.Empty> observer)

  Update command history
 

Specified by:

updateCommandHistory in class AbstractCommandsApi<Void>

listCommands

public final void listCommands(Void ctx,
 ListCommandsRequest request,
 Observer<ListCommandsResponse> observer)

  List commands
 

Specified by:

listCommands in class AbstractCommandsApi<Void>

getCommand

public final void getCommand(Void ctx,
 GetCommandRequest request,
 Observer<Commanding.CommandHistoryEntry> observer)

  Get a command
 

Specified by:

getCommand in class AbstractCommandsApi<Void>

streamCommands

public final void streamCommands(Void ctx,
 StreamCommandsRequest request,
 Observer<Commanding.CommandHistoryEntry> observer)

  Streams back commands
 

Specified by:

streamCommands in class AbstractCommandsApi<Void>

subscribeCommands

public final void subscribeCommands(Void ctx,
 SubscribeCommandsRequest request,
 Observer<Commanding.CommandHistoryEntry> observer)

  Receive updates on issued commands
 

Specified by:

subscribeCommands in class AbstractCommandsApi<Void>

exportCommand

public final void exportCommand(Void ctx,
 ExportCommandRequest request,
 Observer<HttpBody> observer)

  Export a raw command
 

Specified by:

exportCommand in class AbstractCommandsApi<Void>

exportCommands

public final void exportCommands(Void ctx,
 ExportCommandsRequest request,
 Observer<HttpBody> observer)

  Export commands in CSV format
 

Specified by:

exportCommands in class AbstractCommandsApi<Void>