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
    String
    getFilter()
    Filter query.
    com.google.protobuf.ByteString
    getFilterBytes()
    Filter query.
    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()
    Filter on item start
    com.google.protobuf.TimestampOrBuilder
    getStartOrBuilder()
    Filter on item start
    com.google.protobuf.Timestamp
    getStop()
    Filter on item stop
    com.google.protobuf.TimestampOrBuilder
    getStopOrBuilder()
    Filter on item stop
    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
    hasFilter()
    Filter query.
    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()
    Filter on item start
    boolean
    hasStop()
    Filter on item stop

    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()
       Filter on item start
      optional .google.protobuf.Timestamp start = 5;
      Returns:
      Whether the start field is set.

    • getStart

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

    • getStartOrBuilder

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

    • hasStop

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

    • getStop

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

    • getStopOrBuilder

      com.google.protobuf.TimestampOrBuilder getStopOrBuilder()
       Filter on item stop
      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.

    • 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.

    • hasFilter

      boolean hasFilter()
       Filter query. See {doc}`../filtering` for how to write a filter query.
 Literal text search matches against the `label` field. Field comparisons
 can use any of the following fields:
 | Field    | Type   | Description      |
 | -------- | ------ | ---------------- |
 | `label`  | string | Filter by label  |
 | `tag`    | string | Filter by tag    |
 | `type`   | enum   | Filter by type   |
 | `status` | enum   | Filter by status |
 `type` is one of `activity` or `event`.
 `status` is one of `planned`, `ready`, `waiting_on_dependency`,
 `in_progress`, `succeeded`, `aborted`, `failed`, `skipped`, `canceled`,
 `paused` or `waiting_for_input`.
      optional string filter = 10;
      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 `label` field. Field comparisons
 can use any of the following fields:
 | Field    | Type   | Description      |
 | -------- | ------ | ---------------- |
 | `label`  | string | Filter by label  |
 | `tag`    | string | Filter by tag    |
 | `type`   | enum   | Filter by type   |
 | `status` | enum   | Filter by status |
 `type` is one of `activity` or `event`.
 `status` is one of `planned`, `ready`, `waiting_on_dependency`,
 `in_progress`, `succeeded`, `aborted`, `failed`, `skipped`, `canceled`,
 `paused` or `waiting_for_input`.
      optional string filter = 10;
      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 `label` field. Field comparisons
 can use any of the following fields:
 | Field    | Type   | Description      |
 | -------- | ------ | ---------------- |
 | `label`  | string | Filter by label  |
 | `tag`    | string | Filter by tag    |
 | `type`   | enum   | Filter by type   |
 | `status` | enum   | Filter by status |
 `type` is one of `activity` or `event`.
 `status` is one of `planned`, `ready`, `waiting_on_dependency`,
 `in_progress`, `succeeded`, `aborted`, `failed`, `skipped`, `canceled`,
 `paused` or `waiting_for_input`.
      optional string filter = 10;
      Returns:
      The bytes for filter.