Module org.yamcs.api

Package org.yamcs.protobuf

Class ParameterValuesApiClient

java.lang.Object

org.yamcs.protobuf.AbstractParameterValuesApi<Void>

org.yamcs.protobuf.ParameterValuesApiClient

All Implemented Interfaces:

Api<Void>

@Generated(value="org.yamcs.maven.ServiceGenerator",
           date="2026-08-05T11:34:19.227695564Z")
public class ParameterValuesApiClient
extends AbstractParameterValuesApi<Void>

Constructor Summary

Constructors

Constructor	Description
ParameterValuesApiClient(MethodHandler handler)

Method Summary

Modifier and Type	Method	Description
final void	exportParameterValues(Void ctx, ExportParameterValuesRequest request, Observer<HttpBody> observer)	Export parameter values in CSV format
final void	getParameterRanges(Void ctx, GetParameterRangesRequest request, Observer<Pvalue.Ranges> observer)	Get parameter ranges A range is a tuple `(start, stop, value, count)` that represents the time interval for which the parameter has been steadily coming in with the same value.
final void	getParameterSamples(Void ctx, GetParameterSamplesRequest request, Observer<Pvalue.TimeSeries> observer)	Get parameter samples This divides the query interval in a number of intervals and returns aggregated statistics (max, min, avg) about each interval.
final void	listParameterGroups(Void ctx, ListParameterGroupsRequest request, Observer<ListParameterGroupsResponse> observer)	List parameter groups
final void	listParameterHistory(Void ctx, ListParameterHistoryRequest request, Observer<ListParameterHistoryResponse> observer)	List parameter history
final Observer<LoadParameterValuesRequest>	loadParameterValues(Void ctx, Observer<LoadParameterValuesResponse> observer)	Load (inject) a stream of parameter values
final void	streamParameterValues(Void ctx, StreamParameterValuesRequest request, Observer<Pvalue.ParameterData> observer)	Streams back parameter values

Methods inherited from class org.yamcs.protobuf.AbstractParameterValuesApi

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

ParameterValuesApiClient

public ParameterValuesApiClient(MethodHandler handler)

Method Details

listParameterHistory

public final void listParameterHistory(Void ctx,
 ListParameterHistoryRequest request,
 Observer<ListParameterHistoryResponse> observer)

  List parameter history
 

Specified by:

listParameterHistory in class AbstractParameterValuesApi<Void>

exportParameterValues

public final void exportParameterValues(Void ctx,
 ExportParameterValuesRequest request,
 Observer<HttpBody> observer)

  Export parameter values in CSV format
 

Specified by:

exportParameterValues in class AbstractParameterValuesApi<Void>

streamParameterValues

public final void streamParameterValues(Void ctx,
 StreamParameterValuesRequest request,
 Observer<Pvalue.ParameterData> observer)

  Streams back parameter values
 

Specified by:

streamParameterValues in class AbstractParameterValuesApi<Void>

loadParameterValues

public final Observer<LoadParameterValuesRequest> loadParameterValues(Void ctx,
 Observer<LoadParameterValuesResponse> observer)

  Load (inject) a stream of parameter values
 

Specified by:

loadParameterValues in class AbstractParameterValuesApi<Void>

getParameterSamples

public final void getParameterSamples(Void ctx,
 GetParameterSamplesRequest request,
 Observer<Pvalue.TimeSeries> observer)

  Get parameter samples
 
  This divides the query interval in a number of intervals and returns aggregated
  statistics (max, min, avg) about each interval.
 
  This operation is useful when making high-level overviews (such as plots) of a
  parameter's value over large time intervals without having to retrieve each
  and every individual parameter value.
 
  By default this operation fetches data from the parameter archive and/or
  parameter cache. If these services are not configured, you can still get
  correct results by specifying the option `source=replay` as detailed below.
 

Specified by:

getParameterSamples in class AbstractParameterValuesApi<Void>

getParameterRanges

public final void getParameterRanges(Void ctx,
 GetParameterRangesRequest request,
 Observer<Pvalue.Ranges> observer)

  Get parameter ranges
 
  A range is a tuple `(start, stop, value, count)` that represents the time
  interval for which the parameter has been steadily coming in with the same
  value. This request is useful for retrieving an overview for parameters that
  change unfrequently in a large time interval. For example an on/off status
  of a device, or some operational status. Two consecutive ranges containing
  the same value will be returned if there was a gap in the data. The gap is
  determined according to the parameter expiration time configured in the
  Mission Database.
 

Specified by:

getParameterRanges in class AbstractParameterValuesApi<Void>

listParameterGroups

public final void listParameterGroups(Void ctx,
 ListParameterGroupsRequest request,
 Observer<ListParameterGroupsResponse> observer)

  List parameter groups
 

Specified by:

listParameterGroups in class AbstractParameterValuesApi<Void>