Package org.yamcs.protobuf

Interface Archive.ExportParameterValuesRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Archive.ExportParameterValuesRequest, Archive.ExportParameterValuesRequest.Builder
Enclosing class:
Archive
public static interface Archive.ExportParameterValuesRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDelimiter()
    Column delimiter.
    com.google.protobuf.ByteString
    getDelimiterBytes()
    Column delimiter.
    String
    getExtra(int index)
    Extra columns added to the CSV output: * ``raw``: Raw parameter values * ``monitoring``: Monitoring status
    com.google.protobuf.ByteString
    getExtraBytes(int index)
    Extra columns added to the CSV output: * ``raw``: Raw parameter values * ``monitoring``: Monitoring status
    int
    getExtraCount()
    Extra columns added to the CSV output: * ``raw``: Raw parameter values * ``monitoring``: Monitoring status
    List<String>
    getExtraList()
    Extra columns added to the CSV output: * ``raw``: Raw parameter values * ``monitoring``: Monitoring status
    String
    getFilename()
    Preferred filename, this is returned in a Content-Disposition HTTP header.
    com.google.protobuf.ByteString
    getFilenameBytes()
    Preferred filename, this is returned in a Content-Disposition HTTP header.
    String
    getHeader()
    Header row to include in the response.
    com.google.protobuf.ByteString
    getHeaderBytes()
    Header row to include in the response.
    String
    getInstance()
    Yamcs instance name
    com.google.protobuf.ByteString
    getInstanceBytes()
    Yamcs instance name
    int
    getInterval()
    When specified, only one value each for each interval is returned.
    int
    getLimit()
    The maximum number of returned records.
    String
    getList()
    Identifier of a Parameter List, describing the parameters to export.
    com.google.protobuf.ByteString
    getListBytes()
    Identifier of a Parameter List, describing the parameters to export.
    String
    getNamespace()
    Namespace used to display parameter names in csv header.
    com.google.protobuf.ByteString
    getNamespaceBytes()
    Namespace used to display parameter names in csv header.
    String
    getOrder()
    The order of the returned results.
    com.google.protobuf.ByteString
    getOrderBytes()
    The order of the returned results.
    String
    getParameters(int index)
    The parameters to add to the export.
    com.google.protobuf.ByteString
    getParametersBytes(int index)
    The parameters to add to the export.
    int
    getParametersCount()
    The parameters to add to the export.
    List<String>
    getParametersList()
    The parameters to add to the export.
    long
    getPos()
    The zero-based row number at which to start outputting results.
    boolean
    getPreserveLastValue()
    If true, repeat the the previous value, if there is no value for the current timestamp.
    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
    hasDelimiter()
    Column delimiter.
    boolean
    hasFilename()
    Preferred filename, this is returned in a Content-Disposition HTTP header.
    boolean
    hasHeader()
    Header row to include in the response.
    boolean
    hasInstance()
    Yamcs instance name
    boolean
    hasInterval()
    When specified, only one value each for each interval is returned.
    boolean
    hasLimit()
    The maximum number of returned records.
    boolean
    hasList()
    Identifier of a Parameter List, describing the parameters to export.
    boolean
    hasNamespace()
    Namespace used to display parameter names in csv header.
    boolean
    hasOrder()
    The order of the returned results.
    boolean
    hasPos()
    The zero-based row number at which to start outputting results.
    boolean
    hasPreserveLastValue()
    If true, repeat the the previous value, if there is no value for the current timestamp.
    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.

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

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

    • getParametersList

      List<String> getParametersList()
       The parameters to add to the export.
      repeated string parameters = 4;
      Returns:
      A list containing the parameters.

    • getParametersCount

      int getParametersCount()
       The parameters to add to the export.
      repeated string parameters = 4;
      Returns:
      The count of parameters.

    • getParameters

      String getParameters(int index)
       The parameters to add to the export.
      repeated string parameters = 4;
      Parameters:
      index - The index of the element to return.
      Returns:
      The parameters at the given index.

    • getParametersBytes

      com.google.protobuf.ByteString getParametersBytes(int index)
       The parameters to add to the export.
      repeated string parameters = 4;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the parameters at the given index.

    • hasList

      boolean hasList()
       Identifier of a Parameter List, describing the parameters to
 export.
 This may be used as an alternative to the ``parameters`` field.
      optional string list = 14;
      Returns:
      Whether the list field is set.

    • getList

      String getList()
       Identifier of a Parameter List, describing the parameters to
 export.
 This may be used as an alternative to the ``parameters`` field.
      optional string list = 14;
      Returns:
      The list.

    • getListBytes

      com.google.protobuf.ByteString getListBytes()
       Identifier of a Parameter List, describing the parameters to
 export.
 This may be used as an alternative to the ``parameters`` field.
      optional string list = 14;
      Returns:
      The bytes for list.

    • hasNamespace

      boolean hasNamespace()
       Namespace used to display parameter names in csv header.
 Only used when no parameter ids were specified.
      optional string namespace = 5;
      Returns:
      Whether the namespace field is set.

    • getNamespace

      String getNamespace()
       Namespace used to display parameter names in csv header.
 Only used when no parameter ids were specified.
      optional string namespace = 5;
      Returns:
      The namespace.

    • getNamespaceBytes

      com.google.protobuf.ByteString getNamespaceBytes()
       Namespace used to display parameter names in csv header.
 Only used when no parameter ids were specified.
      optional string namespace = 5;
      Returns:
      The bytes for namespace.

    • getExtraList

      List<String> getExtraList()
       Extra columns added to the CSV output:
  * ``raw``: Raw parameter values
  * ``monitoring``: Monitoring status
      repeated string extra = 6;
      Returns:
      A list containing the extra.

    • getExtraCount

      int getExtraCount()
       Extra columns added to the CSV output:
  * ``raw``: Raw parameter values
  * ``monitoring``: Monitoring status
      repeated string extra = 6;
      Returns:
      The count of extra.

    • getExtra

      String getExtra(int index)
       Extra columns added to the CSV output:
  * ``raw``: Raw parameter values
  * ``monitoring``: Monitoring status
      repeated string extra = 6;
      Parameters:
      index - The index of the element to return.
      Returns:
      The extra at the given index.

    • getExtraBytes

      com.google.protobuf.ByteString getExtraBytes(int index)
       Extra columns added to the CSV output:
  * ``raw``: Raw parameter values
  * ``monitoring``: Monitoring status
      repeated string extra = 6;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the extra at the given index.

    • hasDelimiter

      boolean hasDelimiter()
       Column delimiter. One of ``TAB``, ``COMMA`` or ``SEMICOLON``.
 Default: ``TAB``.
      optional string delimiter = 7;
      Returns:
      Whether the delimiter field is set.

    • getDelimiter

      String getDelimiter()
       Column delimiter. One of ``TAB``, ``COMMA`` or ``SEMICOLON``.
 Default: ``TAB``.
      optional string delimiter = 7;
      Returns:
      The delimiter.

    • getDelimiterBytes

      com.google.protobuf.ByteString getDelimiterBytes()
       Column delimiter. One of ``TAB``, ``COMMA`` or ``SEMICOLON``.
 Default: ``TAB``.
      optional string delimiter = 7;
      Returns:
      The bytes for delimiter.

    • hasInterval

      boolean hasInterval()
       When specified, only one value each for each interval is returned.
 The value is in milliseconds.
      optional int32 interval = 8;
      Returns:
      Whether the interval field is set.

    • getInterval

      int getInterval()
       When specified, only one value each for each interval is returned.
 The value is in milliseconds.
      optional int32 interval = 8;
      Returns:
      The interval.

    • hasPreserveLastValue

      boolean hasPreserveLastValue()
       If true, repeat the the previous value, if there is no value for
 the current timestamp. Default: ``false``.
      optional bool preserveLastValue = 9;
      Returns:
      Whether the preserveLastValue field is set.

    • getPreserveLastValue

      boolean getPreserveLastValue()
       If true, repeat the the previous value, if there is no value for
 the current timestamp. Default: ``false``.
      optional bool preserveLastValue = 9;
      Returns:
      The preserveLastValue.

    • hasPos

      boolean hasPos()
       The zero-based row number at which to start outputting results. Default: ``0``.
      optional int64 pos = 10;
      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 = 10;
      Returns:
      The pos.

    • hasLimit

      boolean hasLimit()
       The maximum number of returned records. Default: unlimited.
      optional int32 limit = 11;
      Returns:
      Whether the limit field is set.

    • getLimit

      int getLimit()
       The maximum number of returned records. Default: unlimited.
      optional int32 limit = 11;
      Returns:
      The limit.

    • hasOrder

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

    • getOrder

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

    • getOrderBytes

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

    • hasFilename

      boolean hasFilename()
       Preferred filename, this is returned in a Content-Disposition HTTP header.
 If unset, Yamcs will determine a name.
      optional string filename = 13;
      Returns:
      Whether the filename field is set.

    • getFilename

      String getFilename()
       Preferred filename, this is returned in a Content-Disposition HTTP header.
 If unset, Yamcs will determine a name.
      optional string filename = 13;
      Returns:
      The filename.

    • getFilenameBytes

      com.google.protobuf.ByteString getFilenameBytes()
       Preferred filename, this is returned in a Content-Disposition HTTP header.
 If unset, Yamcs will determine a name.
      optional string filename = 13;
      Returns:
      The bytes for filename.

    • hasHeader

      boolean hasHeader()
       Header row to include in the response.
 One of ``QUALIFIED_NAME``, ``SHORT_NAME`` or ``NONE``.
 Default: ``QUALIFIED_NAME``.
      optional string header = 15;
      Returns:
      Whether the header field is set.

    • getHeader

      String getHeader()
       Header row to include in the response.
 One of ``QUALIFIED_NAME``, ``SHORT_NAME`` or ``NONE``.
 Default: ``QUALIFIED_NAME``.
      optional string header = 15;
      Returns:
      The header.

    • getHeaderBytes

      com.google.protobuf.ByteString getHeaderBytes()
       Header row to include in the response.
 One of ``QUALIFIED_NAME``, ``SHORT_NAME`` or ``NONE``.
 Default: ``QUALIFIED_NAME``.
      optional string header = 15;
      Returns:
      The bytes for header.