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

Class ParameterArchiveApiClient

java.lang.Object
org.yamcs.protobuf.AbstractParameterArchiveApi<Void>
org.yamcs.protobuf.ParameterArchiveApiClient
All Implemented Interfaces:
Api<Void>
@Generated(value="org.yamcs.maven.ServiceGenerator", date="2026-08-31T06:45:28.033796787Z") public class ParameterArchiveApiClient extends AbstractParameterArchiveApi<Void>

  • Constructor Details

    • ParameterArchiveApiClient

      public ParameterArchiveApiClient(MethodHandler handler)

  • Method Details

    • rebuildRange

      public final void rebuildRange(Void ctx, RebuildRangeRequest request, Observer<com.google.protobuf.Empty> observer)
        Rebuild range
 
  The back filler has to be enabled for this purpose. The back filling process does not
  remove data but just overwrites it. That means that if the parameter replay returns
  less parameters than originally stored in the archive, the old parameters will still
  be found in the archive.
 
  It also means that if a replay returns the parameter of a different type than
  originally stored, the old ones will still be stored. This is because the parameter
  archive treats parameter with the same name but different type as different parameters.
  Each of them is given an id and the id is stored in the archive.
      Specified by:
      rebuildRange in class AbstractParameterArchiveApi<Void>

    • getArchivedParametersInfo

      public final void getArchivedParametersInfo(Void ctx, GetArchivedParametersInfoRequest request, Observer<ArchivedParametersInfoResponse> observer)
        Get information about the archived parameters.
 
  Each combination of (parameter name, raw type, engineering type) is assigned a
  unique parameter id.
  
  The parameters are grouped such that the samples of all parameters from one group
  have the same timestamp. For example all parameters extracted from one TM packet
  have usually the same timestamp and are part of the same group.
 
  Each group is assigned a unique group id.
 
  A parameter can be part of multiple groups. For instance a parameter appearing
  in the header of a packet is part of all groups made by inherited containers
  (i.e. each packet with that header will compose another group).
 
  For each group, the parameter archive stores one common record for the timestamps
  and individual records for the raw and engineering values of each parameter. If a
  parameter appears in multiple groups, retrieving its value means combining
  (time-based merge operation) the records belonging to the groups in which the
  parameter appears.
 
  The response to this method contains the parameter id, name, engineering type,
  raw type and the groups of which this parameter is part of.
      Specified by:
      getArchivedParametersInfo in class AbstractParameterArchiveApi<Void>

    • getArchivedParameterSegments

      public final void getArchivedParameterSegments(Void ctx, GetArchivedParameterSegmentsRequest request, Observer<ArchivedParameterSegmentsResponse> observer)
        For a given parameter id, get the list of segments available for that parameter.
  A segment contains multiple samples (maximum ~70 minutes) of the same parameter.
      Specified by:
      getArchivedParameterSegments in class AbstractParameterArchiveApi<Void>

    • getArchivedParameterGroup

      public final void getArchivedParameterGroup(Void ctx, GetArchivedParameterGroupRequest request, Observer<ArchivedParameterGroupResponse> observer)
        For a given group id, get the list of parameters which are part of the group
      Specified by:
      getArchivedParameterGroup in class AbstractParameterArchiveApi<Void>

    • purge

      public final void purge(Void ctx, PurgeRequest request, Observer<com.google.protobuf.Empty> observer)
        Removes all the parameter archive data and related metadata. All the
  backfilling operations are stopped beforeh and started after the purge.
 
  The rebuild operation has to be called to rebuild the past segments of
  the archive.
 
  Starting with Yamcs 5.9.0 the Parameter Archive is stored into a
  different column family `parameter_archive`. This provides better
  performance and renders the Parameter Archive rebuild operations
  less disturbing for other data (TM, TC, Events...). If the archive
  dates back to a previous version of Yamcs, the purge/rebuild methods
  can be used to move the Parameter Archive from the default column
  family to the separate column family.
      Specified by:
      purge in class AbstractParameterArchiveApi<Void>

    • disableBackfilling

      public final void disableBackfilling(Void ctx, DisableBackfillingRequest request, Observer<com.google.protobuf.Empty> observer)
        Disables the automatic backfilling (rebuilding) of the parameter archive.
  
  If the backfilling is already disabled, this operation has no effect.
 
  If a backfilling is ongoing, this call will not stop it. 
 
  Manual rebuild operations are still accepted.
      Specified by:
      disableBackfilling in class AbstractParameterArchiveApi<Void>

    • enableBackfilling

      public final void enableBackfilling(Void ctx, EnableBackfillingRequest request, Observer<com.google.protobuf.Empty> observer)
        Enables the automatic backfilling (rebuilding) of the parameter archive.
  
  If the backfilling is already enabled, this operation has no effect.
      Specified by:
      enableBackfilling in class AbstractParameterArchiveApi<Void>

    • subscribeBackfilling

      public final void subscribeBackfilling(Void ctx, SubscribeBackfillingRequest request, Observer<SubscribeBackfillingData> observer)
        Receive backfill notifications
      Specified by:
      subscribeBackfilling in class AbstractParameterArchiveApi<Void>