com.ibm.etcd.api.WatchCreateRequestOrBuilder 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
Show all versions of etcd-java Show documentation
etcd3 java client and utilities
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: rpc.proto
package com.ibm.etcd.api;
public interface WatchCreateRequestOrBuilder extends
// @@protoc_insertion_point(interface_extends:etcdserverpb.WatchCreateRequest)
com.google.protobuf.MessageOrBuilder {
/**
*
* key is the key to register for watching.
*
*
* bytes key = 1;
* @return The key.
*/
com.google.protobuf.ByteString getKey();
/**
*
* range_end is the end of the range [key, range_end) to watch. If range_end is not given,
* only the key argument is watched. If range_end is equal to '\0', all keys greater than
* or equal to the key argument are watched.
* If the range_end is one bit larger than the given key,
* then all keys with the prefix (the given key) will be watched.
*
*
* bytes range_end = 2;
* @return The rangeEnd.
*/
com.google.protobuf.ByteString getRangeEnd();
/**
*
* start_revision is an optional revision to watch from (inclusive). No start_revision is "now".
*
*
* int64 start_revision = 3;
* @return The startRevision.
*/
long getStartRevision();
/**
*
* progress_notify is set so that the etcd server will periodically send a WatchResponse with
* no events to the new watcher if there are no recent events. It is useful when clients
* wish to recover a disconnected watcher starting from a recent known revision.
* The etcd server may decide how often it will send notifications based on current load.
*
*
* bool progress_notify = 4;
* @return The progressNotify.
*/
boolean getProgressNotify();
/**
*
* filters filter the events at server side before it sends back to the watcher.
*
*
* repeated .etcdserverpb.WatchCreateRequest.FilterType filters = 5;
* @return A list containing the filters.
*/
java.util.List getFiltersList();
/**
*
* filters filter the events at server side before it sends back to the watcher.
*
*
* repeated .etcdserverpb.WatchCreateRequest.FilterType filters = 5;
* @return The count of filters.
*/
int getFiltersCount();
/**
*
* filters filter the events at server side before it sends back to the watcher.
*
*
* repeated .etcdserverpb.WatchCreateRequest.FilterType filters = 5;
* @param index The index of the element to return.
* @return The filters at the given index.
*/
com.ibm.etcd.api.WatchCreateRequest.FilterType getFilters(int index);
/**
*
* filters filter the events at server side before it sends back to the watcher.
*
*
* repeated .etcdserverpb.WatchCreateRequest.FilterType filters = 5;
* @return A list containing the enum numeric values on the wire for filters.
*/
java.util.List
getFiltersValueList();
/**
*
* filters filter the events at server side before it sends back to the watcher.
*
*
* repeated .etcdserverpb.WatchCreateRequest.FilterType filters = 5;
* @param index The index of the value to return.
* @return The enum numeric value on the wire of filters at the given index.
*/
int getFiltersValue(int index);
/**
*
* If prev_kv is set, created watcher gets the previous KV before the event happens.
* If the previous KV is already compacted, nothing will be returned.
*
*
* bool prev_kv = 6;
* @return The prevKv.
*/
boolean getPrevKv();
/**
*
* If watch_id is provided and non-zero, it will be assigned to this watcher.
* Since creating a watcher in etcd is not a synchronous operation,
* this can be used ensure that ordering is correct when creating multiple
* watchers on the same stream. Creating a watcher with an ID already in
* use on the stream will cause an error to be returned.
*
*
* int64 watch_id = 7;
* @return The watchId.
*/
long getWatchId();
}