java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
org.yamcs.protobuf.Mdb.ListParametersRequest
- All Implemented Interfaces:
com.google.protobuf.Message,com.google.protobuf.MessageLite,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Serializable,Mdb.ListParametersRequestOrBuilder
- Enclosing class:
Mdb
public static final class Mdb.ListParametersRequest
extends com.google.protobuf.GeneratedMessageV3
implements Mdb.ListParametersRequestOrBuilder
Protobuf type
yamcs.protobuf.mdb.ListParametersRequest- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classProtobuf typeyamcs.protobuf.mdb.ListParametersRequestNested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final com.google.protobuf.Parser<Mdb.ListParametersRequest> Deprecated.static final intstatic final intstatic final intstatic final intstatic final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionbooleanstatic Mdb.ListParametersRequeststatic final com.google.protobuf.Descriptors.DescriptorbooleanInclude details on each returned parameter (this includes long descriptions, aliases, and detailed type information).Yamcs instance namecom.google.protobuf.ByteStringYamcs instance nameintgetLimit()The maximum number of returned parameters per page.getNext()Continuation token returned by a previous page response.com.google.protobuf.ByteStringContinuation token returned by a previous page response.com.google.protobuf.Parser<Mdb.ListParametersRequest> intgetPos()The zero-based row number at which to start outputting results.getQ()The search keywords.com.google.protobuf.ByteStringThe search keywords.booleanWhen used together with `q`, include also aggregate members (at any depth) in the search.intInclude only parameters of the specified source.List only direct child sub-systems or parameters of the specified system.com.google.protobuf.ByteStringList only direct child sub-systems or parameters of the specified system.getType(int index) The parameter types to be included in the result.com.google.protobuf.ByteStringgetTypeBytes(int index) The parameter types to be included in the result.intThe parameter types to be included in the result.com.google.protobuf.ProtocolStringListThe parameter types to be included in the result.final com.google.protobuf.UnknownFieldSetbooleanInclude details on each returned parameter (this includes long descriptions, aliases, and detailed type information).inthashCode()booleanYamcs instance namebooleanhasLimit()The maximum number of returned parameters per page.booleanhasNext()Continuation token returned by a previous page response.booleanhasPos()The zero-based row number at which to start outputting results.booleanhasQ()The search keywords.booleanWhen used together with `q`, include also aggregate members (at any depth) in the search.booleanInclude only parameters of the specified source.booleanList only direct child sub-systems or parameters of the specified system.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTablefinal booleannewBuilder(Mdb.ListParametersRequest prototype) protected Mdb.ListParametersRequest.BuildernewBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) protected ObjectnewInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) static Mdb.ListParametersRequestparseDelimitedFrom(InputStream input) static Mdb.ListParametersRequestparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static Mdb.ListParametersRequestparseFrom(byte[] data) static Mdb.ListParametersRequestparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static Mdb.ListParametersRequestparseFrom(com.google.protobuf.ByteString data) static Mdb.ListParametersRequestparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static Mdb.ListParametersRequestparseFrom(com.google.protobuf.CodedInputStream input) static Mdb.ListParametersRequestparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static Mdb.ListParametersRequestparseFrom(InputStream input) static Mdb.ListParametersRequestparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static Mdb.ListParametersRequestparseFrom(ByteBuffer data) static Mdb.ListParametersRequestparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<Mdb.ListParametersRequest> parser()voidwriteTo(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof
-
Field Details
-
INSTANCE_FIELD_NUMBER
public static final int INSTANCE_FIELD_NUMBER- See Also:
-
Q_FIELD_NUMBER
public static final int Q_FIELD_NUMBER- See Also:
-
SEARCHMEMBERS_FIELD_NUMBER
public static final int SEARCHMEMBERS_FIELD_NUMBER- See Also:
-
DETAILS_FIELD_NUMBER
public static final int DETAILS_FIELD_NUMBER- See Also:
-
TYPE_FIELD_NUMBER
public static final int TYPE_FIELD_NUMBER- See Also:
-
SOURCE_FIELD_NUMBER
public static final int SOURCE_FIELD_NUMBER- See Also:
-
SYSTEM_FIELD_NUMBER
public static final int SYSTEM_FIELD_NUMBER- See Also:
-
NEXT_FIELD_NUMBER
public static final int NEXT_FIELD_NUMBER- See Also:
-
POS_FIELD_NUMBER
public static final int POS_FIELD_NUMBER- See Also:
-
LIMIT_FIELD_NUMBER
public static final int LIMIT_FIELD_NUMBER- See Also:
-
PARSER
Deprecated.
-
-
Method Details
-
newInstance
- Overrides:
newInstancein classcom.google.protobuf.GeneratedMessageV3
-
getUnknownFields
public final com.google.protobuf.UnknownFieldSet getUnknownFields()- Specified by:
getUnknownFieldsin interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3
-
hasInstance
public boolean hasInstance()Yamcs instance name
optional string instance = 1;- Specified by:
hasInstancein interfaceMdb.ListParametersRequestOrBuilder- Returns:
- Whether the instance field is set.
-
getInstance
Yamcs instance name
optional string instance = 1;- Specified by:
getInstancein interfaceMdb.ListParametersRequestOrBuilder- Returns:
- The instance.
-
getInstanceBytes
public com.google.protobuf.ByteString getInstanceBytes()Yamcs instance name
optional string instance = 1;- Specified by:
getInstanceBytesin interfaceMdb.ListParametersRequestOrBuilder- Returns:
- The bytes for instance.
-
hasQ
public boolean hasQ()The search keywords. This supports searching on qualified name or alias.
optional string q = 2;- Specified by:
hasQin interfaceMdb.ListParametersRequestOrBuilder- Returns:
- Whether the q field is set.
-
getQ
The search keywords. This supports searching on qualified name or alias.
optional string q = 2;- Specified by:
getQin interfaceMdb.ListParametersRequestOrBuilder- Returns:
- The q.
-
getQBytes
public com.google.protobuf.ByteString getQBytes()The search keywords. This supports searching on qualified name or alias.
optional string q = 2;- Specified by:
getQBytesin interfaceMdb.ListParametersRequestOrBuilder- Returns:
- The bytes for q.
-
hasSearchMembers
public boolean hasSearchMembers()When used together with `q`, include also aggregate members (at any depth) in the search. Note that this method returns only parameters. Members are part of the type definition.
optional bool searchMembers = 12;- Specified by:
hasSearchMembersin interfaceMdb.ListParametersRequestOrBuilder- Returns:
- Whether the searchMembers field is set.
-
getSearchMembers
public boolean getSearchMembers()When used together with `q`, include also aggregate members (at any depth) in the search. Note that this method returns only parameters. Members are part of the type definition.
optional bool searchMembers = 12;- Specified by:
getSearchMembersin interfaceMdb.ListParametersRequestOrBuilder- Returns:
- The searchMembers.
-
hasDetails
public 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;- Specified by:
hasDetailsin interfaceMdb.ListParametersRequestOrBuilder- Returns:
- Whether the details field is set.
-
getDetails
public 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;- Specified by:
getDetailsin interfaceMdb.ListParametersRequestOrBuilder- Returns:
- The details.
-
getTypeList
public com.google.protobuf.ProtocolStringList 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;- Specified by:
getTypeListin interfaceMdb.ListParametersRequestOrBuilder- Returns:
- A list containing the type.
-
getTypeCount
public 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;- Specified by:
getTypeCountin interfaceMdb.ListParametersRequestOrBuilder- Returns:
- The count of type.
-
getType
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;- Specified by:
getTypein interfaceMdb.ListParametersRequestOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The type at the given index.
-
getTypeBytes
public 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;- Specified by:
getTypeBytesin interfaceMdb.ListParametersRequestOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the type at the given index.
-
hasSource
public boolean hasSource()Include only parameters of the specified source.
optional .yamcs.protobuf.mdb.DataSourceType source = 10;- Specified by:
hasSourcein interfaceMdb.ListParametersRequestOrBuilder- Returns:
- Whether the source field is set.
-
getSource
Include only parameters of the specified source.
optional .yamcs.protobuf.mdb.DataSourceType source = 10;- Specified by:
getSourcein interfaceMdb.ListParametersRequestOrBuilder- Returns:
- The source.
-
hasSystem
public 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;- Specified by:
hasSystemin interfaceMdb.ListParametersRequestOrBuilder- Returns:
- Whether the system field is set.
-
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;- Specified by:
getSystemin interfaceMdb.ListParametersRequestOrBuilder- Returns:
- The system.
-
getSystemBytes
public 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;- Specified by:
getSystemBytesin interfaceMdb.ListParametersRequestOrBuilder- Returns:
- The bytes for system.
-
hasNext
public boolean hasNext()Continuation token returned by a previous page response.
optional string next = 7;- Specified by:
hasNextin interfaceMdb.ListParametersRequestOrBuilder- Returns:
- Whether the next field is set.
-
getNext
Continuation token returned by a previous page response.
optional string next = 7;- Specified by:
getNextin interfaceMdb.ListParametersRequestOrBuilder- Returns:
- The next.
-
getNextBytes
public com.google.protobuf.ByteString getNextBytes()Continuation token returned by a previous page response.
optional string next = 7;- Specified by:
getNextBytesin interfaceMdb.ListParametersRequestOrBuilder- Returns:
- The bytes for next.
-
hasPos
public boolean hasPos()The zero-based row number at which to start outputting results. Default: `0`
optional int32 pos = 8;- Specified by:
hasPosin interfaceMdb.ListParametersRequestOrBuilder- Returns:
- Whether the pos field is set.
-
getPos
public int getPos()The zero-based row number at which to start outputting results. Default: `0`
optional int32 pos = 8;- Specified by:
getPosin interfaceMdb.ListParametersRequestOrBuilder- Returns:
- The pos.
-
hasLimit
public 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;- Specified by:
hasLimitin interfaceMdb.ListParametersRequestOrBuilder- Returns:
- Whether the limit field is set.
-
getLimit
public 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;- Specified by:
getLimitin interfaceMdb.ListParametersRequestOrBuilder- Returns:
- The limit.
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3
-
writeTo
- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessageV3- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessageV3
-
equals
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.google.protobuf.AbstractMessage
-
parseFrom
public static Mdb.ListParametersRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Mdb.ListParametersRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Mdb.ListParametersRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Mdb.ListParametersRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Mdb.ListParametersRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Mdb.ListParametersRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static Mdb.ListParametersRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static Mdb.ListParametersRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
public static Mdb.ListParametersRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static Mdb.ListParametersRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected Mdb.ListParametersRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) - Specified by:
newBuilderForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-