Package org.yamcs.protobuf

Interface GetParameterRangesRequestOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    GetParameterRangesRequest, GetParameterRangesRequest.Builder
    public interface GetParameterRangesRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getInstance()
      Yamcs instance name.
      com.google.protobuf.ByteString getInstanceBytes()
      Yamcs instance name.
      long getMaxGap()
      Time in milliseconds.
      int getMaxValues()
      Maximum number of distinct values to be returned.
      long getMinGap()
      Time in milliseconds.
      long getMinRange()
      Time in milliseconds of the minimum range to be returned.
      String getName()
      Parameter name.
      com.google.protobuf.ByteString getNameBytes()
      Parameter name.
      boolean getNorealtime()
      Disable loading of parameters from the parameter cache.
      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()
      optional string source = 9;
      com.google.protobuf.ByteString getSourceBytes()
      optional string source = 9;
      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 hasMaxGap()
      Time in milliseconds.
      boolean hasMaxValues()
      Maximum number of distinct values to be returned.
      boolean hasMinGap()
      Time in milliseconds.
      boolean hasMinRange()
      Time in milliseconds of the minimum range to be returned.
      boolean hasName()
      Parameter name.
      boolean hasNorealtime()
      Disable loading of parameters from the parameter cache.
      boolean hasProcessor()
      The name of the processor from which to use the parameter cache.
      boolean hasSource()
      optional string source = 9;
      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 Detail

      • 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.

      • 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 = 3;
        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 = 3;
        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 = 3;

      • 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 = 4;
        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 = 4;
        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 = 4;

      • hasMinGap

        boolean hasMinGap()
         Time in milliseconds. Any gap (detected based on parameter expiration) smaller than
 this will be ignored. However if the parameter changes value, the ranges will still
 be split.
        optional int64 minGap = 5;
        Returns:
        Whether the minGap field is set.

      • getMinGap

        long getMinGap()
         Time in milliseconds. Any gap (detected based on parameter expiration) smaller than
 this will be ignored. However if the parameter changes value, the ranges will still
 be split.
        optional int64 minGap = 5;
        Returns:
        The minGap.

      • hasMaxGap

        boolean hasMaxGap()
         Time in milliseconds. If the distance between two subsequent values of the parameter
 is bigger than this value (but smaller than the parameter expiration), then an
 artificial gap will be constructed. This also applies if there is no parameter
 expiration defined for the parameter.
        optional int64 maxGap = 6;
        Returns:
        Whether the maxGap field is set.

      • getMaxGap

        long getMaxGap()
         Time in milliseconds. If the distance between two subsequent values of the parameter
 is bigger than this value (but smaller than the parameter expiration), then an
 artificial gap will be constructed. This also applies if there is no parameter
 expiration defined for the parameter.
        optional int64 maxGap = 6;
        Returns:
        The maxGap.

      • hasNorealtime

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

      • getNorealtime

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

      • hasProcessor

        boolean hasProcessor()
         The name of the processor from which to use the parameter cache. Default: ``realtime``.
        optional string processor = 8;
        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 = 8;
        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 = 8;
        Returns:
        The bytes for processor.

      • hasSource

        boolean hasSource()
        optional string source = 9;
        Returns:
        Whether the source field is set.

      • getSource

        String getSource()
        optional string source = 9;
        Returns:
        The source.

      • getSourceBytes

        com.google.protobuf.ByteString getSourceBytes()
        optional string source = 9;
        Returns:
        The bytes for source.

      • hasMinRange

        boolean hasMinRange()
         Time in milliseconds of the minimum range to be returned. If the data changes more often,
a new range will not be created but the data will be added to the old range.
        optional int64 minRange = 10;
        Returns:
        Whether the minRange field is set.

      • getMinRange

        long getMinRange()
         Time in milliseconds of the minimum range to be returned. If the data changes more often,
a new range will not be created but the data will be added to the old range.
        optional int64 minRange = 10;
        Returns:
        The minRange.

      • hasMaxValues

        boolean hasMaxValues()
         Maximum number of distinct values to be returned. The maximum number applies across all ranges
 and is meant to limit the amount of data that is being retrieved.
 The retrieved data has a count for each value as well as a total count.
 The difference between the total count and the sum of the individual counts can be used to compute
 the number of unsent values.
        optional int32 maxValues = 11;
        Returns:
        Whether the maxValues field is set.

      • getMaxValues

        int getMaxValues()
         Maximum number of distinct values to be returned. The maximum number applies across all ranges
 and is meant to limit the amount of data that is being retrieved.
 The retrieved data has a count for each value as well as a total count.
 The difference between the total count and the sum of the individual counts can be used to compute
 the number of unsent values.
        optional int32 maxValues = 11;
        Returns:
        The maxValues.