io.axoniq.axonserver.grpc.event

Interface GetEventsRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

GetEventsRequest, GetEventsRequest.Builder

public interface GetEventsRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
PayloadDescription	getBlacklist(int index) An enumeration of payload types that need to be blacklisted.
int	getBlacklistCount() An enumeration of payload types that need to be blacklisted.
List<PayloadDescription>	getBlacklistList() An enumeration of payload types that need to be blacklisted.
PayloadDescriptionOrBuilder	getBlacklistOrBuilder(int index) An enumeration of payload types that need to be blacklisted.
List<? extends PayloadDescriptionOrBuilder>	getBlacklistOrBuilderList() An enumeration of payload types that need to be blacklisted.
String	getClientId() The unique identifier of this client instance.
com.google.protobuf.ByteString	getClientIdBytes() The unique identifier of this client instance.
String	getComponentName() The component name of this client instance.
com.google.protobuf.ByteString	getComponentNameBytes() The component name of this client instance.
boolean	getForceReadFromLeader() Indicates whether to force reading events from the leader node of an Axon Server.
long	getNumberOfPermits() The number of messages the server may send before it needs to wait for more permits
String	getProcessor() The name of the processor requesting this stream.
com.google.protobuf.ByteString	getProcessorBytes() The name of the processor requesting this stream.
long	getTrackingToken() The token to start streaming from

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getTrackingToken

long getTrackingToken()

 The token to start streaming from 
 

int64 tracking_token = 1;

getNumberOfPermits

long getNumberOfPermits()

 The number of messages the server may send before it needs to wait for more permits 
 

int64 number_of_permits = 2;

getClientId

String getClientId()

 The unique identifier of this client instance. Used for monitoring. 
 

string client_id = 3;

getClientIdBytes

com.google.protobuf.ByteString getClientIdBytes()

 The unique identifier of this client instance. Used for monitoring. 
 

string client_id = 3;

getComponentName

String getComponentName()

 The component name of this client instance. Used for monitoring. 
 

string component_name = 4;

getComponentNameBytes

com.google.protobuf.ByteString getComponentNameBytes()

 The component name of this client instance. Used for monitoring. 
 

string component_name = 4;

getProcessor

String getProcessor()

 The name of the processor requesting this stream. Used for monitoring. 
 

string processor = 5;

getProcessorBytes

com.google.protobuf.ByteString getProcessorBytes()

 The name of the processor requesting this stream. Used for monitoring. 
 

string processor = 5;

getBlacklistList

List<PayloadDescription> getBlacklistList()

 An enumeration of payload types that need to be blacklisted. The Server will stop sending messages of these
types in order to reduce I/O. Note that the Server may occasionally send a blacklisted message to prevent
time-outs and stale tokens on clients.
 

repeated .io.axoniq.axonserver.grpc.event.PayloadDescription blacklist = 6;

getBlacklist

PayloadDescription getBlacklist(int index)

 An enumeration of payload types that need to be blacklisted. The Server will stop sending messages of these
types in order to reduce I/O. Note that the Server may occasionally send a blacklisted message to prevent
time-outs and stale tokens on clients.
 

repeated .io.axoniq.axonserver.grpc.event.PayloadDescription blacklist = 6;

getBlacklistCount

int getBlacklistCount()

 An enumeration of payload types that need to be blacklisted. The Server will stop sending messages of these
types in order to reduce I/O. Note that the Server may occasionally send a blacklisted message to prevent
time-outs and stale tokens on clients.
 

repeated .io.axoniq.axonserver.grpc.event.PayloadDescription blacklist = 6;

getBlacklistOrBuilderList

List<? extends PayloadDescriptionOrBuilder> getBlacklistOrBuilderList()

 An enumeration of payload types that need to be blacklisted. The Server will stop sending messages of these
types in order to reduce I/O. Note that the Server may occasionally send a blacklisted message to prevent
time-outs and stale tokens on clients.
 

repeated .io.axoniq.axonserver.grpc.event.PayloadDescription blacklist = 6;

getBlacklistOrBuilder

PayloadDescriptionOrBuilder getBlacklistOrBuilder(int index)

 An enumeration of payload types that need to be blacklisted. The Server will stop sending messages of these
types in order to reduce I/O. Note that the Server may occasionally send a blacklisted message to prevent
time-outs and stale tokens on clients.
 

repeated .io.axoniq.axonserver.grpc.event.PayloadDescription blacklist = 6;

getForceReadFromLeader

boolean getForceReadFromLeader()

 Indicates whether to force reading 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 = 7;