Class Mdb.ListParametersRequest

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3
      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.google.protobuf.GeneratedMessageV3
      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
      • hasQ

        public boolean hasQ()
         The search keywords. This supports searching on namespace or name.
         
        optional string q = 2;
        Specified by:
        hasQ in interface Mdb.ListParametersRequestOrBuilder
        Returns:
        Whether the q field is set.
      • getQBytes

        public com.google.protobuf.ByteString getQBytes()
         The search keywords. This supports searching on namespace or name.
         
        optional string q = 2;
        Specified by:
        getQBytes in interface Mdb.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:
        hasSearchMembers in interface Mdb.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:
        getSearchMembers in interface Mdb.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:
        hasDetails in interface Mdb.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:
        getDetails in interface Mdb.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:
        getTypeList in interface Mdb.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:
        getTypeCount in interface Mdb.ListParametersRequestOrBuilder
        Returns:
        The count of type.
      • getType

        public 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;
        Specified by:
        getType in interface Mdb.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:
        getTypeBytes in interface Mdb.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:
        hasSource in interface Mdb.ListParametersRequestOrBuilder
        Returns:
        Whether the source field is set.
      • 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:
        hasSystem in interface Mdb.ListParametersRequestOrBuilder
        Returns:
        Whether the system field is set.
      • getSystem

        public 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;
        Specified by:
        getSystem in interface Mdb.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:
        getSystemBytes in interface Mdb.ListParametersRequestOrBuilder
        Returns:
        The bytes for system.
      • hasNext

        public boolean hasNext()
         Continuation token returned by a previous page response.
         
        optional string next = 7;
        Specified by:
        hasNext in interface Mdb.ListParametersRequestOrBuilder
        Returns:
        Whether the next field is set.
      • getNextBytes

        public com.google.protobuf.ByteString getNextBytes()
         Continuation token returned by a previous page response.
         
        optional string next = 7;
        Specified by:
        getNextBytes in interface Mdb.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:
        hasPos in interface Mdb.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:
        getPos in interface Mdb.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:
        hasLimit in interface Mdb.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:
        getLimit in interface Mdb.ListParametersRequestOrBuilder
        Returns:
        The limit.
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3
      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
                     throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException
      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3
      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage
      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.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
      • newBuilderForType

        public Mdb.ListParametersRequest.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite
      • toBuilder

        public Mdb.ListParametersRequest.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite
      • newBuilderForType

        protected Mdb.ListParametersRequest.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • getParserForType

        public com.google.protobuf.Parser<Mdb.ListParametersRequest> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3
      • getDefaultInstanceForType

        public Mdb.ListParametersRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder