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

Interface SubscribeContainersRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
SubscribeContainersRequest, SubscribeContainersRequest.Builder
@Generated public interface SubscribeContainersRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getFilter()
    Filter query.
    com.google.protobuf.ByteString
    getFilterBytes()
    Filter query.
    String
    getInstance()
    Yamcs instance name
    com.google.protobuf.ByteString
    getInstanceBytes()
    Yamcs instance name
    String
    getNames(int index)
    Container names to subscribe to.
    com.google.protobuf.ByteString
    getNamesBytes(int index)
    Container names to subscribe to.
    int
    getNamesCount()
    Container names to subscribe to.
    List<String>
    getNamesList()
    Container names to subscribe to.
    String
    getProcessor()
    Processor name
    com.google.protobuf.ByteString
    getProcessorBytes()
    Processor name
    boolean
    hasFilter()
    Filter query.
    boolean
    hasInstance()
    Yamcs instance name
    boolean
    hasProcessor()
    Processor name

    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.

    • getNamesList

      List<String> getNamesList()
       Container names to subscribe to.
      repeated string names = 3;
      Returns:
      A list containing the names.

    • getNamesCount

      int getNamesCount()
       Container names to subscribe to.
      repeated string names = 3;
      Returns:
      The count of names.

    • getNames

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

    • getNamesBytes

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

    • hasFilter

      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;
      Returns:
      Whether the filter field is set.

    • getFilter

      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;
      Returns:
      The filter.

    • getFilterBytes

      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;
      Returns:
      The bytes for filter.