Package 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

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method 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()
      Continuation token returned by a previous page response.
      com.google.protobuf.ByteString getNextBytes()
      Continuation token returned by a previous page response.
      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.
      boolean getSearchMembers()
      When used together with ``q``, include also aggregate members (at any depth) in the search.
      Mdb.DataSourceType getSource()
      Include only parameters of the specified source.
      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()
      Continuation token returned by a previous page response.
      boolean hasPos()
      The zero-based row number at which to start outputting results.
      boolean hasQ()
      The search keywords.
      boolean hasSearchMembers()
      When used together with ``q``, include also aggregate members (at any depth) in the search.
      boolean hasSource()
      Include only parameters of the specified source.
      boolean hasSystem()
      List only direct child sub-systems or parameters 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 Detail

      • 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 namespace or name.
        optional string q = 2;
        Returns:
        Whether the q field is set.

      • getQ

        String getQ()
         The search keywords. This supports searching on namespace or name.
        optional string q = 2;
        Returns:
        The q.

      • getQBytes

        com.google.protobuf.ByteString getQBytes()
         The search keywords. This supports searching on namespace or name.
        optional string q = 2;
        Returns:
        The bytes for q.

      • hasSearchMembers

        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;
        Returns:
        Whether the searchMembers field is set.

      • getSearchMembers

        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;
        Returns:
        The searchMembers.

      • 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;
        Returns:
        Whether the details field is set.

      • 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;
        Returns:
        The details.

      • 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;
        Returns:
        A list containing the type.

      • 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;
        Returns:
        The count of type.

      • 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;
        Parameters:
        index - The index of the element to return.
        Returns:
        The type at the given index.

      • 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;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the type at the given index.

      • hasSource

        boolean hasSource()
         Include only parameters of the specified source.
        optional .yamcs.protobuf.mdb.DataSourceType source = 10;
        Returns:
        Whether the source field is set.

      • getSource

        Mdb.DataSourceType getSource()
         Include only parameters of the specified source.
        optional .yamcs.protobuf.mdb.DataSourceType source = 10;
        Returns:
        The source.

      • 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;
        Returns:
        Whether the system field is set.

      • 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;
        Returns:
        The system.

      • 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;
        Returns:
        The bytes for system.

      • 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 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;
        Returns:
        Whether the limit field is set.

      • 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;
        Returns:
        The limit.