Package org.yamcs.protobuf
Class ListEventsRequest
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
org.yamcs.protobuf.ListEventsRequest
- All Implemented Interfaces:
com.google.protobuf.Message
,com.google.protobuf.MessageLite
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,Serializable
,ListEventsRequestOrBuilder
public final class ListEventsRequest
extends com.google.protobuf.GeneratedMessageV3
implements ListEventsRequestOrBuilder
Protobuf type
yamcs.protobuf.events.ListEventsRequest
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
Protobuf typeyamcs.protobuf.events.ListEventsRequest
Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,
BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType, BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, 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
Modifier and TypeFieldDescriptionstatic final int
static final int
static final int
static final int
static final int
static final com.google.protobuf.Parser<ListEventsRequest>
Deprecated.static final int
static final int
static final int
static final int
static final int
static final int
Fields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFields
Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize
Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode
-
Method Summary
Modifier and TypeMethodDescriptionboolean
static ListEventsRequest
static final com.google.protobuf.Descriptors.Descriptor
Filter query.com.google.protobuf.ByteString
Filter query.Yamcs instance namecom.google.protobuf.ByteString
Yamcs instance nameint
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.com.google.protobuf.Parser<ListEventsRequest>
long
getPos()
Deprecated.getQ()
Text to search for in the message.com.google.protobuf.ByteString
Text to search for in the message.int
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.com.google.protobuf.ProtocolStringList
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.final com.google.protobuf.UnknownFieldSet
boolean
Filter query.int
hashCode()
boolean
Yamcs instance nameboolean
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()
Deprecated.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.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
final boolean
static ListEventsRequest.Builder
static ListEventsRequest.Builder
newBuilder
(ListEventsRequest prototype) protected ListEventsRequest.Builder
newBuilderForType
(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) protected Object
newInstance
(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) static ListEventsRequest
parseDelimitedFrom
(InputStream input) static ListEventsRequest
parseDelimitedFrom
(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ListEventsRequest
parseFrom
(byte[] data) static ListEventsRequest
parseFrom
(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ListEventsRequest
parseFrom
(com.google.protobuf.ByteString data) static ListEventsRequest
parseFrom
(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ListEventsRequest
parseFrom
(com.google.protobuf.CodedInputStream input) static ListEventsRequest
parseFrom
(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ListEventsRequest
parseFrom
(InputStream input) static ListEventsRequest
parseFrom
(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ListEventsRequest
parseFrom
(ByteBuffer data) static ListEventsRequest
parseFrom
(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<ListEventsRequest>
parser()
void
writeTo
(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, 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, writeStringNoTag
Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo
Methods 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:
-
POS_FIELD_NUMBER
public static final int POS_FIELD_NUMBER- See Also:
-
LIMIT_FIELD_NUMBER
public static final int LIMIT_FIELD_NUMBER- See Also:
-
ORDER_FIELD_NUMBER
public static final int ORDER_FIELD_NUMBER- See Also:
-
SEVERITY_FIELD_NUMBER
public static final int SEVERITY_FIELD_NUMBER- See Also:
-
SOURCE_FIELD_NUMBER
public static final int SOURCE_FIELD_NUMBER- See Also:
-
NEXT_FIELD_NUMBER
public static final int NEXT_FIELD_NUMBER- See Also:
-
START_FIELD_NUMBER
public static final int START_FIELD_NUMBER- See Also:
-
STOP_FIELD_NUMBER
public static final int STOP_FIELD_NUMBER- See Also:
-
Q_FIELD_NUMBER
public static final int Q_FIELD_NUMBER- See Also:
-
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER- See Also:
-
PARSER
Deprecated.
-
-
Method Details
-
newInstance
- Overrides:
newInstance
in classcom.google.protobuf.GeneratedMessageV3
-
getUnknownFields
public final com.google.protobuf.UnknownFieldSet getUnknownFields()- Specified by:
getUnknownFields
in interfacecom.google.protobuf.MessageOrBuilder
- Overrides:
getUnknownFields
in classcom.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 classcom.google.protobuf.GeneratedMessageV3
-
hasInstance
public boolean hasInstance()Yamcs instance name
optional string instance = 1;
- Specified by:
hasInstance
in interfaceListEventsRequestOrBuilder
- Returns:
- Whether the instance field is set.
-
getInstance
Yamcs instance name
optional string instance = 1;
- Specified by:
getInstance
in interfaceListEventsRequestOrBuilder
- Returns:
- The instance.
-
getInstanceBytes
public com.google.protobuf.ByteString getInstanceBytes()Yamcs instance name
optional string instance = 1;
- Specified by:
getInstanceBytes
in interfaceListEventsRequestOrBuilder
- Returns:
- The bytes for instance.
-
hasPos
Deprecated.The zero-based row number at which to start outputting results. Default: ``0`` This option is deprecated and will be removed in a later version. Use the returned continuationToken instead.
optional int64 pos = 2 [deprecated = true];
- Specified by:
hasPos
in interfaceListEventsRequestOrBuilder
- Returns:
- Whether the pos field is set.
-
getPos
Deprecated.The zero-based row number at which to start outputting results. Default: ``0`` This option is deprecated and will be removed in a later version. Use the returned continuationToken instead.
optional int64 pos = 2 [deprecated = true];
- Specified by:
getPos
in interfaceListEventsRequestOrBuilder
- Returns:
- The pos.
-
hasLimit
public 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;
- Specified by:
hasLimit
in interfaceListEventsRequestOrBuilder
- Returns:
- Whether the limit field is set.
-
getLimit
public 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;
- Specified by:
getLimit
in interfaceListEventsRequestOrBuilder
- Returns:
- The limit.
-
hasOrder
public boolean hasOrder()The order of the returned results. Can be either ``asc`` or ``desc``. Default: ``desc``
optional string order = 4;
- Specified by:
hasOrder
in interfaceListEventsRequestOrBuilder
- Returns:
- Whether the order field is set.
-
getOrder
The order of the returned results. Can be either ``asc`` or ``desc``. Default: ``desc``
optional string order = 4;
- Specified by:
getOrder
in interfaceListEventsRequestOrBuilder
- Returns:
- The order.
-
getOrderBytes
public com.google.protobuf.ByteString getOrderBytes()The order of the returned results. Can be either ``asc`` or ``desc``. Default: ``desc``
optional string order = 4;
- Specified by:
getOrderBytes
in interfaceListEventsRequestOrBuilder
- Returns:
- The bytes for order.
-
hasSeverity
public boolean hasSeverity()The minimum severity level of the events. One of ``info``, ``watch``, ``warning``, ``distress``, ``critical`` or ``severe``. Default: ``info``
optional string severity = 5;
- Specified by:
hasSeverity
in interfaceListEventsRequestOrBuilder
- Returns:
- Whether the severity field is set.
-
getSeverity
The minimum severity level of the events. One of ``info``, ``watch``, ``warning``, ``distress``, ``critical`` or ``severe``. Default: ``info``
optional string severity = 5;
- Specified by:
getSeverity
in interfaceListEventsRequestOrBuilder
- Returns:
- The severity.
-
getSeverityBytes
public 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;
- Specified by:
getSeverityBytes
in interfaceListEventsRequestOrBuilder
- Returns:
- The bytes for severity.
-
getSourceList
public com.google.protobuf.ProtocolStringList getSourceList()The source of the events. Names must match exactly.
repeated string source = 6;
- Specified by:
getSourceList
in interfaceListEventsRequestOrBuilder
- Returns:
- A list containing the source.
-
getSourceCount
public int getSourceCount()The source of the events. Names must match exactly.
repeated string source = 6;
- Specified by:
getSourceCount
in interfaceListEventsRequestOrBuilder
- Returns:
- The count of source.
-
getSource
The source of the events. Names must match exactly.
repeated string source = 6;
- Specified by:
getSource
in interfaceListEventsRequestOrBuilder
- Parameters:
index
- The index of the element to return.- Returns:
- The source at the given index.
-
getSourceBytes
public com.google.protobuf.ByteString getSourceBytes(int index) The source of the events. Names must match exactly.
repeated string source = 6;
- Specified by:
getSourceBytes
in interfaceListEventsRequestOrBuilder
- Parameters:
index
- The index of the value to return.- Returns:
- The bytes of the source at the given index.
-
hasNext
public boolean hasNext()Continuation token returned by a previous page response.
optional string next = 7;
- Specified by:
hasNext
in interfaceListEventsRequestOrBuilder
- Returns:
- Whether the next field is set.
-
getNext
Continuation token returned by a previous page response.
optional string next = 7;
- Specified by:
getNext
in interfaceListEventsRequestOrBuilder
- Returns:
- The next.
-
getNextBytes
public com.google.protobuf.ByteString getNextBytes()Continuation token returned by a previous page response.
optional string next = 7;
- Specified by:
getNextBytes
in interfaceListEventsRequestOrBuilder
- Returns:
- The bytes for next.
-
hasStart
public 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;
- Specified by:
hasStart
in interfaceListEventsRequestOrBuilder
- Returns:
- Whether the start field is set.
-
getStart
public 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;
- Specified by:
getStart
in interfaceListEventsRequestOrBuilder
- Returns:
- The start.
-
getStartOrBuilder
public 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;
- Specified by:
getStartOrBuilder
in interfaceListEventsRequestOrBuilder
-
hasStop
public 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;
- Specified by:
hasStop
in interfaceListEventsRequestOrBuilder
- Returns:
- Whether the stop field is set.
-
getStop
public 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;
- Specified by:
getStop
in interfaceListEventsRequestOrBuilder
- Returns:
- The stop.
-
getStopOrBuilder
public 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;
- Specified by:
getStopOrBuilder
in interfaceListEventsRequestOrBuilder
-
hasQ
public boolean hasQ()Text to search for in the message.
optional string q = 10;
- Specified by:
hasQ
in interfaceListEventsRequestOrBuilder
- Returns:
- Whether the q field is set.
-
getQ
Text to search for in the message.
optional string q = 10;
- Specified by:
getQ
in interfaceListEventsRequestOrBuilder
- Returns:
- The q.
-
getQBytes
public com.google.protobuf.ByteString getQBytes()Text to search for in the message.
optional string q = 10;
- Specified by:
getQBytes
in interfaceListEventsRequestOrBuilder
- Returns:
- The bytes for q.
-
hasFilter
public boolean hasFilter()Filter query. See :doc:`../filtering` for how to write a filter query. Literal text search matches against the fields ``message``, ``source`` and ``type``. Field comparisons can use any of the following fields: .. list-table:: :widths: 25 25 50 * - ``message`` - string - * - ``seqNumber`` - number - * - ``severity`` - enum - One of ``info``, ``watch``, ``warning``, ``distress``, ``critical`` or ``severe``. * - ``source`` - string - * - ``type`` - string -
optional string filter = 11;
- Specified by:
hasFilter
in interfaceListEventsRequestOrBuilder
- Returns:
- Whether the filter field is set.
-
getFilter
Filter query. See :doc:`../filtering` for how to write a filter query. Literal text search matches against the fields ``message``, ``source`` and ``type``. Field comparisons can use any of the following fields: .. list-table:: :widths: 25 25 50 * - ``message`` - string - * - ``seqNumber`` - number - * - ``severity`` - enum - One of ``info``, ``watch``, ``warning``, ``distress``, ``critical`` or ``severe``. * - ``source`` - string - * - ``type`` - string -
optional string filter = 11;
- Specified by:
getFilter
in interfaceListEventsRequestOrBuilder
- Returns:
- The filter.
-
getFilterBytes
public com.google.protobuf.ByteString getFilterBytes()Filter query. See :doc:`../filtering` for how to write a filter query. Literal text search matches against the fields ``message``, ``source`` and ``type``. Field comparisons can use any of the following fields: .. list-table:: :widths: 25 25 50 * - ``message`` - string - * - ``seqNumber`` - number - * - ``severity`` - enum - One of ``info``, ``watch``, ``warning``, ``distress``, ``critical`` or ``severe``. * - ``source`` - string - * - ``type`` - string -
optional string filter = 11;
- Specified by:
getFilterBytes
in interfaceListEventsRequestOrBuilder
- Returns:
- The bytes for filter.
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessageV3
-
writeTo
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessageV3
- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessageV3
-
equals
- Specified by:
equals
in interfacecom.google.protobuf.Message
- Overrides:
equals
in classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCode
in interfacecom.google.protobuf.Message
- Overrides:
hashCode
in classcom.google.protobuf.AbstractMessage
-
parseFrom
public static ListEventsRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ListEventsRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ListEventsRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ListEventsRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ListEventsRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ListEventsRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static ListEventsRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static ListEventsRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
public static ListEventsRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static ListEventsRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilder
in interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected ListEventsRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) - Specified by:
newBuilderForType
in classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForType
in interfacecom.google.protobuf.Message
- Specified by:
getParserForType
in interfacecom.google.protobuf.MessageLite
- Overrides:
getParserForType
in classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-