Package org.yamcs.protobuf
Interface Mdb.ListCommandsRequestOrBuilder
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
Mdb.ListCommandsRequest
,Mdb.ListCommandsRequest.Builder
- Enclosing class:
- Mdb
public static interface Mdb.ListCommandsRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder
-
Method Summary
Modifier and TypeMethodDescriptionboolean
optional bool details = 4;
Yamcs instance name.com.google.protobuf.ByteString
Yamcs instance name.int
getLimit()
The maximum number of returned commands per page.getNext()
Continuation token returned by a previous page response.com.google.protobuf.ByteString
Continuation token returned by a previous page response.boolean
Exclude abstract commandsint
getPos()
The zero-based row number at which to start outputting results.getQ()
The search keywords.com.google.protobuf.ByteString
The search keywords.List only direct child sub-systems or commands of the specified system.com.google.protobuf.ByteString
List only direct child sub-systems or commands of the specified system.boolean
optional bool details = 4;
boolean
Yamcs instance name.boolean
hasLimit()
The maximum number of returned commands per page.boolean
hasNext()
Continuation token returned by a previous page response.boolean
Exclude abstract commandsboolean
hasPos()
The zero-based row number at which to start outputting results.boolean
hasQ()
The search keywords.boolean
List only direct child sub-systems or commands 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 commands of the specified system. For example when querying the system "/a" against an MDB with commands "/a/b/c" and "/a/c", the result returns the sub system "/a/b" and the command "/a/c". When ``system`` and ``q`` are used together, matching commands at any depth are returned, starting from the specified space system.
optional string system = 11;
- Returns:
- Whether the system field is set.
-
getSystem
String getSystem()List only direct child sub-systems or commands of the specified system. For example when querying the system "/a" against an MDB with commands "/a/b/c" and "/a/c", the result returns the sub system "/a/b" and the command "/a/c". When ``system`` and ``q`` are used together, matching commands at any depth are returned, starting from the specified space system.
optional string system = 11;
- Returns:
- The system.
-
getSystemBytes
com.google.protobuf.ByteString getSystemBytes()List only direct child sub-systems or commands of the specified system. For example when querying the system "/a" against an MDB with commands "/a/b/c" and "/a/c", the result returns the sub system "/a/b" and the command "/a/c". When ``system`` and ``q`` are used together, matching commands at any depth are returned, starting from the specified space system.
optional string system = 11;
- Returns:
- The bytes for system.
-
hasDetails
boolean hasDetails()optional bool details = 4;
- Returns:
- Whether the details field is set.
-
getDetails
boolean getDetails()optional bool details = 4;
- Returns:
- The details.
-
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 commands 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 commands 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.
-
hasNoAbstract
boolean hasNoAbstract()Exclude abstract commands
optional bool noAbstract = 10;
- Returns:
- Whether the noAbstract field is set.
-
getNoAbstract
boolean getNoAbstract()Exclude abstract commands
optional bool noAbstract = 10;
- Returns:
- The noAbstract.
-