Package org.yamcs.protobuf.activities

Interface ListActivitiesRequestOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getInstance()
    Yamcs instance name
    com.google.protobuf.ByteString
    getInstanceBytes()
    Yamcs instance name
    int
    getLimit()
    The maximum number of returned records per page.
    String
    getNext()
    Continuation token returned by a previous page response.
    com.google.protobuf.ByteString
    getNextBytes()
    Continuation token returned by a previous page response.
    String
    getOrder()
    The order of the returned results.
    com.google.protobuf.ByteString
    getOrderBytes()
    The order of the returned results.
    String
    getQ()
    Text to search for in the description.
    com.google.protobuf.ByteString
    getQBytes()
    Text to search for in the description.
    com.google.protobuf.Timestamp
    getStart()
    Filter the lower bound of the activity's start time.
    com.google.protobuf.TimestampOrBuilder
    getStartOrBuilder()
    Filter the lower bound of the activity's start time.
    String
    getStatus(int index)
    Filter on activity status
    com.google.protobuf.ByteString
    getStatusBytes(int index)
    Filter on activity status
    int
    getStatusCount()
    Filter on activity status
    List<String>
    getStatusList()
    Filter on activity status
    com.google.protobuf.Timestamp
    getStop()
    Filter the upper bound of the activity's generation time.
    com.google.protobuf.TimestampOrBuilder
    getStopOrBuilder()
    Filter the upper bound of the activity's generation time.
    String
    getType(int index)
    The type of activity.
    com.google.protobuf.ByteString
    getTypeBytes(int index)
    The type of activity.
    int
    getTypeCount()
    The type of activity.
    List<String>
    getTypeList()
    The type of activity.
    boolean
    hasInstance()
    Yamcs instance name
    boolean
    hasLimit()
    The maximum number of returned records per page.
    boolean
    hasNext()
    Continuation token returned by a previous page response.
    boolean
    hasOrder()
    The order of the returned results.
    boolean
    hasQ()
    Text to search for in the description.
    boolean
    hasStart()
    Filter the lower bound of the activity's start time.
    boolean
    hasStop()
    Filter the upper bound of the activity'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.

    • hasLimit

      boolean hasLimit()
       The maximum number of returned records per page. Choose this value too high
  and you risk hitting the maximum response size limit enforced by the server.
 Default: ``100``
      optional int32 limit = 2;
      Returns:
      Whether the limit field is set.

    • getLimit

      int getLimit()
       The maximum number of returned records per page. Choose this value too high
  and you risk hitting the maximum response size limit enforced by the server.
 Default: ``100``
      optional int32 limit = 2;
      Returns:
      The limit.

    • hasOrder

      boolean hasOrder()
       The order of the returned results. Can be either ``asc`` or ``desc``.
 Default: ``desc``
      optional string order = 3;
      Returns:
      Whether the order field is set.

    • getOrder

      String getOrder()
       The order of the returned results. Can be either ``asc`` or ``desc``.
 Default: ``desc``
      optional string order = 3;
      Returns:
      The order.

    • getOrderBytes

      com.google.protobuf.ByteString getOrderBytes()
       The order of the returned results. Can be either ``asc`` or ``desc``.
 Default: ``desc``
      optional string order = 3;
      Returns:
      The bytes for order.

    • getStatusList

      List<String> getStatusList()
       Filter on activity status
      repeated string status = 4;
      Returns:
      A list containing the status.

    • getStatusCount

      int getStatusCount()
       Filter on activity status
      repeated string status = 4;
      Returns:
      The count of status.

    • getStatus

      String getStatus(int index)
       Filter on activity status
      repeated string status = 4;
      Parameters:
      index - The index of the element to return.
      Returns:
      The status at the given index.

    • getStatusBytes

      com.google.protobuf.ByteString getStatusBytes(int index)
       Filter on activity status
      repeated string status = 4;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the status at the given index.

    • getTypeList

      List<String> getTypeList()
       The type of activity. Names must match exactly.
      repeated string type = 5;
      Returns:
      A list containing the type.

    • getTypeCount

      int getTypeCount()
       The type of activity. Names must match exactly.
      repeated string type = 5;
      Returns:
      The count of type.

    • getType

      String getType(int index)
       The type of activity. Names must match exactly.
      repeated string type = 5;
      Parameters:
      index - The index of the element to return.
      Returns:
      The type at the given index.

    • getTypeBytes

      com.google.protobuf.ByteString getTypeBytes(int index)
       The type of activity. Names must match exactly.
      repeated string type = 5;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the type at the given index.

    • hasNext

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

    • getNext

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

    • getNextBytes

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

    • hasStart

      boolean hasStart()
       Filter the lower bound of the activity's start time. Specify a date string
 in ISO 8601 format. This bound is inclusive.
      optional .google.protobuf.Timestamp start = 7;
      Returns:
      Whether the start field is set.

    • getStart

      com.google.protobuf.Timestamp getStart()
       Filter the lower bound of the activity's start time. Specify a date string
 in ISO 8601 format. This bound is inclusive.
      optional .google.protobuf.Timestamp start = 7;
      Returns:
      The start.

    • getStartOrBuilder

      com.google.protobuf.TimestampOrBuilder getStartOrBuilder()
       Filter the lower bound of the activity's start time. Specify a date string
 in ISO 8601 format. This bound is inclusive.
      optional .google.protobuf.Timestamp start = 7;

    • hasStop

      boolean hasStop()
       Filter the upper bound of the activity's generation time. Specify a
 datestring in ISO 8601 format. This bound is exclusive.
      optional .google.protobuf.Timestamp stop = 8;
      Returns:
      Whether the stop field is set.

    • getStop

      com.google.protobuf.Timestamp getStop()
       Filter the upper bound of the activity's generation time. Specify a
 datestring in ISO 8601 format. This bound is exclusive.
      optional .google.protobuf.Timestamp stop = 8;
      Returns:
      The stop.

    • getStopOrBuilder

      com.google.protobuf.TimestampOrBuilder getStopOrBuilder()
       Filter the upper bound of the activity's generation time. Specify a
 datestring in ISO 8601 format. This bound is exclusive.
      optional .google.protobuf.Timestamp stop = 8;

    • hasQ

      boolean hasQ()
       Text to search for in the description.
      optional string q = 9;
      Returns:
      Whether the q field is set.

    • getQ

      String getQ()
       Text to search for in the description.
      optional string q = 9;
      Returns:
      The q.

    • getQBytes

      com.google.protobuf.ByteString getQBytes()
       Text to search for in the description.
      optional string q = 9;
      Returns:
      The bytes for q.