com.ibm.etcd.api.WatchResponseOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of etcd-java Show documentation
etcd3 java client and utilities
There is a newer version: 0.0.24
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: rpc.proto

package com.ibm.etcd.api;

public interface WatchResponseOrBuilder extends
    // @@protoc_insertion_point(interface_extends:etcdserverpb.WatchResponse)
    com.google.protobuf.MessageOrBuilder {

  /**
   * .etcdserverpb.ResponseHeader header = 1;
   * @return Whether the header field is set.
   */
  boolean hasHeader();
  /**
   * .etcdserverpb.ResponseHeader header = 1;
   * @return The header.
   */
  com.ibm.etcd.api.ResponseHeader getHeader();
  /**
   * .etcdserverpb.ResponseHeader header = 1;
   */
  com.ibm.etcd.api.ResponseHeaderOrBuilder getHeaderOrBuilder();

  /**
   *    * watch_id is the ID of the watcher that corresponds to the response.
   * 
   *
   * int64 watch_id = 2;
   * @return The watchId.
   */
  long getWatchId();

  /**
   *    * created is set to true if the response is for a create watch request.
   * The client should record the watch_id and expect to receive events for
   * the created watcher from the same stream.
   * All events sent to the created watcher will attach with the same watch_id.
   * 
   *
   * bool created = 3;
   * @return The created.
   */
  boolean getCreated();

  /**
   *    * canceled is set to true if the response is for a cancel watch request.
   * No further events will be sent to the canceled watcher.
   * 
   *
   * bool canceled = 4;
   * @return The canceled.
   */
  boolean getCanceled();

  /**
   *    * compact_revision is set to the minimum index if a watcher tries to watch
   * at a compacted index.
   * This happens when creating a watcher at a compacted revision or the watcher cannot
   * catch up with the progress of the key-value store.
   * The client should treat the watcher as canceled and should not try to create any
   * watcher with the same start_revision again.
   * 
   *
   * int64 compact_revision = 5;
   * @return The compactRevision.
   */
  long getCompactRevision();

  /**
   *    * cancel_reason indicates the reason for canceling the watcher.
   * 
   *
   * string cancel_reason = 6;
   * @return The cancelReason.
   */
  java.lang.String getCancelReason();
  /**
   *    * cancel_reason indicates the reason for canceling the watcher.
   * 
   *
   * string cancel_reason = 6;
   * @return The bytes for cancelReason.
   */
  com.google.protobuf.ByteString
      getCancelReasonBytes();

  /**
   *    * framgment is true if large watch response was split over multiple responses.
   * 
   *
   * bool fragment = 7;
   * @return The fragment.
   */
  boolean getFragment();

  /**
   * repeated .mvccpb.Event events = 11;
   */
  java.util.List 
      getEventsList();
  /**
   * repeated .mvccpb.Event events = 11;
   */
  com.ibm.etcd.api.Event getEvents(int index);
  /**
   * repeated .mvccpb.Event events = 11;
   */
  int getEventsCount();
  /**
   * repeated .mvccpb.Event events = 11;
   */
  java.util.List 
      getEventsOrBuilderList();
  /**
   * repeated .mvccpb.Event events = 11;
   */
  com.ibm.etcd.api.EventOrBuilder getEventsOrBuilder(
      int index);
}