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

Class ExportParameterValuesRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
org.yamcs.protobuf.ExportParameterValuesRequest
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, ExportParameterValuesRequestOrBuilder
public final class ExportParameterValuesRequest extends com.google.protobuf.GeneratedMessageV3 implements ExportParameterValuesRequestOrBuilder
Protobuf type yamcs.protobuf.pvalue.ExportParameterValuesRequest
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 ExportParameterValuesRequestOrBuilder
      Returns:
      Whether the instance field is set.

    • getInstance

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

    • getInstanceBytes

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

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

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

    • getParametersList

      public com.google.protobuf.ProtocolStringList getParametersList()
       The parameters to add to the export.
      repeated string parameters = 4;
      Specified by:
      getParametersList in interface ExportParameterValuesRequestOrBuilder
      Returns:
      A list containing the parameters.

    • getParametersCount

      public int getParametersCount()
       The parameters to add to the export.
      repeated string parameters = 4;
      Specified by:
      getParametersCount in interface ExportParameterValuesRequestOrBuilder
      Returns:
      The count of parameters.

    • getParameters

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

    • getParametersBytes

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

    • hasList

      public 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;
      Specified by:
      hasList in interface ExportParameterValuesRequestOrBuilder
      Returns:
      Whether the list field is set.

    • getList

      public 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;
      Specified by:
      getList in interface ExportParameterValuesRequestOrBuilder
      Returns:
      The list.

    • getListBytes

      public 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;
      Specified by:
      getListBytes in interface ExportParameterValuesRequestOrBuilder
      Returns:
      The bytes for list.

    • hasNamespace

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

    • getNamespace

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

    • getNamespaceBytes

      public 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;
      Specified by:
      getNamespaceBytes in interface ExportParameterValuesRequestOrBuilder
      Returns:
      The bytes for namespace.

    • getExtraList

      public com.google.protobuf.ProtocolStringList getExtraList()
       Extra columns added to the CSV output:
  * `raw`: Raw parameter values
  * `monitoring`: Monitoring status
      repeated string extra = 6;
      Specified by:
      getExtraList in interface ExportParameterValuesRequestOrBuilder
      Returns:
      A list containing the extra.

    • getExtraCount

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

    • getExtra

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

    • getExtraBytes

      public 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;
      Specified by:
      getExtraBytes in interface ExportParameterValuesRequestOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the extra at the given index.

    • hasDelimiter

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

    • getDelimiter

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

    • getDelimiterBytes

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

    • hasInterval

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

    • getInterval

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

    • hasPreserveLastValue

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

    • getPreserveLastValue

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

    • hasPos

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

    • hasLimit

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

    • getLimit

      public int getLimit()
       The maximum number of returned records. Default: unlimited.
      optional int32 limit = 11;
      Specified by:
      getLimit in interface ExportParameterValuesRequestOrBuilder
      Returns:
      The limit.

    • hasOrder

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

    • getOrder

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

    • getOrderBytes

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

    • hasFilename

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

    • getFilename

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

    • getFilenameBytes

      public 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;
      Specified by:
      getFilenameBytes in interface ExportParameterValuesRequestOrBuilder
      Returns:
      The bytes for filename.

    • hasHeader

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

    • getHeader

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

    • getHeaderBytes

      public 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;
      Specified by:
      getHeaderBytes in interface ExportParameterValuesRequestOrBuilder
      Returns:
      The bytes for header.

    • 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 = 16;
      Specified by:
      hasSource in interface ExportParameterValuesRequestOrBuilder
      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 = 16;
      Specified by:
      getSource in interface ExportParameterValuesRequestOrBuilder
      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 = 16;
      Specified by:
      getSourceBytes in interface ExportParameterValuesRequestOrBuilder
      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.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 ExportParameterValuesRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static ExportParameterValuesRequest.Builder newBuilder()

    • newBuilder

      public static ExportParameterValuesRequest.Builder newBuilder(ExportParameterValuesRequest prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static ExportParameterValuesRequest getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<ExportParameterValuesRequest> 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 ExportParameterValuesRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder