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

Interface Commanding.CommandQueueInfoOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Commanding.CommandQueueInfo, Commanding.CommandQueueInfo.Builder
Enclosing class:
Commanding
public static interface Commanding.CommandQueueInfoOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getAcceptedCommandsCount()
    Number of commands that successfully passed through this queue.
    Commanding.CommandQueueEntry
    getEntries(int index)
    Currently pending (queued) commands
    int
    getEntriesCount()
    Currently pending (queued) commands
    List<Commanding.CommandQueueEntry>
    getEntriesList()
    Currently pending (queued) commands
    Commanding.CommandQueueEntryOrBuilder
    getEntriesOrBuilder(int index)
    Currently pending (queued) commands
    List<? extends Commanding.CommandQueueEntryOrBuilder>
    getEntriesOrBuilderList()
    Currently pending (queued) commands
    String
    getGroups(int index)
    This queue only considers commands that are issued by one of the users who belongs to any of these groups.
    com.google.protobuf.ByteString
    getGroupsBytes(int index)
    This queue only considers commands that are issued by one of the users who belongs to any of these groups.
    int
    getGroupsCount()
    This queue only considers commands that are issued by one of the users who belongs to any of these groups.
    List<String>
    getGroupsList()
    This queue only considers commands that are issued by one of the users who belongs to any of these groups.
    String
    getInstance()
    Yamcs instance name
    com.google.protobuf.ByteString
    getInstanceBytes()
    Yamcs instance name
    Mdb.SignificanceInfo.SignificanceLevelType
    getMinLevel()
    This queue only considers commands that are at least as significant as this level.
    String
    getName()
    Command queue name
    com.google.protobuf.ByteString
    getNameBytes()
    Command queue name
    int
    getOrder()
    Submitted commands are matches to the first queue that whose filter criteria (if any) match the command's features.
    String
    getProcessorName()
    Processor name
    com.google.protobuf.ByteString
    getProcessorNameBytes()
    Processor name
    int
    getRejectedCommandsCount()
    Number of commands that were rejected by this queue.
    Commanding.QueueState
    getState()
    Current queue state
    String
    getTcPatterns(int index)
    This queue only considers commands whose qualified name matches any of the regular expressions in this list.
    com.google.protobuf.ByteString
    getTcPatternsBytes(int index)
    This queue only considers commands whose qualified name matches any of the regular expressions in this list.
    int
    getTcPatternsCount()
    This queue only considers commands whose qualified name matches any of the regular expressions in this list.
    List<String>
    getTcPatternsList()
    This queue only considers commands whose qualified name matches any of the regular expressions in this list.
    String
    getUsers(int index)
    This queue only considers commands that are issued by one of the users in this list.
    com.google.protobuf.ByteString
    getUsersBytes(int index)
    This queue only considers commands that are issued by one of the users in this list.
    int
    getUsersCount()
    This queue only considers commands that are issued by one of the users in this list.
    List<String>
    getUsersList()
    This queue only considers commands that are issued by one of the users in this list.
    boolean
    hasAcceptedCommandsCount()
    Number of commands that successfully passed through this queue.
    boolean
    hasInstance()
    Yamcs instance name
    boolean
    hasMinLevel()
    This queue only considers commands that are at least as significant as this level.
    boolean
    hasName()
    Command queue name
    boolean
    hasOrder()
    Submitted commands are matches to the first queue that whose filter criteria (if any) match the command's features.
    boolean
    hasProcessorName()
    Processor name
    boolean
    hasRejectedCommandsCount()
    Number of commands that were rejected by this queue.
    boolean
    hasState()
    Current queue state

    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.

    • hasProcessorName

      boolean hasProcessorName()
       Processor name
      optional string processorName = 2;
      Returns:
      Whether the processorName field is set.

    • getProcessorName

      String getProcessorName()
       Processor name
      optional string processorName = 2;
      Returns:
      The processorName.

    • getProcessorNameBytes

      com.google.protobuf.ByteString getProcessorNameBytes()
       Processor name
      optional string processorName = 2;
      Returns:
      The bytes for processorName.

    • hasName

      boolean hasName()
       Command queue name
      optional string name = 3;
      Returns:
      Whether the name field is set.

    • getName

      String getName()
       Command queue name
      optional string name = 3;
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Command queue name
      optional string name = 3;
      Returns:
      The bytes for name.

    • hasState

      boolean hasState()
       Current queue state
      optional .yamcs.protobuf.commanding.QueueState state = 4;
      Returns:
      Whether the state field is set.

    • getState

      Commanding.QueueState getState()
       Current queue state
      optional .yamcs.protobuf.commanding.QueueState state = 4;
      Returns:
      The state.

    • hasOrder

      boolean hasOrder()
       Submitted commands are matches to the first queue that
 whose filter criteria (if any) match the command's
 features. Queues are considered in the order specified by
 this field, going from lowest to highest.
      optional int32 order = 9;
      Returns:
      Whether the order field is set.

    • getOrder

      int getOrder()
       Submitted commands are matches to the first queue that
 whose filter criteria (if any) match the command's
 features. Queues are considered in the order specified by
 this field, going from lowest to highest.
      optional int32 order = 9;
      Returns:
      The order.

    • getUsersList

      List<String> getUsersList()
       This queue only considers commands that are issued
 by one of the users in this list.
 If the list is empty, all commands are considered.
 Note that users/groups are considered at the same time
 (a match with any of the two is sufficient).
      repeated string users = 10;
      Returns:
      A list containing the users.

    • getUsersCount

      int getUsersCount()
       This queue only considers commands that are issued
 by one of the users in this list.
 If the list is empty, all commands are considered.
 Note that users/groups are considered at the same time
 (a match with any of the two is sufficient).
      repeated string users = 10;
      Returns:
      The count of users.

    • getUsers

      String getUsers(int index)
       This queue only considers commands that are issued
 by one of the users in this list.
 If the list is empty, all commands are considered.
 Note that users/groups are considered at the same time
 (a match with any of the two is sufficient).
      repeated string users = 10;
      Parameters:
      index - The index of the element to return.
      Returns:
      The users at the given index.

    • getUsersBytes

      com.google.protobuf.ByteString getUsersBytes(int index)
       This queue only considers commands that are issued
 by one of the users in this list.
 If the list is empty, all commands are considered.
 Note that users/groups are considered at the same time
 (a match with any of the two is sufficient).
      repeated string users = 10;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the users at the given index.

    • getGroupsList

      List<String> getGroupsList()
       This queue only considers commands that are issued
 by one of the users who belongs to any of these groups.
 If the list is empty, all commands are considered.
 Note that users/groups are considered at the same time
 (a match with any of the two is sufficient).
      repeated string groups = 11;
      Returns:
      A list containing the groups.

    • getGroupsCount

      int getGroupsCount()
       This queue only considers commands that are issued
 by one of the users who belongs to any of these groups.
 If the list is empty, all commands are considered.
 Note that users/groups are considered at the same time
 (a match with any of the two is sufficient).
      repeated string groups = 11;
      Returns:
      The count of groups.

    • getGroups

      String getGroups(int index)
       This queue only considers commands that are issued
 by one of the users who belongs to any of these groups.
 If the list is empty, all commands are considered.
 Note that users/groups are considered at the same time
 (a match with any of the two is sufficient).
      repeated string groups = 11;
      Parameters:
      index - The index of the element to return.
      Returns:
      The groups at the given index.

    • getGroupsBytes

      com.google.protobuf.ByteString getGroupsBytes(int index)
       This queue only considers commands that are issued
 by one of the users who belongs to any of these groups.
 If the list is empty, all commands are considered.
 Note that users/groups are considered at the same time
 (a match with any of the two is sufficient).
      repeated string groups = 11;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the groups at the given index.

    • hasMinLevel

      boolean hasMinLevel()
       This queue only considers commands that are at least
 as significant as this level.
      optional .yamcs.protobuf.mdb.SignificanceInfo.SignificanceLevelType minLevel = 12;
      Returns:
      Whether the minLevel field is set.

    • getMinLevel

      Mdb.SignificanceInfo.SignificanceLevelType getMinLevel()
       This queue only considers commands that are at least
 as significant as this level.
      optional .yamcs.protobuf.mdb.SignificanceInfo.SignificanceLevelType minLevel = 12;
      Returns:
      The minLevel.

    • getTcPatternsList

      List<String> getTcPatternsList()
       This queue only considers commands whose qualified name
 matches any of the regular expressions in this list.
 If the list is empty, all commands are considered.
      repeated string tcPatterns = 13;
      Returns:
      A list containing the tcPatterns.

    • getTcPatternsCount

      int getTcPatternsCount()
       This queue only considers commands whose qualified name
 matches any of the regular expressions in this list.
 If the list is empty, all commands are considered.
      repeated string tcPatterns = 13;
      Returns:
      The count of tcPatterns.

    • getTcPatterns

      String getTcPatterns(int index)
       This queue only considers commands whose qualified name
 matches any of the regular expressions in this list.
 If the list is empty, all commands are considered.
      repeated string tcPatterns = 13;
      Parameters:
      index - The index of the element to return.
      Returns:
      The tcPatterns at the given index.

    • getTcPatternsBytes

      com.google.protobuf.ByteString getTcPatternsBytes(int index)
       This queue only considers commands whose qualified name
 matches any of the regular expressions in this list.
 If the list is empty, all commands are considered.
      repeated string tcPatterns = 13;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the tcPatterns at the given index.

    • getEntriesList

      List<Commanding.CommandQueueEntry> getEntriesList()
       Currently pending (queued) commands
      repeated .yamcs.protobuf.commanding.CommandQueueEntry entries = 14;

    • getEntries

      Commanding.CommandQueueEntry getEntries(int index)
       Currently pending (queued) commands
      repeated .yamcs.protobuf.commanding.CommandQueueEntry entries = 14;

    • getEntriesCount

      int getEntriesCount()
       Currently pending (queued) commands
      repeated .yamcs.protobuf.commanding.CommandQueueEntry entries = 14;

    • getEntriesOrBuilderList

      List<? extends Commanding.CommandQueueEntryOrBuilder> getEntriesOrBuilderList()
       Currently pending (queued) commands
      repeated .yamcs.protobuf.commanding.CommandQueueEntry entries = 14;

    • getEntriesOrBuilder

      Commanding.CommandQueueEntryOrBuilder getEntriesOrBuilder(int index)
       Currently pending (queued) commands
      repeated .yamcs.protobuf.commanding.CommandQueueEntry entries = 14;

    • hasAcceptedCommandsCount

      boolean hasAcceptedCommandsCount()
       Number of commands that successfully passed through this queue.
      optional int32 acceptedCommandsCount = 15;
      Returns:
      Whether the acceptedCommandsCount field is set.

    • getAcceptedCommandsCount

      int getAcceptedCommandsCount()
       Number of commands that successfully passed through this queue.
      optional int32 acceptedCommandsCount = 15;
      Returns:
      The acceptedCommandsCount.

    • hasRejectedCommandsCount

      boolean hasRejectedCommandsCount()
       Number of commands that were rejected by this queue.
      optional int32 rejectedCommandsCount = 16;
      Returns:
      Whether the rejectedCommandsCount field is set.

    • getRejectedCommandsCount

      int getRejectedCommandsCount()
       Number of commands that were rejected by this queue.
      optional int32 rejectedCommandsCount = 16;
      Returns:
      The rejectedCommandsCount.