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

Class ListParameterHistoryRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
org.yamcs.protobuf.ListParameterHistoryRequest
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, ListParameterHistoryRequestOrBuilder
public final class ListParameterHistoryRequest extends com.google.protobuf.GeneratedMessageV3 implements ListParameterHistoryRequestOrBuilder
Protobuf type yamcs.protobuf.pvalue.ListParameterHistoryRequest
See Also:

  • Field Details

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getUnknownFields

      public final com.google.protobuf.UnknownFieldSet getUnknownFields()
      Specified by:
      getUnknownFields in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getUnknownFields in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • hasInstance

      public boolean hasInstance()
       Yamcs instance name
      optional string instance = 1;
      Specified by:
      hasInstance in interface ListParameterHistoryRequestOrBuilder
      Returns:
      Whether the instance field is set.

    • getInstance

      public String getInstance()
       Yamcs instance name
      optional string instance = 1;
      Specified by:
      getInstance in interface ListParameterHistoryRequestOrBuilder
      Returns:
      The instance.

    • getInstanceBytes

      public com.google.protobuf.ByteString getInstanceBytes()
       Yamcs instance name
      optional string instance = 1;
      Specified by:
      getInstanceBytes in interface ListParameterHistoryRequestOrBuilder
      Returns:
      The bytes for instance.

    • hasName

      public boolean hasName()
       Parameter name
      optional string name = 2;
      Specified by:
      hasName in interface ListParameterHistoryRequestOrBuilder
      Returns:
      Whether the name field is set.

    • getName

      public String getName()
       Parameter name
      optional string name = 2;
      Specified by:
      getName in interface ListParameterHistoryRequestOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Parameter name
      optional string name = 2;
      Specified by:
      getNameBytes in interface ListParameterHistoryRequestOrBuilder
      Returns:
      The bytes for name.

    • hasPos

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

    • getPos

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

    • hasLimit

      public 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;
      Specified by:
      hasLimit in interface ListParameterHistoryRequestOrBuilder
      Returns:
      Whether the limit field is set.

    • getLimit

      public 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;
      Specified by:
      getLimit in interface ListParameterHistoryRequestOrBuilder
      Returns:
      The limit.

    • hasNorepeat

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

    • getNorepeat

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

    • hasStart

      public 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;
      Specified by:
      hasStart in interface ListParameterHistoryRequestOrBuilder
      Returns:
      Whether the start field is set.

    • getStart

      public 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;
      Specified by:
      getStart in interface ListParameterHistoryRequestOrBuilder
      Returns:
      The start.

    • getStartOrBuilder

      public 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;
      Specified by:
      getStartOrBuilder in interface ListParameterHistoryRequestOrBuilder

    • hasStop

      public 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;
      Specified by:
      hasStop in interface ListParameterHistoryRequestOrBuilder
      Returns:
      Whether the stop field is set.

    • getStop

      public 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;
      Specified by:
      getStop in interface ListParameterHistoryRequestOrBuilder
      Returns:
      The stop.

    • getStopOrBuilder

      public 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;
      Specified by:
      getStopOrBuilder in interface ListParameterHistoryRequestOrBuilder

    • hasOrder

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

    • getOrder

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

    • getOrderBytes

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

    • hasNorealtime

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

    • getNorealtime

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

    • hasProcessor

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

    • getProcessor

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

    • getProcessorBytes

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

    • hasSource

      public 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;
      Specified by:
      hasSource in interface ListParameterHistoryRequestOrBuilder
      Returns:
      Whether the source field is set.

    • getSource

      public 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;
      Specified by:
      getSource in interface ListParameterHistoryRequestOrBuilder
      Returns:
      The source.

    • getSourceBytes

      public 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;
      Specified by:
      getSourceBytes in interface ListParameterHistoryRequestOrBuilder
      Returns:
      The bytes for source.

    • hasNoreplay

      public 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;
      Specified by:
      hasNoreplay in interface ListParameterHistoryRequestOrBuilder
      Returns:
      Whether the noreplay field is set.

    • getNoreplay

      public 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;
      Specified by:
      getNoreplay in interface ListParameterHistoryRequestOrBuilder
      Returns:
      The noreplay.

    • hasMaxBytes

      public 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;
      Specified by:
      hasMaxBytes in interface ListParameterHistoryRequestOrBuilder
      Returns:
      Whether the maxBytes field is set.

    • getMaxBytes

      public 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;
      Specified by:
      getMaxBytes in interface ListParameterHistoryRequestOrBuilder
      Returns:
      The maxBytes.

    • hasNext

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

    • getNext

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

    • getNextBytes

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

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static ListParameterHistoryRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ListParameterHistoryRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ListParameterHistoryRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ListParameterHistoryRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ListParameterHistoryRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ListParameterHistoryRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ListParameterHistoryRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ListParameterHistoryRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ListParameterHistoryRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ListParameterHistoryRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ListParameterHistoryRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ListParameterHistoryRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public ListParameterHistoryRequest.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static ListParameterHistoryRequest.Builder newBuilder()

    • newBuilder

      public static ListParameterHistoryRequest.Builder newBuilder(ListParameterHistoryRequest prototype)

    • toBuilder

      public ListParameterHistoryRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected ListParameterHistoryRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static ListParameterHistoryRequest getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<ListParameterHistoryRequest> parser()

    • getParserForType

      public com.google.protobuf.Parser<ListParameterHistoryRequest> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public ListParameterHistoryRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder