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

Class ListPacketIndexRequest

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

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    ListPacketIndexRequest.Builder
    Protobuf type yamcs.protobuf.archive.ListPacketIndexRequest

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    INSTANCE_FIELD_NUMBER
     
    static final int
    LIMIT_FIELD_NUMBER
     
    static final int
    MERGETIME_FIELD_NUMBER
     
    static final int
    NAME_FIELD_NUMBER
     
    static final int
    NEXT_FIELD_NUMBER
     
    static final com.google.protobuf.Parser<ListPacketIndexRequest>
    PARSER
    Deprecated.
    static final int
    START_FIELD_NUMBER
     
    static final int
    STOP_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static ListPacketIndexRequest
    getDefaultInstance()
     
    ListPacketIndexRequest
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getInstance()
    Yamcs instance name.
    com.google.protobuf.ByteString
    getInstanceBytes()
    Yamcs instance name.
    int
    getLimit()
    The maximum number of returned entries.
    int
    getMergeTime()
    Value in milliseconds that indicates the maximum gap before two consecutive index ranges are merged together.
    String
    getName(int index)
    Filter on specific packet names.
    com.google.protobuf.ByteString
    getNameBytes(int index)
    Filter on specific packet names.
    int
    getNameCount()
    Filter on specific packet names.
    com.google.protobuf.ProtocolStringList
    getNameList()
    Filter on specific packet names.
    String
    getNext()
    Continuation token returned by a previous page response.
    com.google.protobuf.ByteString
    getNextBytes()
    Continuation token returned by a previous page response.
    com.google.protobuf.Parser<ListPacketIndexRequest>
    getParserForType()
     
    int
    getSerializedSize()
     
    com.google.protobuf.Timestamp
    getStart()
    Filter the lower bound of the index entries.
    com.google.protobuf.TimestampOrBuilder
    getStartOrBuilder()
    Filter the lower bound of the index entries.
    com.google.protobuf.Timestamp
    getStop()
    Filter the upper bound of the index entries.
    com.google.protobuf.TimestampOrBuilder
    getStopOrBuilder()
    Filter the upper bound of the index entries.
    final com.google.protobuf.UnknownFieldSet
    getUnknownFields()
     
    int
    hashCode()
     
    boolean
    hasInstance()
    Yamcs instance name.
    boolean
    hasLimit()
    The maximum number of returned entries.
    boolean
    hasMergeTime()
    Value in milliseconds that indicates the maximum gap before two consecutive index ranges are merged together.
    boolean
    hasNext()
    Continuation token returned by a previous page response.
    boolean
    hasStart()
    Filter the lower bound of the index entries.
    boolean
    hasStop()
    Filter the upper bound of the index entries.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static ListPacketIndexRequest.Builder
    newBuilder()
     
    static ListPacketIndexRequest.Builder
    newBuilder(ListPacketIndexRequest prototype)
     
    ListPacketIndexRequest.Builder
    newBuilderForType()
     
    protected ListPacketIndexRequest.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static ListPacketIndexRequest
    parseDelimitedFrom(InputStream input)
     
    static ListPacketIndexRequest
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ListPacketIndexRequest
    parseFrom(byte[] data)
     
    static ListPacketIndexRequest
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ListPacketIndexRequest
    parseFrom(com.google.protobuf.ByteString data)
     
    static ListPacketIndexRequest
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ListPacketIndexRequest
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static ListPacketIndexRequest
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ListPacketIndexRequest
    parseFrom(InputStream input)
     
    static ListPacketIndexRequest
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ListPacketIndexRequest
    parseFrom(ByteBuffer data)
     
    static ListPacketIndexRequest
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<ListPacketIndexRequest>
    parser()
     
    ListPacketIndexRequest.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

  • 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 ListPacketIndexRequestOrBuilder
      Returns:
      Whether the instance field is set.

    • getInstance

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

    • getInstanceBytes

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

    • hasMergeTime

      public boolean hasMergeTime()
       Value in milliseconds that indicates the maximum gap before two consecutive index
 ranges are merged together. Default: ``2000``
      optional int32 mergeTime = 2;
      Specified by:
      hasMergeTime in interface ListPacketIndexRequestOrBuilder
      Returns:
      Whether the mergeTime field is set.

    • getMergeTime

      public int getMergeTime()
       Value in milliseconds that indicates the maximum gap before two consecutive index
 ranges are merged together. Default: ``2000``
      optional int32 mergeTime = 2;
      Specified by:
      getMergeTime in interface ListPacketIndexRequestOrBuilder
      Returns:
      The mergeTime.

    • hasLimit

      public boolean hasLimit()
       The maximum number of returned entries. Choose this value too high and you risk
 hitting the maximum response size limit enforced by the server. Default: ``1000``.
 Note that in general it is advised to control the size of the response via
 ``mergeTime``, rather than via ``limit``.
      optional int32 limit = 3;
      Specified by:
      hasLimit in interface ListPacketIndexRequestOrBuilder
      Returns:
      Whether the limit field is set.

    • getLimit

      public int getLimit()
       The maximum number of returned entries. Choose this value too high and you risk
 hitting the maximum response size limit enforced by the server. Default: ``1000``.
 Note that in general it is advised to control the size of the response via
 ``mergeTime``, rather than via ``limit``.
      optional int32 limit = 3;
      Specified by:
      getLimit in interface ListPacketIndexRequestOrBuilder
      Returns:
      The limit.

    • hasStart

      public boolean hasStart()
       Filter the lower bound of the index entries. Specify a date string in ISO 8601 format.
      optional .google.protobuf.Timestamp start = 4;
      Specified by:
      hasStart in interface ListPacketIndexRequestOrBuilder
      Returns:
      Whether the start field is set.

    • getStart

      public com.google.protobuf.Timestamp getStart()
       Filter the lower bound of the index entries. Specify a date string in ISO 8601 format.
      optional .google.protobuf.Timestamp start = 4;
      Specified by:
      getStart in interface ListPacketIndexRequestOrBuilder
      Returns:
      The start.

    • getStartOrBuilder

      public com.google.protobuf.TimestampOrBuilder getStartOrBuilder()
       Filter the lower bound of the index entries. Specify a date string in ISO 8601 format.
      optional .google.protobuf.Timestamp start = 4;
      Specified by:
      getStartOrBuilder in interface ListPacketIndexRequestOrBuilder

    • hasStop

      public boolean hasStop()
       Filter the upper bound of the index entries. Specify a date string in ISO 8601 format.
      optional .google.protobuf.Timestamp stop = 5;
      Specified by:
      hasStop in interface ListPacketIndexRequestOrBuilder
      Returns:
      Whether the stop field is set.

    • getStop

      public com.google.protobuf.Timestamp getStop()
       Filter the upper bound of the index entries. Specify a date string in ISO 8601 format.
      optional .google.protobuf.Timestamp stop = 5;
      Specified by:
      getStop in interface ListPacketIndexRequestOrBuilder
      Returns:
      The stop.

    • getStopOrBuilder

      public com.google.protobuf.TimestampOrBuilder getStopOrBuilder()
       Filter the upper bound of the index entries. Specify a date string in ISO 8601 format.
      optional .google.protobuf.Timestamp stop = 5;
      Specified by:
      getStopOrBuilder in interface ListPacketIndexRequestOrBuilder

    • hasNext

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

    • getNext

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

    • getNextBytes

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

    • getNameList

      public com.google.protobuf.ProtocolStringList getNameList()
       Filter on specific packet names.
      repeated string name = 7;
      Specified by:
      getNameList in interface ListPacketIndexRequestOrBuilder
      Returns:
      A list containing the name.

    • getNameCount

      public int getNameCount()
       Filter on specific packet names.
      repeated string name = 7;
      Specified by:
      getNameCount in interface ListPacketIndexRequestOrBuilder
      Returns:
      The count of name.

    • getName

      public String getName(int index)
       Filter on specific packet names.
      repeated string name = 7;
      Specified by:
      getName in interface ListPacketIndexRequestOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The name at the given index.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes(int index)
       Filter on specific packet names.
      repeated string name = 7;
      Specified by:
      getNameBytes in interface ListPacketIndexRequestOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the name at the given index.

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static ListPacketIndexRequest.Builder newBuilder()

    • newBuilder

      public static ListPacketIndexRequest.Builder newBuilder(ListPacketIndexRequest prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static ListPacketIndexRequest getDefaultInstance()

    • parser

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

    • getParserForType

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