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

Interface StreamEventsRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
StreamEventsRequest, StreamEventsRequest.Builder
public interface StreamEventsRequestOrBuilder 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
    getQ()
    Search by text
    com.google.protobuf.ByteString
    getQBytes()
    Search by text
    String
    getSeverity()
    Filter on minimum severity level
    com.google.protobuf.ByteString
    getSeverityBytes()
    Filter on minimum severity level
    String
    getSource(int index)
    Event sources to include.
    com.google.protobuf.ByteString
    getSourceBytes(int index)
    Event sources to include.
    int
    getSourceCount()
    Event sources to include.
    List<String>
    getSourceList()
    Event sources to include.
    com.google.protobuf.Timestamp
    getStart()
    Filter the lower bound of the event's generation time.
    com.google.protobuf.TimestampOrBuilder
    getStartOrBuilder()
    Filter the lower bound of the event's generation time.
    com.google.protobuf.Timestamp
    getStop()
    Filter the upper bound of the event's generation time.
    com.google.protobuf.TimestampOrBuilder
    getStopOrBuilder()
    Filter the upper bound of the event's generation time.
    boolean
    hasFilter()
    Filter query.
    boolean
    hasInstance()
    Yamcs instance name
    boolean
    hasQ()
    Search by text
    boolean
    hasSeverity()
    Filter on minimum severity level
    boolean
    hasStart()
    Filter the lower bound of the event's generation time.
    boolean
    hasStop()
    Filter the upper bound of the event'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 event'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 event'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 event'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 event'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 event'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 event's generation time. Specify a date
 string in ISO 8601 format.
      optional .google.protobuf.Timestamp stop = 3;

    • getSourceList

      List<String> getSourceList()
       Event sources to include. Leave unset, to include all.
      repeated string source = 4;
      Returns:
      A list containing the source.

    • getSourceCount

      int getSourceCount()
       Event sources to include. Leave unset, to include all.
      repeated string source = 4;
      Returns:
      The count of source.

    • getSource

      String getSource(int index)
       Event sources to include. Leave unset, to include all.
      repeated string source = 4;
      Parameters:
      index - The index of the element to return.
      Returns:
      The source at the given index.

    • getSourceBytes

      com.google.protobuf.ByteString getSourceBytes(int index)
       Event sources to include. Leave unset, to include all.
      repeated string source = 4;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the source at the given index.

    • hasSeverity

      boolean hasSeverity()
       Filter on minimum severity level
      optional string severity = 5;
      Returns:
      Whether the severity field is set.

    • getSeverity

      String getSeverity()
       Filter on minimum severity level
      optional string severity = 5;
      Returns:
      The severity.

    • getSeverityBytes

      com.google.protobuf.ByteString getSeverityBytes()
       Filter on minimum severity level
      optional string severity = 5;
      Returns:
      The bytes for severity.

    • hasQ

      boolean hasQ()
       Search by text
      optional string q = 6;
      Returns:
      Whether the q field is set.

    • getQ

      String getQ()
       Search by text
      optional string q = 6;
      Returns:
      The q.

    • getQBytes

      com.google.protobuf.ByteString getQBytes()
       Search by text
      optional string q = 6;
      Returns:
      The bytes for q.

    • hasFilter

      boolean hasFilter()
       Filter query. See {doc}`../filtering` for how to write a filter query.
 Literal text search matches against the `message`, `source` and `type`
 fields. Field comparisons can use any of the following fields:
 | Field       | Type   | Description                        |
 | ----------- | ------ | ---------------------------------- |
 | `message`   | string | Filter by message text             |
 | `seqNumber` | number | Filter by archived sequence number |
 | `severity`  | enum   | Filter by event severity           |
 | `source`    | string | Filter by event source             |
 | `type`      | string | Filter by event type               |
 Possible severities: `info`, `watch`, `warning`, `distress`, `critical`
 or `severe`.
      optional string filter = 7;
      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 `message`, `source` and `type`
 fields. Field comparisons can use any of the following fields:
 | Field       | Type   | Description                        |
 | ----------- | ------ | ---------------------------------- |
 | `message`   | string | Filter by message text             |
 | `seqNumber` | number | Filter by archived sequence number |
 | `severity`  | enum   | Filter by event severity           |
 | `source`    | string | Filter by event source             |
 | `type`      | string | Filter by event type               |
 Possible severities: `info`, `watch`, `warning`, `distress`, `critical`
 or `severe`.
      optional string filter = 7;
      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 `message`, `source` and `type`
 fields. Field comparisons can use any of the following fields:
 | Field       | Type   | Description                        |
 | ----------- | ------ | ---------------------------------- |
 | `message`   | string | Filter by message text             |
 | `seqNumber` | number | Filter by archived sequence number |
 | `severity`  | enum   | Filter by event severity           |
 | `source`    | string | Filter by event source             |
 | `type`      | string | Filter by event type               |
 Possible severities: `info`, `watch`, `warning`, `distress`, `critical`
 or `severe`.
      optional string filter = 7;
      Returns:
      The bytes for filter.