Module org.yamcs.api
Package org.yamcs.protobuf.activities

Class AbstractActivitiesApi<T>

java.lang.Object
org.yamcs.protobuf.activities.AbstractActivitiesApi<T>
All Implemented Interfaces:
Api<T>
Direct Known Subclasses:
ActivitiesApiClient
@Generated(value="org.yamcs.maven.ServiceGenerator", date="2026-08-31T06:45:28.035160703Z") public abstract class AbstractActivitiesApi<T> extends Object implements Api<T>

  • Constructor Details

    • AbstractActivitiesApi

      public AbstractActivitiesApi()

  • Method Details

    • listActivities

      public abstract void listActivities(T ctx, ListActivitiesRequest request, Observer<ListActivitiesResponse> observer)
        List activities

    • getActivity

      public abstract void getActivity(T ctx, GetActivityRequest request, Observer<ActivityInfo> observer)
        Get an activity

    • getActivityLog

      public abstract void getActivityLog(T ctx, GetActivityLogRequest request, Observer<GetActivityLogResponse> observer)
        Get the activity log

    • startActivity

      public abstract void startActivity(T ctx, StartActivityRequest request, Observer<ActivityInfo> observer)
        Start an activity
 
  The request body allows for the execution of arbitrary activities.
 
  | Key             | Value                               |
  | --------------- | ----------------------------------- |
  | `type` (string) | Activity type                       |
  | `args` (map)    | Map accepting type-specific options |
 
  The following activity types are included in the core Yamcs module:
 
  * `COMMAND`: Execute a single command
 
    Args:
    * `command` (string): **Required.** Qualified name of a command
    * `args` (map):  Named arguments, if the command requires any
    * `extra` (map): Extra command options
    * `processor` (string): Processor name. If not provided, Yamcs
      defaults to any processor it can find with commanding enabled.
 
    Example:
    ```json
    {
      "type": "COMMAND",
      "args": {
        "command": "/YSS/SIMULATOR/SWITCH_VOLTAGE_ON",
        "args": {
          "voltage_num": 3
        },
        "processor": "realtime"
      }
    }
    ```
 
  * `STACK`: Execute a stack
 
    Args:
    * `bucket` (string): **Required.** The name of the bucket containg the stack
    * `stack` (string): **Required.** The name of the stack object inside the bucket
    * `processor` (string): Processor name. If not provided, Yamcs defaults
      to any processor it can find with commanding enabled.
 
    Example:
    ```json
    {
      "type": "STACK",
      "args": {
        "bucket": "mybucket",
        "stack": "mystack.ycs",
        "processor": "realtime"
      }
    }
    ```
 
  * `SCRIPT`: Run a script
 
    Args:
    * `script` (string): **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
      `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`.
    * `runner` (string): In case of multiple script runners, you can provide
      this field, to indicate which runner this script execution applies to.
 
    Example:
    ```json
    {
      "type": "SCRIPT",
      "args": {
        "script": "simulate_los.py",
        "args": "--duration 60",
        "processor": "realtime"
      }
    }
    ```

    • cancelActivity

      public abstract void cancelActivity(T ctx, CancelActivityRequest request, Observer<ActivityInfo> observer)
        Cancel an ongoing activity

    • completeManualActivity

      public abstract void completeManualActivity(T ctx, CompleteManualActivityRequest request, Observer<ActivityInfo> observer)
        Mark an ongoing activity as completed.
 
  This method may only be used with manual activities.

    • addLogMessage

      public abstract void addLogMessage(T ctx, AddLogMessageRequest request, Observer<com.google.protobuf.Empty> observer)
        Add a message to the activity log

    • subscribeGlobalStatus

      public abstract void subscribeGlobalStatus(T ctx, SubscribeGlobalStatusRequest request, Observer<GlobalActivityStatus> observer)
        Receive activity status updates

    • subscribeActivities

      public abstract void subscribeActivities(T ctx, SubscribeActivitiesRequest request, Observer<ActivityInfo> observer)
        Receive activity updates

    • subscribeActivityLog

      public abstract void subscribeActivityLog(T ctx, SubscribeActivityLogRequest request, Observer<ActivityLogInfo> observer)
        Receive activity log updates

    • listExecutors

      public abstract void listExecutors(T ctx, ListExecutorsRequest request, Observer<ListExecutorsResponse> observer)
        List available executors

    • listScriptRunners

      public abstract void listScriptRunners(T ctx, ListScriptRunnersRequest request, Observer<ListScriptRunnersResponse> observer)
        List script runners available for activities of type SCRIPT

    • listScripts

      public abstract void listScripts(T ctx, ListScriptsRequest request, Observer<ListScriptsResponse> observer)
        List scripts available for activities of type SCRIPT

    • 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>