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.protoc.ServiceGenerator",
           date="2024-03-05T16:49:10.430578176Z")
public abstract class AbstractActivitiesApi<T>
extends Object
implements Api<T>

Constructor Summary

Constructors

Constructor	Description
AbstractActivitiesApi()

Method Summary

Modifier and Type	Method	Description
final void	callMethod(com.google.protobuf.Descriptors.MethodDescriptor method, T ctx, com.google.protobuf.Message request, Observer<com.google.protobuf.Message> future)
final Observer<com.google.protobuf.Message>	callMethod(com.google.protobuf.Descriptors.MethodDescriptor method, T ctx, Observer<com.google.protobuf.Message> future)
abstract void	cancelActivity(T ctx, CancelActivityRequest request, Observer<ActivityInfo> observer)	Cancel an ongoing activity
abstract void	completeManualActivity(T ctx, CompleteManualActivityRequest request, Observer<ActivityInfo> observer)	Mark an ongoing activity as completed.
abstract void	getActivity(T ctx, GetActivityRequest request, Observer<ActivityInfo> observer)	Get an activity
abstract void	getActivityLog(T ctx, GetActivityLogRequest request, Observer<GetActivityLogResponse> observer)	Get the activity log
final com.google.protobuf.Descriptors.ServiceDescriptor	getDescriptorForType()
final com.google.protobuf.Message	getRequestPrototype(com.google.protobuf.Descriptors.MethodDescriptor method)
final com.google.protobuf.Message	getResponsePrototype(com.google.protobuf.Descriptors.MethodDescriptor method)
abstract void	listActivities(T ctx, ListActivitiesRequest request, Observer<ListActivitiesResponse> observer)	List activities
abstract void	listExecutors(T ctx, ListExecutorsRequest request, Observer<ListExecutorsResponse> observer)	List available executors
abstract void	listScripts(T ctx, ListScriptsRequest request, Observer<ListScriptsResponse> observer)	List scripts available for activities of type SCRIPT
abstract void	startActivity(T ctx, StartActivityRequest request, Observer<ActivityInfo> observer)	Start an activity
abstract void	subscribeActivities(T ctx, SubscribeActivitiesRequest request, Observer<ActivityInfo> observer)	Receive activity updates
abstract void	subscribeActivityLog(T ctx, SubscribeActivityLogRequest request, Observer<ActivityLogInfo> observer)	Receive activity log updates
abstract void	subscribeGlobalStatus(T ctx, SubscribeGlobalStatusRequest request, Observer<GlobalActivityStatus> observer)	Receive activity status updates

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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
 

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.
 

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
 

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>