Class Umadb.ReadRequest
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
umadb.v1.Umadb.ReadRequest
- All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, Umadb.ReadRequestOrBuilder
- Enclosing class:
Umadb
public static final class Umadb.ReadRequest
extends com.google.protobuf.GeneratedMessage
implements Umadb.ReadRequestOrBuilder
Request parameters for querying historical events from the store.Protobuf type
umadb.v1.ReadRequest- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classRequest parameters for querying historical events from the store.Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT, T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
com.google.protobuf.AbstractMessage.BuilderParentNested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionbooleanbooleanIf true, reads events in reverse order (from newest to oldest).intThe maximum number of events to include in a single response chunk/batch.static Umadb.ReadRequeststatic final com.google.protobuf.Descriptors.Descriptorcom.google.protobuf.Descriptors.DescriptorintgetLimit()The maximum number of events to return in the entire read operation.com.google.protobuf.Parser<Umadb.ReadRequest> getQuery()The filter criteria to apply.The filter criteria to apply.intlonggetStart()The sequence position to start reading from.booleanDeprecated.umadb.v1.ReadRequest.subscribe is deprecated.booleanIf true, reads events in reverse order (from newest to oldest).booleanThe maximum number of events to include in a single response chunk/batch.inthashCode()booleanhasLimit()The maximum number of events to return in the entire read operation.booleanhasQuery()The filter criteria to apply.booleanhasStart()The sequence position to start reading from.booleanDeprecated.umadb.v1.ReadRequest.subscribe is deprecated.protected com.google.protobuf.GeneratedMessage.FieldAccessorTablefinal booleanstatic Umadb.ReadRequest.Builderstatic Umadb.ReadRequest.BuildernewBuilder(Umadb.ReadRequest prototype) protected Umadb.ReadRequest.BuildernewBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) static Umadb.ReadRequestparseDelimitedFrom(InputStream input) static Umadb.ReadRequestparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static Umadb.ReadRequestparseFrom(byte[] data) static Umadb.ReadRequestparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static Umadb.ReadRequestparseFrom(com.google.protobuf.ByteString data) static Umadb.ReadRequestparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static Umadb.ReadRequestparseFrom(com.google.protobuf.CodedInputStream input) static Umadb.ReadRequestparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static Umadb.ReadRequestparseFrom(InputStream input) static Umadb.ReadRequestparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static Umadb.ReadRequestparseFrom(ByteBuffer data) static Umadb.ReadRequestparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<Umadb.ReadRequest> parser()voidwriteTo(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessage
computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashFields, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
QUERY_FIELD_NUMBER
public static final int QUERY_FIELD_NUMBER- See Also:
-
START_FIELD_NUMBER
public static final int START_FIELD_NUMBER- See Also:
-
BACKWARDS_FIELD_NUMBER
public static final int BACKWARDS_FIELD_NUMBER- See Also:
-
LIMIT_FIELD_NUMBER
public static final int LIMIT_FIELD_NUMBER- See Also:
-
SUBSCRIBE_FIELD_NUMBER
public static final int SUBSCRIBE_FIELD_NUMBER- See Also:
-
BATCH_SIZE_FIELD_NUMBER
public static final int BATCH_SIZE_FIELD_NUMBER- See Also:
-
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getDescriptorForTypein classcom.google.protobuf.GeneratedMessage
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessage
-
hasQuery
public boolean hasQuery()The filter criteria to apply. If omitted, all events are returned.
optional .umadb.v1.Query query = 1;- Specified by:
hasQueryin interfaceUmadb.ReadRequestOrBuilder- Returns:
- Whether the query field is set.
-
getQuery
The filter criteria to apply. If omitted, all events are returned.
optional .umadb.v1.Query query = 1;- Specified by:
getQueryin interfaceUmadb.ReadRequestOrBuilder- Returns:
- The query.
-
getQueryOrBuilder
The filter criteria to apply. If omitted, all events are returned.
optional .umadb.v1.Query query = 1;- Specified by:
getQueryOrBuilderin interfaceUmadb.ReadRequestOrBuilder
-
hasStart
public boolean hasStart()The sequence position to start reading from.
optional uint64 start = 2;- Specified by:
hasStartin interfaceUmadb.ReadRequestOrBuilder- Returns:
- Whether the start field is set.
-
getStart
public long getStart()The sequence position to start reading from.
optional uint64 start = 2;- Specified by:
getStartin interfaceUmadb.ReadRequestOrBuilder- Returns:
- The start.
-
hasBackwards
public boolean hasBackwards()If true, reads events in reverse order (from newest to oldest).
optional bool backwards = 3;- Specified by:
hasBackwardsin interfaceUmadb.ReadRequestOrBuilder- Returns:
- Whether the backwards field is set.
-
getBackwards
public boolean getBackwards()If true, reads events in reverse order (from newest to oldest).
optional bool backwards = 3;- Specified by:
getBackwardsin interfaceUmadb.ReadRequestOrBuilder- Returns:
- The backwards.
-
hasLimit
public boolean hasLimit()The maximum number of events to return in the entire read operation.
optional uint32 limit = 4;- Specified by:
hasLimitin interfaceUmadb.ReadRequestOrBuilder- Returns:
- Whether the limit field is set.
-
getLimit
public int getLimit()The maximum number of events to return in the entire read operation.
optional uint32 limit = 4;- Specified by:
getLimitin interfaceUmadb.ReadRequestOrBuilder- Returns:
- The limit.
-
hasSubscribe
Deprecated.umadb.v1.ReadRequest.subscribe is deprecated. See v1/umadb.proto;l=69Deprecated: Use the separate Subscribe RPC instead for streaming new events.
optional bool subscribe = 5 [deprecated = true];- Specified by:
hasSubscribein interfaceUmadb.ReadRequestOrBuilder- Returns:
- Whether the subscribe field is set.
-
getSubscribe
Deprecated.umadb.v1.ReadRequest.subscribe is deprecated. See v1/umadb.proto;l=69Deprecated: Use the separate Subscribe RPC instead for streaming new events.
optional bool subscribe = 5 [deprecated = true];- Specified by:
getSubscribein interfaceUmadb.ReadRequestOrBuilder- Returns:
- The subscribe.
-
hasBatchSize
public boolean hasBatchSize()The maximum number of events to include in a single response chunk/batch.
optional uint32 batch_size = 6;- Specified by:
hasBatchSizein interfaceUmadb.ReadRequestOrBuilder- Returns:
- Whether the batchSize field is set.
-
getBatchSize
public int getBatchSize()The maximum number of events to include in a single response chunk/batch.
optional uint32 batch_size = 6;- Specified by:
getBatchSizein interfaceUmadb.ReadRequestOrBuilder- Returns:
- The batchSize.
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessage
-
writeTo
- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessage- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessage
-
equals
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.google.protobuf.AbstractMessage
-
parseFrom
public static Umadb.ReadRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Umadb.ReadRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Umadb.ReadRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Umadb.ReadRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Umadb.ReadRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Umadb.ReadRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static Umadb.ReadRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static Umadb.ReadRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
public static Umadb.ReadRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static Umadb.ReadRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected Umadb.ReadRequest.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) - Overrides:
newBuilderForTypein classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-