io.axoniq.axonserver.grpc.event.GetEventsRequestOrBuilder 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 GetEventsRequestOrBuilder extends
    // @@protoc_insertion_point(interface_extends:io.axoniq.axonserver.grpc.event.GetEventsRequest)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * The token to start streaming from 
   * 
   *
   * int64 tracking_token = 1;
   */
  long getTrackingToken();

  /**
   *    * The number of messages the server may send before it needs to wait for more permits 
   * 
   *
   * int64 number_of_permits = 2;
   */
  long getNumberOfPermits();

  /**
   *    * The unique identifier of this client instance. Used for monitoring. 
   * 
   *
   * string client_id = 3;
   */
  java.lang.String getClientId();
  /**
   *    * The unique identifier of this client instance. Used for monitoring. 
   * 
   *
   * string client_id = 3;
   */
  com.google.protobuf.ByteString
      getClientIdBytes();

  /**
   *    * The component name of this client instance. Used for monitoring. 
   * 
   *
   * string component_name = 4;
   */
  java.lang.String getComponentName();
  /**
   *    * The component name of this client instance. Used for monitoring. 
   * 
   *
   * string component_name = 4;
   */
  com.google.protobuf.ByteString
      getComponentNameBytes();

  /**
   *    * The name of the processor requesting this stream. Used for monitoring. 
   * 
   *
   * string processor = 5;
   */
  java.lang.String getProcessor();
  /**
   *    * The name of the processor requesting this stream. Used for monitoring. 
   * 
   *
   * string processor = 5;
   */
  com.google.protobuf.ByteString
      getProcessorBytes();

  /**
   *    * 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;
   */
  java.util.List 
      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;
   */
  io.axoniq.axonserver.grpc.event.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;
   */
  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;
   */
  java.util.List 
      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;
   */
  io.axoniq.axonserver.grpc.event.PayloadDescriptionOrBuilder getBlacklistOrBuilder(
      int index);

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