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

Class SubscribeContainersRequest

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

    • getInstance

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

    • getInstanceBytes

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

    • hasProcessor

      public boolean hasProcessor()
       Processor name
      optional string processor = 2;
      Specified by:
      hasProcessor in interface SubscribeContainersRequestOrBuilder
      Returns:
      Whether the processor field is set.

    • getProcessor

      public String getProcessor()
       Processor name
      optional string processor = 2;
      Specified by:
      getProcessor in interface SubscribeContainersRequestOrBuilder
      Returns:
      The processor.

    • getProcessorBytes

      public com.google.protobuf.ByteString getProcessorBytes()
       Processor name
      optional string processor = 2;
      Specified by:
      getProcessorBytes in interface SubscribeContainersRequestOrBuilder
      Returns:
      The bytes for processor.

    • getNamesList

      public com.google.protobuf.ProtocolStringList getNamesList()
       Container names to subscribe to.
      repeated string names = 3;
      Specified by:
      getNamesList in interface SubscribeContainersRequestOrBuilder
      Returns:
      A list containing the names.

    • getNamesCount

      public int getNamesCount()
       Container names to subscribe to.
      repeated string names = 3;
      Specified by:
      getNamesCount in interface SubscribeContainersRequestOrBuilder
      Returns:
      The count of names.

    • getNames

      public String getNames(int index)
       Container names to subscribe to.
      repeated string names = 3;
      Specified by:
      getNames in interface SubscribeContainersRequestOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The names at the given index.

    • getNamesBytes

      public com.google.protobuf.ByteString getNamesBytes(int index)
       Container names to subscribe to.
      repeated string names = 3;
      Specified by:
      getNamesBytes in interface SubscribeContainersRequestOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the names at the given index.

    • hasFilter

      public boolean hasFilter()
       Filter query. See {doc}`../filtering` for how to write a filter query.

 Literal text search matches against the `name` field.
 Field comparisons can use any of the following fields:

 | Field       | Type   | Description                                 |
 | ----------- | ------ | -------------------------------------------- |
 | `name`      | string | Filter by qualified container name           |
 | `link`      | string | Filter by receiving link                     |
 | `size`      | number | Filter by received container size in bytes   |
 | `seqNumber` | number | Filter by sequence count                     |

 If `names` is empty and this filter only uses text search or `name` comparisons, only
 matching containers are subscribed to. If it also uses `link`, `size` or `seqNumber`
 (only known once a container has actually been received), every container in the
 Mission Database is subscribed to instead.
      optional string filter = 4;
      Specified by:
      hasFilter in interface SubscribeContainersRequestOrBuilder
      Returns:
      Whether the filter field is set.

    • getFilter

      public String getFilter()
       Filter query. See {doc}`../filtering` for how to write a filter query.

 Literal text search matches against the `name` field.
 Field comparisons can use any of the following fields:

 | Field       | Type   | Description                                 |
 | ----------- | ------ | -------------------------------------------- |
 | `name`      | string | Filter by qualified container name           |
 | `link`      | string | Filter by receiving link                     |
 | `size`      | number | Filter by received container size in bytes   |
 | `seqNumber` | number | Filter by sequence count                     |

 If `names` is empty and this filter only uses text search or `name` comparisons, only
 matching containers are subscribed to. If it also uses `link`, `size` or `seqNumber`
 (only known once a container has actually been received), every container in the
 Mission Database is subscribed to instead.
      optional string filter = 4;
      Specified by:
      getFilter in interface SubscribeContainersRequestOrBuilder
      Returns:
      The filter.

    • getFilterBytes

      public com.google.protobuf.ByteString getFilterBytes()
       Filter query. See {doc}`../filtering` for how to write a filter query.

 Literal text search matches against the `name` field.
 Field comparisons can use any of the following fields:

 | Field       | Type   | Description                                 |
 | ----------- | ------ | -------------------------------------------- |
 | `name`      | string | Filter by qualified container name           |
 | `link`      | string | Filter by receiving link                     |
 | `size`      | number | Filter by received container size in bytes   |
 | `seqNumber` | number | Filter by sequence count                     |

 If `names` is empty and this filter only uses text search or `name` comparisons, only
 matching containers are subscribed to. If it also uses `link`, `size` or `seqNumber`
 (only known once a container has actually been received), every container in the
 Mission Database is subscribed to instead.
      optional string filter = 4;
      Specified by:
      getFilterBytes in interface SubscribeContainersRequestOrBuilder
      Returns:
      The bytes for filter.

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static SubscribeContainersRequest.Builder newBuilder()

    • newBuilder

      public static SubscribeContainersRequest.Builder newBuilder(SubscribeContainersRequest prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static SubscribeContainersRequest getDefaultInstance()

    • parser

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

    • getParserForType

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