Module org.yamcs.api

Package org.yamcs.protobuf.activities

Class ActivitiesApiClient

java.lang.Object

org.yamcs.protobuf.activities.AbstractActivitiesApi<Void>

org.yamcs.protobuf.activities.ActivitiesApiClient

All Implemented Interfaces:

Api<Void>

@Generated(value="org.yamcs.protoc.ServiceGenerator",
           date="2024-05-24T07:49:13.472041600Z")
public class ActivitiesApiClient
extends AbstractActivitiesApi<Void>

Constructor Summary

Constructors

Constructor	Description
ActivitiesApiClient(MethodHandler handler)

Method Summary

Modifier and Type	Method	Description
final void	cancelActivity(Void ctx, CancelActivityRequest request, Observer<ActivityInfo> observer)	Cancel an ongoing activity
final void	completeManualActivity(Void ctx, CompleteManualActivityRequest request, Observer<ActivityInfo> observer)	Mark an ongoing activity as completed.
final void	getActivity(Void ctx, GetActivityRequest request, Observer<ActivityInfo> observer)	Get an activity
final void	getActivityLog(Void ctx, GetActivityLogRequest request, Observer<GetActivityLogResponse> observer)	Get the activity log
final void	listActivities(Void ctx, ListActivitiesRequest request, Observer<ListActivitiesResponse> observer)	List activities
final void	listExecutors(Void ctx, ListExecutorsRequest request, Observer<ListExecutorsResponse> observer)	List available executors
final void	listScripts(Void ctx, ListScriptsRequest request, Observer<ListScriptsResponse> observer)	List scripts available for activities of type SCRIPT
final void	startActivity(Void ctx, StartActivityRequest request, Observer<ActivityInfo> observer)	Start an activity The request body allows for the execution of arbitrary activities.
final void	subscribeActivities(Void ctx, SubscribeActivitiesRequest request, Observer<ActivityInfo> observer)	Receive activity updates
final void	subscribeActivityLog(Void ctx, SubscribeActivityLogRequest request, Observer<ActivityLogInfo> observer)	Receive activity log updates
final void	subscribeGlobalStatus(Void ctx, SubscribeGlobalStatusRequest request, Observer<GlobalActivityStatus> observer)	Receive activity status updates

Methods inherited from class org.yamcs.protobuf.activities.AbstractActivitiesApi

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

ActivitiesApiClient

public ActivitiesApiClient(MethodHandler handler)

Method Details

listActivities

public final void listActivities(Void ctx,
 ListActivitiesRequest request,
 Observer<ListActivitiesResponse> observer)

  List activities
 

Specified by:

listActivities in class AbstractActivitiesApi<Void>

getActivity

public final void getActivity(Void ctx,
 GetActivityRequest request,
 Observer<ActivityInfo> observer)

  Get an activity
 

Specified by:

getActivity in class AbstractActivitiesApi<Void>

getActivityLog

public final void getActivityLog(Void ctx,
 GetActivityLogRequest request,
 Observer<GetActivityLogResponse> observer)

  Get the activity log
 

Specified by:

getActivityLog in class AbstractActivitiesApi<Void>

startActivity

public final void startActivity(Void ctx,
 StartActivityRequest request,
 Observer<ActivityInfo> observer)

  Start an activity
 
  The request body allows for the execution of arbitrary activities.
  The following activity types are included in the core Yamcs module:
 
  .. rubric:: Command
 
  Execute a single command
 
  ``type`` (string)
      Set to ``COMMAND``.
 
  ``args`` (map)
      Map accepting the following options:
 
      ``command``
          **Required.** Qualified name of a command
 
      ``args`` (map)
          Named arguments, if the command requires any
 
      ``extra`` (map)
          Extra command options
 
      ``processor`` (string)
          Optional processor name. If not provided, Yamcs defaults
          to any processor it can find with commanding enabled.
 
  Example:
 
  .. code-block:: json
 
      {
          "type": "COMMAND",
          "args": {
              "command": "/YSS/SIMULATOR/SWITCH_VOLTAGE_ON",
              "args": {
                  "voltage_num": 3
              },
              "processor": "realtime"
          }
      }
 
  .. rubric:: Command Stack
 
  Execute a command stack
 
  ``type`` (string)
      Set to ``COMMAND_STACK``.
 
  ``args`` (map)
      Map accepting the following options:
 
      ``bucket``
          **Required.** The name of the bucket containg the stack
 
      ``stack``
          **Required.** The name of the stack object inside the bucket
 
      ``processor`` (string)
          Optional processor name. If not provided, Yamcs defaults
          to any processor it can find with commanding enabled.
 
  Example:
 
  .. code-block:: json
 
      {
          "type": "COMMAND_STACK",
          "args": {
              "bucket": "mybucket",
              "stack": "mystack.ycs",
              "processor": "realtime"
          }
      }
 
  .. rubric:: Script
 
  Run a script
 
  ``type`` (string)
      Set to ``SCRIPT``.
  ``args`` (map)
      Map accepting the following options:
 
      ``script``
          **Required.** Script identifier.
 
          This should be the relative path to an executable file in one of the
          search locations. When unconfigured, the default search location is
          :file:`etc/scripts/` relative to the Yamcs working directory.
 
      ``args`` (string or string[])
          Script arguments
 
      ``processor`` (string)
          If provided, this information is passed to the script in an environment
          variable ``YAMCS_PROCESSOR``.
 
  Example:
 
  .. code-block:: json
 
      {
          "type": "SCRIPT",
          "args": {
              "script": "simulate_los.py",
              "args": "--duration 60",
              "processor": "realtime"
          }
      }
 

Specified by:

startActivity in class AbstractActivitiesApi<Void>

cancelActivity

public final void cancelActivity(Void ctx,
 CancelActivityRequest request,
 Observer<ActivityInfo> observer)

  Cancel an ongoing activity
 

Specified by:

cancelActivity in class AbstractActivitiesApi<Void>

completeManualActivity

public final void completeManualActivity(Void ctx,
 CompleteManualActivityRequest request,
 Observer<ActivityInfo> observer)

  Mark an ongoing activity as completed.
 
  This method may only be used with manual activities.
 

Specified by:

completeManualActivity in class AbstractActivitiesApi<Void>

subscribeGlobalStatus

public final void subscribeGlobalStatus(Void ctx,
 SubscribeGlobalStatusRequest request,
 Observer<GlobalActivityStatus> observer)

  Receive activity status updates
 

Specified by:

subscribeGlobalStatus in class AbstractActivitiesApi<Void>

subscribeActivities

public final void subscribeActivities(Void ctx,
 SubscribeActivitiesRequest request,
 Observer<ActivityInfo> observer)

  Receive activity updates
 

Specified by:

subscribeActivities in class AbstractActivitiesApi<Void>

subscribeActivityLog

public final void subscribeActivityLog(Void ctx,
 SubscribeActivityLogRequest request,
 Observer<ActivityLogInfo> observer)

  Receive activity log updates
 

Specified by:

subscribeActivityLog in class AbstractActivitiesApi<Void>

listExecutors

public final void listExecutors(Void ctx,
 ListExecutorsRequest request,
 Observer<ListExecutorsResponse> observer)

  List available executors
 

Specified by:

listExecutors in class AbstractActivitiesApi<Void>

listScripts

public final void listScripts(Void ctx,
 ListScriptsRequest request,
 Observer<ListScriptsResponse> observer)

  List scripts available for activities of type SCRIPT
 

Specified by:

listScripts in class AbstractActivitiesApi<Void>