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

Interface ListItemsRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ListItemsRequest, ListItemsRequest.Builder
public interface ListItemsRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getBand()
    Use the band defined source and filter
    com.google.protobuf.ByteString
    getBandBytes()
    Use the band defined source and filter
    boolean
    getDetails()
    If true, send the items with full details If false, some details like the description will be omited from the listed items
    ItemFilter
    getFilters(int index)
    If the band is not specified, these filters and the source above will be used
    int
    getFiltersCount()
    If the band is not specified, these filters and the source above will be used
    List<ItemFilter>
    getFiltersList()
    If the band is not specified, these filters and the source above will be used
    ItemFilterOrBuilder
    getFiltersOrBuilder(int index)
    If the band is not specified, these filters and the source above will be used
    List<? extends ItemFilterOrBuilder>
    getFiltersOrBuilderList()
    If the band is not specified, these filters and the source above will be used
    String
    getInstance()
    Yamcs instance name
    com.google.protobuf.ByteString
    getInstanceBytes()
    Yamcs instance name
    int
    getLimit()
    optional int32 limit = 3;
    String
    getNext()
    Continuation token returned by a previous page response.
    com.google.protobuf.ByteString
    getNextBytes()
    Continuation token returned by a previous page response.
    String
    getSource()
    Item source
    com.google.protobuf.ByteString
    getSourceBytes()
    Item source
    com.google.protobuf.Timestamp
    getStart()
    optional .google.protobuf.Timestamp start = 5;
    com.google.protobuf.TimestampOrBuilder
    getStartOrBuilder()
    optional .google.protobuf.Timestamp start = 5;
    com.google.protobuf.Timestamp
    getStop()
    optional .google.protobuf.Timestamp stop = 6;
    com.google.protobuf.TimestampOrBuilder
    getStopOrBuilder()
    optional .google.protobuf.Timestamp stop = 6;
    boolean
    hasBand()
    Use the band defined source and filter
    boolean
    hasDetails()
    If true, send the items with full details If false, some details like the description will be omited from the listed items
    boolean
    hasInstance()
    Yamcs instance name
    boolean
    hasLimit()
    optional int32 limit = 3;
    boolean
    hasNext()
    Continuation token returned by a previous page response.
    boolean
    hasSource()
    Item source
    boolean
    hasStart()
    optional .google.protobuf.Timestamp start = 5;
    boolean
    hasStop()
    optional .google.protobuf.Timestamp stop = 6;

    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.

    • hasSource

      boolean hasSource()
       Item source
      optional string source = 2;
      Returns:
      Whether the source field is set.

    • getSource

      String getSource()
       Item source
      optional string source = 2;
      Returns:
      The source.

    • getSourceBytes

      com.google.protobuf.ByteString getSourceBytes()
       Item source
      optional string source = 2;
      Returns:
      The bytes for source.

    • hasLimit

      boolean hasLimit()
      optional int32 limit = 3;
      Returns:
      Whether the limit field is set.

    • getLimit

      int getLimit()
      optional int32 limit = 3;
      Returns:
      The limit.

    • hasNext

      boolean hasNext()
       Continuation token returned by a previous page response.
      optional string next = 4;
      Returns:
      Whether the next field is set.

    • getNext

      String getNext()
       Continuation token returned by a previous page response.
      optional string next = 4;
      Returns:
      The next.

    • getNextBytes

      com.google.protobuf.ByteString getNextBytes()
       Continuation token returned by a previous page response.
      optional string next = 4;
      Returns:
      The bytes for next.

    • hasStart

      boolean hasStart()
      optional .google.protobuf.Timestamp start = 5;
      Returns:
      Whether the start field is set.

    • getStart

      com.google.protobuf.Timestamp getStart()
      optional .google.protobuf.Timestamp start = 5;
      Returns:
      The start.

    • getStartOrBuilder

      com.google.protobuf.TimestampOrBuilder getStartOrBuilder()
      optional .google.protobuf.Timestamp start = 5;

    • hasStop

      boolean hasStop()
      optional .google.protobuf.Timestamp stop = 6;
      Returns:
      Whether the stop field is set.

    • getStop

      com.google.protobuf.Timestamp getStop()
      optional .google.protobuf.Timestamp stop = 6;
      Returns:
      The stop.

    • getStopOrBuilder

      com.google.protobuf.TimestampOrBuilder getStopOrBuilder()
      optional .google.protobuf.Timestamp stop = 6;

    • hasBand

      boolean hasBand()
       Use the band defined source and filter
      optional string band = 7;
      Returns:
      Whether the band field is set.

    • getBand

      String getBand()
       Use the band defined source and filter
      optional string band = 7;
      Returns:
      The band.

    • getBandBytes

      com.google.protobuf.ByteString getBandBytes()
       Use the band defined source and filter
      optional string band = 7;
      Returns:
      The bytes for band.

    • getFiltersList

      List<ItemFilter> getFiltersList()
       If the band is not specified, these filters and the source above will be used
      repeated .yamcs.protobuf.timeline.ItemFilter filters = 8;

    • getFilters

      ItemFilter getFilters(int index)
       If the band is not specified, these filters and the source above will be used
      repeated .yamcs.protobuf.timeline.ItemFilter filters = 8;

    • getFiltersCount

      int getFiltersCount()
       If the band is not specified, these filters and the source above will be used
      repeated .yamcs.protobuf.timeline.ItemFilter filters = 8;

    • getFiltersOrBuilderList

      List<? extends ItemFilterOrBuilder> getFiltersOrBuilderList()
       If the band is not specified, these filters and the source above will be used
      repeated .yamcs.protobuf.timeline.ItemFilter filters = 8;

    • getFiltersOrBuilder

      ItemFilterOrBuilder getFiltersOrBuilder(int index)
       If the band is not specified, these filters and the source above will be used
      repeated .yamcs.protobuf.timeline.ItemFilter filters = 8;

    • hasDetails

      boolean hasDetails()
       If true, send the items with full details
 If false, some details like the description will be omited from the listed items
      optional bool details = 9;
      Returns:
      Whether the details field is set.

    • getDetails

      boolean getDetails()
       If true, send the items with full details
 If false, some details like the description will be omited from the listed items
      optional bool details = 9;
      Returns:
      The details.