// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: rpc.proto
package io.etcd.jetcd.api;
public interface RangeRequestOrBuilder extends
// @@protoc_insertion_point(interface_extends:etcdserverpb.RangeRequest)
com.google.protobuf.MessageOrBuilder {
/**
*
* key is the first key for the range. If range_end is not given, the request only looks up key.
*
*
* bytes key = 1;
* @return The key.
*/
com.google.protobuf.ByteString getKey();
/**
*
* range_end is the upper bound on the requested range [key, range_end).
* If range_end is '\0', the range is all keys >= key.
* If range_end is key plus one (e.g., "aa"+1 == "ab", "a\xff"+1 == "b"),
* then the range request gets all keys prefixed with key.
* If both key and range_end are '\0', then the range request returns all keys.
*
*
* bytes range_end = 2;
* @return The rangeEnd.
*/
com.google.protobuf.ByteString getRangeEnd();
/**
*
* limit is a limit on the number of keys returned for the request. When limit is set to 0,
* it is treated as no limit.
*
*
* int64 limit = 3;
* @return The limit.
*/
long getLimit();
/**
*
* revision is the point-in-time of the key-value store to use for the range.
* If revision is less or equal to zero, the range is over the newest key-value store.
* If the revision has been compacted, ErrCompacted is returned as a response.
*
*
* int64 revision = 4;
* @return The revision.
*/
long getRevision();
/**
*
* sort_order is the order for returned sorted results.
*
*
* .etcdserverpb.RangeRequest.SortOrder sort_order = 5;
* @return The enum numeric value on the wire for sortOrder.
*/
int getSortOrderValue();
/**
*
* sort_order is the order for returned sorted results.
*
*
* .etcdserverpb.RangeRequest.SortOrder sort_order = 5;
* @return The sortOrder.
*/
io.etcd.jetcd.api.RangeRequest.SortOrder getSortOrder();
/**
*
* sort_target is the key-value field to use for sorting.
*
*
* .etcdserverpb.RangeRequest.SortTarget sort_target = 6;
* @return The enum numeric value on the wire for sortTarget.
*/
int getSortTargetValue();
/**
*
* sort_target is the key-value field to use for sorting.
*
*
* .etcdserverpb.RangeRequest.SortTarget sort_target = 6;
* @return The sortTarget.
*/
io.etcd.jetcd.api.RangeRequest.SortTarget getSortTarget();
/**
*
* serializable sets the range request to use serializable member-local reads.
* Range requests are linearizable by default; linearizable requests have higher
* latency and lower throughput than serializable requests but reflect the current
* consensus of the cluster. For better performance, in exchange for possible stale reads,
* a serializable range request is served locally without needing to reach consensus
* with other nodes in the cluster.
*
*
* bool serializable = 7;
* @return The serializable.
*/
boolean getSerializable();
/**
*
* keys_only when set returns only the keys and not the values.
*
*
* bool keys_only = 8;
* @return The keysOnly.
*/
boolean getKeysOnly();
/**
*
* count_only when set returns only the count of the keys in the range.
*
*
* bool count_only = 9;
* @return The countOnly.
*/
boolean getCountOnly();
/**
*
* min_mod_revision is the lower bound for returned key mod revisions; all keys with
* lesser mod revisions will be filtered away.
*
*
* int64 min_mod_revision = 10;
* @return The minModRevision.
*/
long getMinModRevision();
/**
*
* max_mod_revision is the upper bound for returned key mod revisions; all keys with
* greater mod revisions will be filtered away.
*
*
* int64 max_mod_revision = 11;
* @return The maxModRevision.
*/
long getMaxModRevision();
/**
*
* min_create_revision is the lower bound for returned key create revisions; all keys with
* lesser create trevisions will be filtered away.
*
*
* int64 min_create_revision = 12;
* @return The minCreateRevision.
*/
long getMinCreateRevision();
/**
*
* max_create_revision is the upper bound for returned key create revisions; all keys with
* greater create revisions will be filtered away.
*
*
* int64 max_create_revision = 13;
* @return The maxCreateRevision.
*/
long getMaxCreateRevision();
}
