io.axoniq.axonserver.grpc.event.QueryEventsRequestOrBuilder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of axonserver-connector-java Show documentation

Connector module providing infrastructure components that connect to AxonServer.

There is a newer version: 2024.1.1

Show newest version

// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: event.proto

package io.axoniq.axonserver.grpc.event;

public interface QueryEventsRequestOrBuilder extends
    // @@protoc_insertion_point(interface_extends:io.axoniq.axonserver.grpc.event.QueryEventsRequest)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * The query to execute against the Event Stream 
   * 
   *
   * string query = 1;
   */
  java.lang.String getQuery();
  /**
   *    * The query to execute against the Event Stream 
   * 
   *
   * string query = 1;
   */
  com.google.protobuf.ByteString
      getQueryBytes();

  /**
   *    * The number of results AxonServer may send before new permits need to be provided 
   * 
   *
   * int64 number_of_permits = 2;
   */
  long getNumberOfPermits();

  /**
   *    * Whether to keep the query running against incoming events once the Head of the Stream is reached 
   * 
   *
   * bool live_events = 3;
   */
  boolean getLiveEvents();

  /**
   *    * 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;
   */
  boolean getForceReadFromLeader();

  /**
   *    * If true, snapshots will be queried instead of events 
   * 
   *
   * bool query_snapshots = 5;
   */
  boolean getQuerySnapshots();
}