Package org.yamcs.protobuf

Interface GetArchivedParametersInfoRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
GetArchivedParametersInfoRequest, GetArchivedParametersInfoRequest.Builder
public interface GetArchivedParametersInfoRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getFilter()
    Filter query.
    com.google.protobuf.ByteString
    getFilterBytes()
    Filter query.
    String
    getInstance()
    Yamcs instance name
    com.google.protobuf.ByteString
    getInstanceBytes()
    Yamcs instance name
    int
    getLimit()
    The maximum number of returned parameters.
    String
    getNext()
    Continuation token returned by a previous page response.
    com.google.protobuf.ByteString
    getNextBytes()
    Continuation token returned by a previous page response.
    boolean
    hasFilter()
    Filter query.
    boolean
    hasInstance()
    Yamcs instance name
    boolean
    hasLimit()
    The maximum number of returned parameters.
    boolean
    hasNext()
    Continuation token returned by a previous page response.

    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.

    • hasFilter

      boolean hasFilter()
       Filter query. See {doc}`../filtering` for how to write a filter query.
 Literal text search matches against the `parameter` field. Field
 comparisons can use any of the following fields:
 | Field       | Type   | Description              |
 | ----------- | ------ | ------------------------ |
 | `pid`       | number | Filter by PID            |
 | `parameter` | string | Filter by parameter name |
 | `rawType`   | enum   | Filter by raw type       |
 | `gid`       | number | Filter by GID            |
 Possible raw types: `aggregate`, `array`, `binary`, `boolean`, `double`,
 `enumerated`, `float`, `none`, `sint32`, `sint64`, `string`, `timestamp`,
 `uint32` or `uint64`.
      optional string filter = 4;
      Returns:
      Whether the filter field is set.

    • getFilter

      String getFilter()
       Filter query. See {doc}`../filtering` for how to write a filter query.
 Literal text search matches against the `parameter` field. Field
 comparisons can use any of the following fields:
 | Field       | Type   | Description              |
 | ----------- | ------ | ------------------------ |
 | `pid`       | number | Filter by PID            |
 | `parameter` | string | Filter by parameter name |
 | `rawType`   | enum   | Filter by raw type       |
 | `gid`       | number | Filter by GID            |
 Possible raw types: `aggregate`, `array`, `binary`, `boolean`, `double`,
 `enumerated`, `float`, `none`, `sint32`, `sint64`, `string`, `timestamp`,
 `uint32` or `uint64`.
      optional string filter = 4;
      Returns:
      The filter.

    • getFilterBytes

      com.google.protobuf.ByteString getFilterBytes()
       Filter query. See {doc}`../filtering` for how to write a filter query.
 Literal text search matches against the `parameter` field. Field
 comparisons can use any of the following fields:
 | Field       | Type   | Description              |
 | ----------- | ------ | ------------------------ |
 | `pid`       | number | Filter by PID            |
 | `parameter` | string | Filter by parameter name |
 | `rawType`   | enum   | Filter by raw type       |
 | `gid`       | number | Filter by GID            |
 Possible raw types: `aggregate`, `array`, `binary`, `boolean`, `double`,
 `enumerated`, `float`, `none`, `sint32`, `sint64`, `string`, `timestamp`,
 `uint32` or `uint64`.
      optional string filter = 4;
      Returns:
      The bytes for filter.

    • hasLimit

      boolean hasLimit()
       The maximum number of returned parameters. Choose this value too
 high and you risk hitting the maximum response size limit enforced by the
 server. Default: `100`
      optional int32 limit = 7;
      Returns:
      Whether the limit field is set.

    • getLimit

      int getLimit()
       The maximum number of returned parameters. Choose this value too
 high and you risk hitting the maximum response size limit enforced by the
 server. Default: `100`
      optional int32 limit = 7;
      Returns:
      The limit.

    • hasNext

      boolean hasNext()
       Continuation token returned by a previous page response.
      optional string next = 8;
      Returns:
      Whether the next field is set.

    • getNext

      String getNext()
       Continuation token returned by a previous page response.
      optional string next = 8;
      Returns:
      The next.

    • getNextBytes

      com.google.protobuf.ByteString getNextBytes()
       Continuation token returned by a previous page response.
      optional string next = 8;
      Returns:
      The bytes for next.