org.yamcs.protobuf

Interface Mdb.ListParametersRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Mdb.ListParametersRequest, Mdb.ListParametersRequest.Builder

Enclosing class:

Mdb

public static interface Mdb.ListParametersRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	getDetails() Include details on each returned parameter (this includes long descriptions, aliases, and detailed type information).
String	getInstance() Yamcs instance name.
com.google.protobuf.ByteString	getInstanceBytes() Yamcs instance name.
int	getLimit() The maximum number of returned parameters per page.
String	getNext() optional string next = 7;
com.google.protobuf.ByteString	getNextBytes() optional string next = 7;
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.DataSourceType	getSource() optional .yamcs.protobuf.mdb.DataSourceType source = 10;
String	getSystem() List only direct child sub-systems or parameters of the specified system.
com.google.protobuf.ByteString	getSystemBytes() List only direct child sub-systems or parameters of the specified system.
String	getType(int index) The parameter types to be included in the result.
com.google.protobuf.ByteString	getTypeBytes(int index) The parameter types to be included in the result.
int	getTypeCount() The parameter types to be included in the result.
List<String>	getTypeList() The parameter types to be included in the result.
boolean	hasDetails() Include details on each returned parameter (this includes long descriptions, aliases, and detailed type information).
boolean	hasInstance() Yamcs instance name.
boolean	hasLimit() The maximum number of returned parameters per page.
boolean	hasNext() optional string next = 7;
boolean	hasPos() The zero-based row number at which to start outputting results.
boolean	hasQ() The search keywords.
boolean	hasSource() optional .yamcs.protobuf.mdb.DataSourceType source = 10;
boolean	hasSystem() List only direct child sub-systems or parameters of the specified system.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasInstance

boolean hasInstance()

 Yamcs instance name.
 

optional string instance = 1;

getInstance

String getInstance()

 Yamcs instance name.
 

optional string instance = 1;

getInstanceBytes

com.google.protobuf.ByteString getInstanceBytes()

 Yamcs instance name.
 

optional string instance = 1;

hasQ

boolean hasQ()

 The search keywords. This supports searching on namespace or name.
 

optional string q = 2;

getQ

String getQ()

 The search keywords. This supports searching on namespace or name.
 

optional string q = 2;

getQBytes

com.google.protobuf.ByteString getQBytes()

 The search keywords. This supports searching on namespace or name.
 

optional string q = 2;

hasDetails

boolean hasDetails()

 Include details on each returned parameter (this includes long
 descriptions, aliases, and detailed type information).
 If unset, only summary information is returned.
 

optional bool details = 4;

getDetails

boolean getDetails()

 Include details on each returned parameter (this includes long
 descriptions, aliases, and detailed type information).
 If unset, only summary information is returned.
 

optional bool details = 4;

getTypeList

List<String> getTypeList()

 The parameter types to be included in the result. Valid types are ``boolean``,
 ``binary``, ``enumeration``, ``float``, ``integer`` or ``string``.
 If unspecified, parameters of all types will be included.
 

repeated string type = 5;

getTypeCount

int getTypeCount()

 The parameter types to be included in the result. Valid types are ``boolean``,
 ``binary``, ``enumeration``, ``float``, ``integer`` or ``string``.
 If unspecified, parameters of all types will be included.
 

repeated string type = 5;

getType

String getType(int index)

 The parameter types to be included in the result. Valid types are ``boolean``,
 ``binary``, ``enumeration``, ``float``, ``integer`` or ``string``.
 If unspecified, parameters of all types will be included.
 

repeated string type = 5;

getTypeBytes

com.google.protobuf.ByteString getTypeBytes(int index)

 The parameter types to be included in the result. Valid types are ``boolean``,
 ``binary``, ``enumeration``, ``float``, ``integer`` or ``string``.
 If unspecified, parameters of all types will be included.
 

repeated string type = 5;

hasSource

boolean hasSource()

optional .yamcs.protobuf.mdb.DataSourceType source = 10;

getSource

Mdb.DataSourceType getSource()

optional .yamcs.protobuf.mdb.DataSourceType source = 10;

hasSystem

boolean hasSystem()

 List only direct child sub-systems or parameters of the specified system.
 For example when querying the system "/a" against an MDB with parameters
 "/a/b/c" and "/a/c", the result returns the sub system "/a/b" and the
 parameter "/a/c".
 When ``system`` and ``q`` are used together, matching parameters at any
 depth are returned, starting from the specified space system.
 

optional string system = 11;

getSystem

String getSystem()

 List only direct child sub-systems or parameters of the specified system.
 For example when querying the system "/a" against an MDB with parameters
 "/a/b/c" and "/a/c", the result returns the sub system "/a/b" and the
 parameter "/a/c".
 When ``system`` and ``q`` are used together, matching parameters at any
 depth are returned, starting from the specified space system.
 

optional string system = 11;

getSystemBytes

com.google.protobuf.ByteString getSystemBytes()

 List only direct child sub-systems or parameters of the specified system.
 For example when querying the system "/a" against an MDB with parameters
 "/a/b/c" and "/a/c", the result returns the sub system "/a/b" and the
 parameter "/a/c".
 When ``system`` and ``q`` are used together, matching parameters at any
 depth are returned, starting from the specified space system.
 

optional string system = 11;

hasNext

boolean hasNext()

optional string next = 7;

getNext

String getNext()

optional string next = 7;

getNextBytes

com.google.protobuf.ByteString getNextBytes()

optional string next = 7;

hasPos

boolean hasPos()

 The zero-based row number at which to start outputting results. Default: ``0``
 

optional int32 pos = 8;

getPos

int getPos()

 The zero-based row number at which to start outputting results. Default: ``0``
 

optional int32 pos = 8;

hasLimit

boolean hasLimit()

 The maximum number of returned parameters 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;

getLimit

int getLimit()

 The maximum number of returned parameters 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;