Package io.axoniq.axonserver.grpc.event
Class QueryEventsRequest.Builder
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite.Builder
-
- com.google.protobuf.AbstractMessage.Builder<BuilderT>
-
- com.google.protobuf.GeneratedMessage.Builder<QueryEventsRequest.Builder>
-
- io.axoniq.axonserver.grpc.event.QueryEventsRequest.Builder
-
- All Implemented Interfaces:
com.google.protobuf.Message.Builder,com.google.protobuf.MessageLite.Builder,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,QueryEventsRequestOrBuilder,Cloneable
- Enclosing class:
- QueryEventsRequest
public static final class QueryEventsRequest.Builder extends com.google.protobuf.GeneratedMessage.Builder<QueryEventsRequest.Builder> implements QueryEventsRequestOrBuilder
Message providing the parameters for executing a Query against AxonServer.
Protobuf typeio.axoniq.axonserver.grpc.event.QueryEventsRequest
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description QueryEventsRequestbuild()QueryEventsRequestbuildPartial()QueryEventsRequest.Builderclear()QueryEventsRequest.BuilderclearContextName()Query from this context, not from the default context of the connectionQueryEventsRequest.BuilderclearForceReadFromLeader()Indicates whether to force querying events from the leader node of an Axon Server.QueryEventsRequest.BuilderclearLiveEvents()Whether to keep the query running against incoming events once the Head of the Stream is reachedQueryEventsRequest.BuilderclearNumberOfPermits()The number of results AxonServer may send before new permits need to be providedQueryEventsRequest.BuilderclearQuery()The query to execute against the Event StreamQueryEventsRequest.BuilderclearQuerySnapshots()If true, snapshots will be queried instead of eventsStringgetContextName()Query from this context, not from the default context of the connectioncom.google.protobuf.ByteStringgetContextNameBytes()Query from this context, not from the default context of the connectionQueryEventsRequestgetDefaultInstanceForType()static com.google.protobuf.Descriptors.DescriptorgetDescriptor()com.google.protobuf.Descriptors.DescriptorgetDescriptorForType()booleangetForceReadFromLeader()Indicates whether to force querying events from the leader node of an Axon Server.booleangetLiveEvents()Whether to keep the query running against incoming events once the Head of the Stream is reachedlonggetNumberOfPermits()The number of results AxonServer may send before new permits need to be providedStringgetQuery()The query to execute against the Event Streamcom.google.protobuf.ByteStringgetQueryBytes()The query to execute against the Event StreambooleangetQuerySnapshots()If true, snapshots will be queried instead of eventsprotected com.google.protobuf.GeneratedMessage.FieldAccessorTableinternalGetFieldAccessorTable()booleanisInitialized()QueryEventsRequest.BuildermergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)QueryEventsRequest.BuildermergeFrom(com.google.protobuf.Message other)QueryEventsRequest.BuildermergeFrom(QueryEventsRequest other)QueryEventsRequest.BuildersetContextName(String value)Query from this context, not from the default context of the connectionQueryEventsRequest.BuildersetContextNameBytes(com.google.protobuf.ByteString value)Query from this context, not from the default context of the connectionQueryEventsRequest.BuildersetForceReadFromLeader(boolean value)Indicates whether to force querying events from the leader node of an Axon Server.QueryEventsRequest.BuildersetLiveEvents(boolean value)Whether to keep the query running against incoming events once the Head of the Stream is reachedQueryEventsRequest.BuildersetNumberOfPermits(long value)The number of results AxonServer may send before new permits need to be providedQueryEventsRequest.BuildersetQuery(String value)The query to execute against the Event StreamQueryEventsRequest.BuildersetQueryBytes(com.google.protobuf.ByteString value)The query to execute against the Event StreamQueryEventsRequest.BuildersetQuerySnapshots(boolean value)If true, snapshots will be queried instead of events-
Methods inherited from class com.google.protobuf.GeneratedMessage.Builder
addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3
-
Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString
-
Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException
-
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
-
-
-
Method Detail
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessage.Builder<QueryEventsRequest.Builder>
-
clear
public QueryEventsRequest.Builder clear()
- Specified by:
clearin interfacecom.google.protobuf.Message.Builder- Specified by:
clearin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clearin classcom.google.protobuf.GeneratedMessage.Builder<QueryEventsRequest.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.Message.Builder- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getDescriptorForTypein classcom.google.protobuf.GeneratedMessage.Builder<QueryEventsRequest.Builder>
-
getDefaultInstanceForType
public QueryEventsRequest getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
build
public QueryEventsRequest build()
- Specified by:
buildin interfacecom.google.protobuf.Message.Builder- Specified by:
buildin interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
public QueryEventsRequest buildPartial()
- Specified by:
buildPartialin interfacecom.google.protobuf.Message.Builder- Specified by:
buildPartialin interfacecom.google.protobuf.MessageLite.Builder
-
mergeFrom
public QueryEventsRequest.Builder mergeFrom(com.google.protobuf.Message other)
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<QueryEventsRequest.Builder>
-
mergeFrom
public QueryEventsRequest.Builder mergeFrom(QueryEventsRequest other)
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessage.Builder<QueryEventsRequest.Builder>
-
mergeFrom
public QueryEventsRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Specified by:
mergeFromin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<QueryEventsRequest.Builder>- Throws:
IOException
-
getQuery
public String getQuery()
The query to execute against the Event Stream
string query = 1;- Specified by:
getQueryin interfaceQueryEventsRequestOrBuilder- Returns:
- The query.
-
getQueryBytes
public com.google.protobuf.ByteString getQueryBytes()
The query to execute against the Event Stream
string query = 1;- Specified by:
getQueryBytesin interfaceQueryEventsRequestOrBuilder- Returns:
- The bytes for query.
-
setQuery
public QueryEventsRequest.Builder setQuery(String value)
The query to execute against the Event Stream
string query = 1;- Parameters:
value- The query to set.- Returns:
- This builder for chaining.
-
clearQuery
public QueryEventsRequest.Builder clearQuery()
The query to execute against the Event Stream
string query = 1;- Returns:
- This builder for chaining.
-
setQueryBytes
public QueryEventsRequest.Builder setQueryBytes(com.google.protobuf.ByteString value)
The query to execute against the Event Stream
string query = 1;- Parameters:
value- The bytes for query to set.- Returns:
- This builder for chaining.
-
getNumberOfPermits
public long getNumberOfPermits()
The number of results AxonServer may send before new permits need to be provided
int64 number_of_permits = 2;- Specified by:
getNumberOfPermitsin interfaceQueryEventsRequestOrBuilder- Returns:
- The numberOfPermits.
-
setNumberOfPermits
public QueryEventsRequest.Builder setNumberOfPermits(long value)
The number of results AxonServer may send before new permits need to be provided
int64 number_of_permits = 2;- Parameters:
value- The numberOfPermits to set.- Returns:
- This builder for chaining.
-
clearNumberOfPermits
public QueryEventsRequest.Builder clearNumberOfPermits()
The number of results AxonServer may send before new permits need to be provided
int64 number_of_permits = 2;- Returns:
- This builder for chaining.
-
getLiveEvents
public boolean getLiveEvents()
Whether to keep the query running against incoming events once the Head of the Stream is reached
bool live_events = 3;- Specified by:
getLiveEventsin interfaceQueryEventsRequestOrBuilder- Returns:
- The liveEvents.
-
setLiveEvents
public QueryEventsRequest.Builder setLiveEvents(boolean value)
Whether to keep the query running against incoming events once the Head of the Stream is reached
bool live_events = 3;- Parameters:
value- The liveEvents to set.- Returns:
- This builder for chaining.
-
clearLiveEvents
public QueryEventsRequest.Builder clearLiveEvents()
Whether to keep the query running against incoming events once the Head of the Stream is reached
bool live_events = 3;- Returns:
- This builder for chaining.
-
getForceReadFromLeader
public boolean getForceReadFromLeader()
Indicates whether to force querying events from the leader node of an Axon Server. Forcing reads from leader reduces the staleness of the data read, but also puts extra burden on the leader, reducing overall scalability. <p> This property has no effect on connections to AxonServer SE. </p>
bool force_read_from_leader = 4;- Specified by:
getForceReadFromLeaderin interfaceQueryEventsRequestOrBuilder- Returns:
- The forceReadFromLeader.
-
setForceReadFromLeader
public QueryEventsRequest.Builder setForceReadFromLeader(boolean value)
Indicates whether to force querying events from the leader node of an Axon Server. Forcing reads from leader reduces the staleness of the data read, but also puts extra burden on the leader, reducing overall scalability. <p> This property has no effect on connections to AxonServer SE. </p>
bool force_read_from_leader = 4;- Parameters:
value- The forceReadFromLeader to set.- Returns:
- This builder for chaining.
-
clearForceReadFromLeader
public QueryEventsRequest.Builder clearForceReadFromLeader()
Indicates whether to force querying events from the leader node of an Axon Server. Forcing reads from leader reduces the staleness of the data read, but also puts extra burden on the leader, reducing overall scalability. <p> This property has no effect on connections to AxonServer SE. </p>
bool force_read_from_leader = 4;- Returns:
- This builder for chaining.
-
getQuerySnapshots
public boolean getQuerySnapshots()
If true, snapshots will be queried instead of events
bool query_snapshots = 5;- Specified by:
getQuerySnapshotsin interfaceQueryEventsRequestOrBuilder- Returns:
- The querySnapshots.
-
setQuerySnapshots
public QueryEventsRequest.Builder setQuerySnapshots(boolean value)
If true, snapshots will be queried instead of events
bool query_snapshots = 5;- Parameters:
value- The querySnapshots to set.- Returns:
- This builder for chaining.
-
clearQuerySnapshots
public QueryEventsRequest.Builder clearQuerySnapshots()
If true, snapshots will be queried instead of events
bool query_snapshots = 5;- Returns:
- This builder for chaining.
-
getContextName
public String getContextName()
Query from this context, not from the default context of the connection
string context_name = 6;- Specified by:
getContextNamein interfaceQueryEventsRequestOrBuilder- Returns:
- The contextName.
-
getContextNameBytes
public com.google.protobuf.ByteString getContextNameBytes()
Query from this context, not from the default context of the connection
string context_name = 6;- Specified by:
getContextNameBytesin interfaceQueryEventsRequestOrBuilder- Returns:
- The bytes for contextName.
-
setContextName
public QueryEventsRequest.Builder setContextName(String value)
Query from this context, not from the default context of the connection
string context_name = 6;- Parameters:
value- The contextName to set.- Returns:
- This builder for chaining.
-
clearContextName
public QueryEventsRequest.Builder clearContextName()
Query from this context, not from the default context of the connection
string context_name = 6;- Returns:
- This builder for chaining.
-
setContextNameBytes
public QueryEventsRequest.Builder setContextNameBytes(com.google.protobuf.ByteString value)
Query from this context, not from the default context of the connection
string context_name = 6;- Parameters:
value- The bytes for contextName to set.- Returns:
- This builder for chaining.
-
-