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

Interface ListParameterHistoryRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ListParameterHistoryRequest, ListParameterHistoryRequest.Builder
@Generated public interface ListParameterHistoryRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getInstance()
    Yamcs instance name
    com.google.protobuf.ByteString
    getInstanceBytes()
    Yamcs instance name
    int
    getLimit()
    The maximum number of returned records per page.
    int
    getMaxBytes()
    If set, truncate binary values to the specified byte length.
    String
    getName()
    Parameter name
    com.google.protobuf.ByteString
    getNameBytes()
    Parameter name
    String
    getNext()
    Continuation token returned by a previous page response.
    com.google.protobuf.ByteString
    getNextBytes()
    Continuation token returned by a previous page response.
    boolean
    getNorealtime()
    Disable loading of parameters from the parameter cache.
    boolean
    getNorepeat()
    Whether to filter out consecutive identical values.
    boolean
    getNoreplay()
    Do not perform a replay if the `source=ParameterArchive` and the Parameter Archive does not cover the last part of the requested time interval.
    String
    getOrder()
    The order of the returned results.
    com.google.protobuf.ByteString
    getOrderBytes()
    The order of the returned results.
    long
    getPos()
    The zero-based row number at which to start outputting results.
    String
    getProcessor()
    The name of the processor from which to use the parameter cache.
    com.google.protobuf.ByteString
    getProcessorBytes()
    The name of the processor from which to use the parameter cache.
    String
    getSource()
    Specifies how to retrieve the parameters.
    com.google.protobuf.ByteString
    getSourceBytes()
    Specifies how to retrieve the parameters.
    com.google.protobuf.Timestamp
    getStart()
    Filter the lower bound of the parameter's generation time.
    com.google.protobuf.TimestampOrBuilder
    getStartOrBuilder()
    Filter the lower bound of the parameter's generation time.
    com.google.protobuf.Timestamp
    getStop()
    Filter the upper bound of the parameter's generation time.
    com.google.protobuf.TimestampOrBuilder
    getStopOrBuilder()
    Filter the upper bound of the parameter's generation time.
    boolean
    hasInstance()
    Yamcs instance name
    boolean
    hasLimit()
    The maximum number of returned records per page.
    boolean
    hasMaxBytes()
    If set, truncate binary values to the specified byte length.
    boolean
    hasName()
    Parameter name
    boolean
    hasNext()
    Continuation token returned by a previous page response.
    boolean
    hasNorealtime()
    Disable loading of parameters from the parameter cache.
    boolean
    hasNorepeat()
    Whether to filter out consecutive identical values.
    boolean
    hasNoreplay()
    Do not perform a replay if the `source=ParameterArchive` and the Parameter Archive does not cover the last part of the requested time interval.
    boolean
    hasOrder()
    The order of the returned results.
    boolean
    hasPos()
    The zero-based row number at which to start outputting results.
    boolean
    hasProcessor()
    The name of the processor from which to use the parameter cache.
    boolean
    hasSource()
    Specifies how to retrieve the parameters.
    boolean
    hasStart()
    Filter the lower bound of the parameter's generation time.
    boolean
    hasStop()
    Filter the upper bound of the parameter's generation time.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • hasInstance

      boolean hasInstance()
       Yamcs instance name
      optional string instance = 1;
      Returns:
      Whether the instance field is set.

    • getInstance

      String getInstance()
       Yamcs instance name
      optional string instance = 1;
      Returns:
      The instance.

    • getInstanceBytes

      com.google.protobuf.ByteString getInstanceBytes()
       Yamcs instance name
      optional string instance = 1;
      Returns:
      The bytes for instance.

    • hasName

      boolean hasName()
       Parameter name
      optional string name = 2;
      Returns:
      Whether the name field is set.

    • getName

      String getName()
       Parameter name
      optional string name = 2;
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Parameter name
      optional string name = 2;
      Returns:
      The bytes for name.

    • hasPos

      boolean hasPos()
       The zero-based row number at which to start outputting results. Default: `0`.
      optional int64 pos = 3;
      Returns:
      Whether the pos field is set.

    • getPos

      long getPos()
       The zero-based row number at which to start outputting results. Default: `0`.
      optional int64 pos = 3;
      Returns:
      The pos.

    • hasLimit

      boolean hasLimit()
       The maximum number of returned records per page. Choose this value too high
 and you risk hitting the maximum response size limit enforced by the server.
 Default: `100`.
      optional int32 limit = 4;
      Returns:
      Whether the limit field is set.

    • getLimit

      int getLimit()
       The maximum number of returned records per page. Choose this value too high
 and you risk hitting the maximum response size limit enforced by the server.
 Default: `100`.
      optional int32 limit = 4;
      Returns:
      The limit.

    • hasNorepeat

      boolean hasNorepeat()
       Whether to filter out consecutive identical values. Default `no`.
      optional bool norepeat = 5;
      Returns:
      Whether the norepeat field is set.

    • getNorepeat

      boolean getNorepeat()
       Whether to filter out consecutive identical values. Default `no`.
      optional bool norepeat = 5;
      Returns:
      The norepeat.

    • hasStart

      boolean hasStart()
       Filter the lower bound of the parameter's generation time. Specify a date
 string in ISO 8601 format.
      optional .google.protobuf.Timestamp start = 6;
      Returns:
      Whether the start field is set.

    • getStart

      com.google.protobuf.Timestamp getStart()
       Filter the lower bound of the parameter's generation time. Specify a date
 string in ISO 8601 format.
      optional .google.protobuf.Timestamp start = 6;
      Returns:
      The start.

    • getStartOrBuilder

      com.google.protobuf.TimestampOrBuilder getStartOrBuilder()
       Filter the lower bound of the parameter's generation time. Specify a date
 string in ISO 8601 format.
      optional .google.protobuf.Timestamp start = 6;

    • hasStop

      boolean hasStop()
       Filter the upper bound of the parameter's generation time. Specify a date
 string in ISO 8601 format.
      optional .google.protobuf.Timestamp stop = 7;
      Returns:
      Whether the stop field is set.

    • getStop

      com.google.protobuf.Timestamp getStop()
       Filter the upper bound of the parameter's generation time. Specify a date
 string in ISO 8601 format.
      optional .google.protobuf.Timestamp stop = 7;
      Returns:
      The stop.

    • getStopOrBuilder

      com.google.protobuf.TimestampOrBuilder getStopOrBuilder()
       Filter the upper bound of the parameter's generation time. Specify a date
 string in ISO 8601 format.
      optional .google.protobuf.Timestamp stop = 7;

    • hasOrder

      boolean hasOrder()
       The order of the returned results. Can be either `asc` or `desc`.
 Default: `desc`.
      optional string order = 8;
      Returns:
      Whether the order field is set.

    • getOrder

      String getOrder()
       The order of the returned results. Can be either `asc` or `desc`.
 Default: `desc`.
      optional string order = 8;
      Returns:
      The order.

    • getOrderBytes

      com.google.protobuf.ByteString getOrderBytes()
       The order of the returned results. Can be either `asc` or `desc`.
 Default: `desc`.
      optional string order = 8;
      Returns:
      The bytes for order.

    • hasNorealtime

      boolean hasNorealtime()
       Disable loading of parameters from the parameter cache. Default: `false`.
      optional bool norealtime = 9;
      Returns:
      Whether the norealtime field is set.

    • getNorealtime

      boolean getNorealtime()
       Disable loading of parameters from the parameter cache. Default: `false`.
      optional bool norealtime = 9;
      Returns:
      The norealtime.

    • hasProcessor

      boolean hasProcessor()
       The name of the processor from which to use the parameter cache.
 Default: `realtime`.
      optional string processor = 10;
      Returns:
      Whether the processor field is set.

    • getProcessor

      String getProcessor()
       The name of the processor from which to use the parameter cache.
 Default: `realtime`.
      optional string processor = 10;
      Returns:
      The processor.

    • getProcessorBytes

      com.google.protobuf.ByteString getProcessorBytes()
       The name of the processor from which to use the parameter cache.
 Default: `realtime`.
      optional string processor = 10;
      Returns:
      The bytes for processor.

    • hasSource

      boolean hasSource()
       Specifies how to retrieve the parameters. Either `ParameterArchive` or
 `replay`. If `replay` is specified, a replay processor will be created
 and data will be processed with the active Mission Database. Note that this
 is much slower than receiving data from the Parameter Archive.

 Default: `ParameterArchive`.
      optional string source = 11;
      Returns:
      Whether the source field is set.

    • getSource

      String getSource()
       Specifies how to retrieve the parameters. Either `ParameterArchive` or
 `replay`. If `replay` is specified, a replay processor will be created
 and data will be processed with the active Mission Database. Note that this
 is much slower than receiving data from the Parameter Archive.

 Default: `ParameterArchive`.
      optional string source = 11;
      Returns:
      The source.

    • getSourceBytes

      com.google.protobuf.ByteString getSourceBytes()
       Specifies how to retrieve the parameters. Either `ParameterArchive` or
 `replay`. If `replay` is specified, a replay processor will be created
 and data will be processed with the active Mission Database. Note that this
 is much slower than receiving data from the Parameter Archive.

 Default: `ParameterArchive`.
      optional string source = 11;
      Returns:
      The bytes for source.

    • hasNoreplay

      boolean hasNoreplay()
       Do not perform a replay if the `source=ParameterArchive` and the Parameter
 Archive does not cover the last part of the requested time interval.

 Default: `false`.
      optional bool noreplay = 14;
      Returns:
      Whether the noreplay field is set.

    • getNoreplay

      boolean getNoreplay()
       Do not perform a replay if the `source=ParameterArchive` and the Parameter
 Archive does not cover the last part of the requested time interval.

 Default: `false`.
      optional bool noreplay = 14;
      Returns:
      The noreplay.

    • hasMaxBytes

      boolean hasMaxBytes()
       If set, truncate binary values to the specified byte length.
 This may be necessary when Yamcs contains large binary values.
      optional int32 maxBytes = 13;
      Returns:
      Whether the maxBytes field is set.

    • getMaxBytes

      int getMaxBytes()
       If set, truncate binary values to the specified byte length.
 This may be necessary when Yamcs contains large binary values.
      optional int32 maxBytes = 13;
      Returns:
      The maxBytes.

    • hasNext

      boolean hasNext()
       Continuation token returned by a previous page response.
      optional string next = 12;
      Returns:
      Whether the next field is set.

    • getNext

      String getNext()
       Continuation token returned by a previous page response.
      optional string next = 12;
      Returns:
      The next.

    • getNextBytes

      com.google.protobuf.ByteString getNextBytes()
       Continuation token returned by a previous page response.
      optional string next = 12;
      Returns:
      The bytes for next.