Package org.yamcs.protobuf
Interface ListEventsRequestOrBuilder
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
ListEventsRequest
,ListEventsRequest.Builder
public interface ListEventsRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder
-
Method Summary
Modifier and TypeMethodDescriptionYamcs instance name.com.google.protobuf.ByteString
Yamcs instance name.int
getLimit()
The maximum number of returned records per page.getNext()
Continuation token returned by a previous page response.com.google.protobuf.ByteString
Continuation token returned by a previous page response.getOrder()
The order of the returned results.com.google.protobuf.ByteString
The order of the returned results.long
getPos()
The zero-based row number at which to start outputting results.getQ()
Text to search for in the message.com.google.protobuf.ByteString
Text to search for in the message.The minimum severity level of the events.com.google.protobuf.ByteString
The minimum severity level of the events.getSource
(int index) The source of the events.com.google.protobuf.ByteString
getSourceBytes
(int index) The source of the events.int
The source of the events.The source of the events.com.google.protobuf.Timestamp
getStart()
Filter the lower bound of the event's generation time.com.google.protobuf.TimestampOrBuilder
Filter the lower bound of the event's generation time.com.google.protobuf.Timestamp
getStop()
Filter the upper bound of the event's generation time.com.google.protobuf.TimestampOrBuilder
Filter the upper bound of the event's generation time.boolean
Yamcs instance name.boolean
hasLimit()
The maximum number of returned records per page.boolean
hasNext()
Continuation token returned by a previous page response.boolean
hasOrder()
The order of the returned results.boolean
hasPos()
The zero-based row number at which to start outputting results.boolean
hasQ()
Text to search for in the message.boolean
The minimum severity level of the events.boolean
hasStart()
Filter the lower bound of the event's generation time.boolean
hasStop()
Filter the upper bound of the event's generation time.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.
-
hasPos
boolean hasPos()The zero-based row number at which to start outputting results. Default: ``0``
optional int64 pos = 2;
- Returns:
- Whether the pos field is set.
-
getPos
long getPos()The zero-based row number at which to start outputting results. Default: ``0``
optional int64 pos = 2;
- Returns:
- The pos.
-
hasLimit
boolean hasLimit()The maximum number of returned records 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 = 3;
- Returns:
- Whether the limit field is set.
-
getLimit
int getLimit()The maximum number of returned records 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 = 3;
- Returns:
- The limit.
-
hasOrder
boolean hasOrder()The order of the returned results. Can be either ``asc`` or ``desc``. Default: ``desc``
optional string order = 4;
- Returns:
- Whether the order field is set.
-
getOrder
String getOrder()The order of the returned results. Can be either ``asc`` or ``desc``. Default: ``desc``
optional string order = 4;
- Returns:
- The order.
-
getOrderBytes
com.google.protobuf.ByteString getOrderBytes()The order of the returned results. Can be either ``asc`` or ``desc``. Default: ``desc``
optional string order = 4;
- Returns:
- The bytes for order.
-
hasSeverity
boolean hasSeverity()The minimum severity level of the events. One of ``info``, ``watch``, ``warning``, ``distress``, ``critical`` or ``severe``. Default: ``info``
optional string severity = 5;
- Returns:
- Whether the severity field is set.
-
getSeverity
String getSeverity()The minimum severity level of the events. One of ``info``, ``watch``, ``warning``, ``distress``, ``critical`` or ``severe``. Default: ``info``
optional string severity = 5;
- Returns:
- The severity.
-
getSeverityBytes
com.google.protobuf.ByteString getSeverityBytes()The minimum severity level of the events. One of ``info``, ``watch``, ``warning``, ``distress``, ``critical`` or ``severe``. Default: ``info``
optional string severity = 5;
- Returns:
- The bytes for severity.
-
getSourceList
The source of the events. Names must match exactly.
repeated string source = 6;
- Returns:
- A list containing the source.
-
getSourceCount
int getSourceCount()The source of the events. Names must match exactly.
repeated string source = 6;
- Returns:
- The count of source.
-
getSource
The source of the events. Names must match exactly.
repeated string source = 6;
- Parameters:
index
- The index of the element to return.- Returns:
- The source at the given index.
-
getSourceBytes
com.google.protobuf.ByteString getSourceBytes(int index) The source of the events. Names must match exactly.
repeated string source = 6;
- Parameters:
index
- The index of the value to return.- Returns:
- The bytes of the source at the given index.
-
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.
-
hasStart
boolean hasStart()Filter the lower bound of the event's generation time. Specify a date string in ISO 8601 format. This bound is inclusive.
optional .google.protobuf.Timestamp start = 8;
- Returns:
- Whether the start field is set.
-
getStart
com.google.protobuf.Timestamp getStart()Filter the lower bound of the event's generation time. Specify a date string in ISO 8601 format. This bound is inclusive.
optional .google.protobuf.Timestamp start = 8;
- Returns:
- The start.
-
getStartOrBuilder
com.google.protobuf.TimestampOrBuilder getStartOrBuilder()Filter the lower bound of the event's generation time. Specify a date string in ISO 8601 format. This bound is inclusive.
optional .google.protobuf.Timestamp start = 8;
-
hasStop
boolean hasStop()Filter the upper bound of the event's generation time. Specify a date string in ISO 8601 format. This bound is exclusive.
optional .google.protobuf.Timestamp stop = 9;
- Returns:
- Whether the stop field is set.
-
getStop
com.google.protobuf.Timestamp getStop()Filter the upper bound of the event's generation time. Specify a date string in ISO 8601 format. This bound is exclusive.
optional .google.protobuf.Timestamp stop = 9;
- Returns:
- The stop.
-
getStopOrBuilder
com.google.protobuf.TimestampOrBuilder getStopOrBuilder()Filter the upper bound of the event's generation time. Specify a date string in ISO 8601 format. This bound is exclusive.
optional .google.protobuf.Timestamp stop = 9;
-
hasQ
boolean hasQ()Text to search for in the message.
optional string q = 10;
- Returns:
- Whether the q field is set.
-
getQ
String getQ()Text to search for in the message.
optional string q = 10;
- Returns:
- The q.
-
getQBytes
com.google.protobuf.ByteString getQBytes()Text to search for in the message.
optional string q = 10;
- Returns:
- The bytes for q.
-