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

Class GetParameterSamplesRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
org.yamcs.protobuf.GetParameterSamplesRequest
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, GetParameterSamplesRequestOrBuilder
@Generated public final class GetParameterSamplesRequest extends com.google.protobuf.GeneratedMessage implements GetParameterSamplesRequestOrBuilder
Protobuf type yamcs.protobuf.pvalue.GetParameterSamplesRequest
See Also:

  • Field Details

  • Method Details

    • getDescriptor

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

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

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

    • hasInstance

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

    • getInstance

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

    • getInstanceBytes

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

    • hasName

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

    • getName

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

    • getNameBytes

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

    • 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 = 3;
      Specified by:
      hasStart in interface GetParameterSamplesRequestOrBuilder
      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 = 3;
      Specified by:
      getStart in interface GetParameterSamplesRequestOrBuilder
      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 = 3;
      Specified by:
      getStartOrBuilder in interface GetParameterSamplesRequestOrBuilder

    • 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 = 4;
      Specified by:
      hasStop in interface GetParameterSamplesRequestOrBuilder
      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 = 4;
      Specified by:
      getStop in interface GetParameterSamplesRequestOrBuilder
      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 = 4;
      Specified by:
      getStopOrBuilder in interface GetParameterSamplesRequestOrBuilder

    • hasCount

      public boolean hasCount()
       Number of intervals to use. Default: `500`.
      optional int32 count = 5;
      Specified by:
      hasCount in interface GetParameterSamplesRequestOrBuilder
      Returns:
      Whether the count field is set.

    • getCount

      public int getCount()
       Number of intervals to use. Default: `500`.
      optional int32 count = 5;
      Specified by:
      getCount in interface GetParameterSamplesRequestOrBuilder
      Returns:
      The count.

    • hasNorealtime

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

    • getNorealtime

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

    • hasUseRawValue

      public boolean hasUseRawValue()
       Consider the raw value instead of the engineering value.
 Default is to use the engineering value
      optional bool useRawValue = 9;
      Specified by:
      hasUseRawValue in interface GetParameterSamplesRequestOrBuilder
      Returns:
      Whether the useRawValue field is set.

    • getUseRawValue

      public boolean getUseRawValue()
       Consider the raw value instead of the engineering value.
 Default is to use the engineering value
      optional bool useRawValue = 9;
      Specified by:
      getUseRawValue in interface GetParameterSamplesRequestOrBuilder
      Returns:
      The useRawValue.

    • hasGapTime

      public boolean hasGapTime()
       Milliseconds before a sample is considered expired. This property is
 used as a fallback, when the underlying parameter values have no
 implicit expiration time.

 Default: `120000`.
      optional uint64 gapTime = 10;
      Specified by:
      hasGapTime in interface GetParameterSamplesRequestOrBuilder
      Returns:
      Whether the gapTime field is set.

    • getGapTime

      public long getGapTime()
       Milliseconds before a sample is considered expired. This property is
 used as a fallback, when the underlying parameter values have no
 implicit expiration time.

 Default: `120000`.
      optional uint64 gapTime = 10;
      Specified by:
      getGapTime in interface GetParameterSamplesRequestOrBuilder
      Returns:
      The gapTime.

    • hasProcessor

      public boolean hasProcessor()
       The name of the processor from which to use the parameter cache.
 Default: `realtime`.
      optional string processor = 7;
      Specified by:
      hasProcessor in interface GetParameterSamplesRequestOrBuilder
      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 = 7;
      Specified by:
      getProcessor in interface GetParameterSamplesRequestOrBuilder
      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 = 7;
      Specified by:
      getProcessorBytes in interface GetParameterSamplesRequestOrBuilder
      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 ParameterArchive.

 Default: `ParameterArchive`.
      optional string source = 8;
      Specified by:
      hasSource in interface GetParameterSamplesRequestOrBuilder
      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 ParameterArchive.

 Default: `ParameterArchive`.
      optional string source = 8;
      Specified by:
      getSource in interface GetParameterSamplesRequestOrBuilder
      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 ParameterArchive.

 Default: `ParameterArchive`.
      optional string source = 8;
      Specified by:
      getSourceBytes in interface GetParameterSamplesRequestOrBuilder
      Returns:
      The bytes for source.

    • isInitialized

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

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

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

    • 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 GetParameterSamplesRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static GetParameterSamplesRequest.Builder newBuilder()

    • newBuilder

      public static GetParameterSamplesRequest.Builder newBuilder(GetParameterSamplesRequest prototype)

    • toBuilder

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

    • newBuilderForType

      protected GetParameterSamplesRequest.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static GetParameterSamplesRequest getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<GetParameterSamplesRequest> 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.GeneratedMessage

    • getDefaultInstanceForType

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