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

Interface GetParameterValueRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
GetParameterValueRequest, GetParameterValueRequest.Builder
public interface GetParameterValueRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    getFromCache()
    Whether the latest cached value may be returned.
    String
    getInstance()
    Yamcs instance name.
    com.google.protobuf.ByteString
    getInstanceBytes()
    Yamcs instance name.
    String
    getName()
    Parameter name.
    com.google.protobuf.ByteString
    getNameBytes()
    Parameter name.
    String
    getProcessor()
    Processor name.
    com.google.protobuf.ByteString
    getProcessorBytes()
    Processor name.
    long
    getTimeout()
    Time in milliseconds to wait on a value (only considered if ``fromCache=no``).
    boolean
    hasFromCache()
    Whether the latest cached value may be returned.
    boolean
    hasInstance()
    Yamcs instance name.
    boolean
    hasName()
    Parameter name.
    boolean
    hasProcessor()
    Processor name.
    boolean
    hasTimeout()
    Time in milliseconds to wait on a value (only considered if ``fromCache=no``).

    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.

    • hasProcessor

      boolean hasProcessor()
       Processor name.
      optional string processor = 2;
      Returns:
      Whether the processor field is set.

    • getProcessor

      String getProcessor()
       Processor name.
      optional string processor = 2;
      Returns:
      The processor.

    • getProcessorBytes

      com.google.protobuf.ByteString getProcessorBytes()
       Processor name.
      optional string processor = 2;
      Returns:
      The bytes for processor.

    • hasName

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

    • getName

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

    • getNameBytes

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

    • hasFromCache

      boolean hasFromCache()
       Whether the latest cached value may be returned. Default: ``yes``.
      optional bool fromCache = 4;
      Returns:
      Whether the fromCache field is set.

    • getFromCache

      boolean getFromCache()
       Whether the latest cached value may be returned. Default: ``yes``.
      optional bool fromCache = 4;
      Returns:
      The fromCache.

    • hasTimeout

      boolean hasTimeout()
       Time in milliseconds to wait on a value (only considered if
 ``fromCache=no``). When the timeout is met, the call will return
 with no or partial data. Default: ``10000``.
      optional uint64 timeout = 5;
      Returns:
      Whether the timeout field is set.

    • getTimeout

      long getTimeout()
       Time in milliseconds to wait on a value (only considered if
 ``fromCache=no``). When the timeout is met, the call will return
 with no or partial data. Default: ``10000``.
      optional uint64 timeout = 5;
      Returns:
      The timeout.