Module org.yamcs.api

Package org.yamcs.protobuf.alarms

Class AlarmsApiClient

java.lang.Object

org.yamcs.protobuf.alarms.AbstractAlarmsApi<Void>

org.yamcs.protobuf.alarms.AlarmsApiClient

All Implemented Interfaces:

Api<Void>

@Generated(value="org.yamcs.protoc.ServiceGenerator",
           date="2023-09-18T00:21:24.539612436Z")
public class AlarmsApiClient
extends AbstractAlarmsApi<Void>

Constructor Summary

Constructors

Constructor	Description
AlarmsApiClient(MethodHandler handler)

Method Summary

Modifier and Type	Method	Description
final void	acknowledgeAlarm(Void ctx, AcknowledgeAlarmRequest request, Observer<com.google.protobuf.Empty> observer)	Acknowledge an alarm
final void	clearAlarm(Void ctx, ClearAlarmRequest request, Observer<com.google.protobuf.Empty> observer)	Clear an alarm
final void	editAlarm(Void ctx, EditAlarmRequest request, Observer<com.google.protobuf.Empty> observer)	Update an alarm
final void	listAlarms(Void ctx, ListAlarmsRequest request, Observer<ListAlarmsResponse> observer)	List alarms
final void	listProcessorAlarms(Void ctx, ListProcessorAlarmsRequest request, Observer<ListProcessorAlarmsResponse> observer)	List alarms
final void	shelveAlarm(Void ctx, ShelveAlarmRequest request, Observer<com.google.protobuf.Empty> observer)	Shelve an alarm
final void	subscribeAlarms(Void ctx, SubscribeAlarmsRequest request, Observer<AlarmData> observer)	Receive alarm updates
final void	subscribeGlobalStatus(Void ctx, SubscribeGlobalStatusRequest request, Observer<GlobalAlarmStatus> observer)	Receive alarm status updates
final void	unshelveAlarm(Void ctx, UnshelveAlarmRequest request, Observer<com.google.protobuf.Empty> observer)	Unshelve an alarm

Methods inherited from class org.yamcs.protobuf.alarms.AbstractAlarmsApi

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

AlarmsApiClient

public AlarmsApiClient(MethodHandler handler)

Method Details

listAlarms

public final void listAlarms(Void ctx,
 ListAlarmsRequest request,
 Observer<ListAlarmsResponse> observer)

  List alarms
 

Specified by:

listAlarms in class AbstractAlarmsApi<Void>

listProcessorAlarms

public final void listProcessorAlarms(Void ctx,
 ListProcessorAlarmsRequest request,
 Observer<ListProcessorAlarmsResponse> observer)

  List alarms
 

Specified by:

listProcessorAlarms in class AbstractAlarmsApi<Void>

editAlarm

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

  Update an alarm
 

Specified by:

editAlarm in class AbstractAlarmsApi<Void>

acknowledgeAlarm

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

  Acknowledge an alarm
 

Specified by:

acknowledgeAlarm in class AbstractAlarmsApi<Void>

shelveAlarm

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

  Shelve an alarm
 

Specified by:

shelveAlarm in class AbstractAlarmsApi<Void>

unshelveAlarm

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

  Unshelve an alarm
 

Specified by:

unshelveAlarm in class AbstractAlarmsApi<Void>

clearAlarm

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

  Clear an alarm
 

Specified by:

clearAlarm in class AbstractAlarmsApi<Void>

subscribeGlobalStatus

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

  Receive alarm status updates
 

Specified by:

subscribeGlobalStatus in class AbstractAlarmsApi<Void>

subscribeAlarms

public final void subscribeAlarms(Void ctx,
 SubscribeAlarmsRequest request,
 Observer<AlarmData> observer)

  Receive alarm updates
 

Specified by:

subscribeAlarms in class AbstractAlarmsApi<Void>