Package org.yamcs.protobuf

Interface Mdb.ListAlgorithmsRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Mdb.ListAlgorithmsRequest, Mdb.ListAlgorithmsRequest.Builder
Enclosing class:
Mdb
public static interface Mdb.ListAlgorithmsRequestOrBuilder 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 algorithms 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.
    int
    getPos()
    The zero-based row number at which to start outputting results.
    String
    getQ()
    The search keywords.
    com.google.protobuf.ByteString
    getQBytes()
    The search keywords.
    Mdb.AlgorithmInfo.Scope
    getScope()
    Include only algorithms of the specified scope
    String
    getSystem()
    List only direct child sub-systems or algorithms of the specified system.
    com.google.protobuf.ByteString
    getSystemBytes()
    List only direct child sub-systems or algorithms of the specified system.
    boolean
    hasInstance()
    Yamcs instance name.
    boolean
    hasLimit()
    The maximum number of returned algorithms per page.
    boolean
    hasNext()
    Continuation token returned by a previous page response.
    boolean
    hasPos()
    The zero-based row number at which to start outputting results.
    boolean
    hasQ()
    The search keywords.
    boolean
    hasScope()
    Include only algorithms of the specified scope
    boolean
    hasSystem()
    List only direct child sub-systems or algorithms of the specified system.

    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.

    • hasQ

      boolean hasQ()
       The search keywords. This supports searching on qualified name or alias.
      optional string q = 2;
      Returns:
      Whether the q field is set.

    • getQ

      String getQ()
       The search keywords. This supports searching on qualified name or alias.
      optional string q = 2;
      Returns:
      The q.

    • getQBytes

      com.google.protobuf.ByteString getQBytes()
       The search keywords. This supports searching on qualified name or alias.
      optional string q = 2;
      Returns:
      The bytes for q.

    • hasSystem

      boolean hasSystem()
       List only direct child sub-systems or algorithms of the specified system.
 For example when querying the system "/a" against an MDB with algorithms
 "/a/b/c" and "/a/c", the result returns the sub system "/a/b" and the
 algorithm "/a/c".
 When ``system`` and ``q`` are used together, matching algorithms at any
 depth are returned, starting from the specified space system.
      optional string system = 10;
      Returns:
      Whether the system field is set.

    • getSystem

      String getSystem()
       List only direct child sub-systems or algorithms of the specified system.
 For example when querying the system "/a" against an MDB with algorithms
 "/a/b/c" and "/a/c", the result returns the sub system "/a/b" and the
 algorithm "/a/c".
 When ``system`` and ``q`` are used together, matching algorithms at any
 depth are returned, starting from the specified space system.
      optional string system = 10;
      Returns:
      The system.

    • getSystemBytes

      com.google.protobuf.ByteString getSystemBytes()
       List only direct child sub-systems or algorithms of the specified system.
 For example when querying the system "/a" against an MDB with algorithms
 "/a/b/c" and "/a/c", the result returns the sub system "/a/b" and the
 algorithm "/a/c".
 When ``system`` and ``q`` are used together, matching algorithms at any
 depth are returned, starting from the specified space system.
      optional string system = 10;
      Returns:
      The bytes for system.

    • hasNext

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

    • getNext

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

    • getNextBytes

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

    • hasPos

      boolean hasPos()
       The zero-based row number at which to start outputting results. Default: ``0``
      optional int32 pos = 8;
      Returns:
      Whether the pos field is set.

    • getPos

      int getPos()
       The zero-based row number at which to start outputting results. Default: ``0``
      optional int32 pos = 8;
      Returns:
      The pos.

    • hasLimit

      boolean hasLimit()
       The maximum number of returned algorithms 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 = 9;
      Returns:
      Whether the limit field is set.

    • getLimit

      int getLimit()
       The maximum number of returned algorithms 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 = 9;
      Returns:
      The limit.

    • hasScope

      boolean hasScope()
       Include only algorithms of the specified scope
      optional .yamcs.protobuf.mdb.AlgorithmInfo.Scope scope = 11;
      Returns:
      Whether the scope field is set.

    • getScope

      Mdb.AlgorithmInfo.Scope getScope()
       Include only algorithms of the specified scope
      optional .yamcs.protobuf.mdb.AlgorithmInfo.Scope scope = 11;
      Returns:
      The scope.