Class/Object

org.etcd4s.pb.etcdserverpb

RangeRequest

Related Docs: object RangeRequest | package etcdserverpb

Permalink

final case class RangeRequest(key: ByteString = ..., rangeEnd: ByteString = ..., limit: Long = 0L, revision: Long = 0L, sortOrder: SortOrder = ..., sortTarget: SortTarget = ..., serializable: Boolean = false, keysOnly: Boolean = false, countOnly: Boolean = false, minModRevision: Long = 0L, maxModRevision: Long = 0L, minCreateRevision: Long = 0L, maxCreateRevision: Long = 0L) extends GeneratedMessage with Message[RangeRequest] with Updatable[RangeRequest] with Product with Serializable

key

key is the first key for the range. If range_end is not given, the request only looks up key.

rangeEnd

range_end is the upper bound on the requested range [key, range_end). If range_end is '&92;0', the range is all keys >= key. If range_end is key plus one (e.g., "aa"+1 == "ab", "a&92;xff"+1 == "b"), then the range request gets all keys prefixed with key. If both key and range_end are '&92;0', then the range request returns all keys.

limit

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.

revision

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.

sortOrder

sort_order is the order for returned sorted results.

sortTarget

sort_target is the key-value field to use for sorting.

serializable

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.

keysOnly

keys_only when set returns only the keys and not the values.

countOnly

count_only when set returns only the count of the keys in the range.

minModRevision

min_mod_revision is the lower bound for returned key mod revisions; all keys with lesser mod revisions will be filtered away.

maxModRevision

max_mod_revision is the upper bound for returned key mod revisions; all keys with greater mod revisions will be filtered away.

minCreateRevision

min_create_revision is the lower bound for returned key create revisions; all keys with lesser create trevisions will be filtered away.

maxCreateRevision

max_create_revision is the upper bound for returned key create revisions; all keys with greater create revisions will be filtered away.

Annotations
@SerialVersionUID()
Linear Supertypes
Product, Equals, Updatable[RangeRequest], Message[RangeRequest], GeneratedMessage, Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RangeRequest
  2. Product
  3. Equals
  4. Updatable
  5. Message
  6. GeneratedMessage
  7. Serializable
  8. Serializable
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new RangeRequest(key: ByteString = ..., rangeEnd: ByteString = ..., limit: Long = 0L, revision: Long = 0L, sortOrder: SortOrder = ..., sortTarget: SortTarget = ..., serializable: Boolean = false, keysOnly: Boolean = false, countOnly: Boolean = false, minModRevision: Long = 0L, maxModRevision: Long = 0L, minCreateRevision: Long = 0L, maxCreateRevision: Long = 0L)

    Permalink

    key

    key is the first key for the range. If range_end is not given, the request only looks up key.

    rangeEnd

    range_end is the upper bound on the requested range [key, range_end). If range_end is '&92;0', the range is all keys >= key. If range_end is key plus one (e.g., "aa"+1 == "ab", "a&92;xff"+1 == "b"), then the range request gets all keys prefixed with key. If both key and range_end are '&92;0', then the range request returns all keys.

    limit

    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.

    revision

    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.

    sortOrder

    sort_order is the order for returned sorted results.

    sortTarget

    sort_target is the key-value field to use for sorting.

    serializable

    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.

    keysOnly

    keys_only when set returns only the keys and not the values.

    countOnly

    count_only when set returns only the count of the keys in the range.

    minModRevision

    min_mod_revision is the lower bound for returned key mod revisions; all keys with lesser mod revisions will be filtered away.

    maxModRevision

    max_mod_revision is the upper bound for returned key mod revisions; all keys with greater mod revisions will be filtered away.

    minCreateRevision

    min_create_revision is the lower bound for returned key create revisions; all keys with lesser create trevisions will be filtered away.

    maxCreateRevision

    max_create_revision is the upper bound for returned key create revisions; all keys with greater create revisions will be filtered away.

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. def companion: RangeRequest.type

    Permalink
    Definition Classes
    RangeRequest → GeneratedMessage
  7. val countOnly: Boolean

    Permalink

    count_only when set returns only the count of the keys in the range.

  8. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  9. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  11. def getField(__field: FieldDescriptor): PValue

    Permalink
    Definition Classes
    RangeRequest → GeneratedMessage
  12. def getFieldByNumber(__fieldNumber: Int): Any

    Permalink
    Definition Classes
    RangeRequest → GeneratedMessage
  13. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  14. val key: ByteString

    Permalink

    key is the first key for the range.

    key is the first key for the range. If range_end is not given, the request only looks up key.

  15. val keysOnly: Boolean

    Permalink

    keys_only when set returns only the keys and not the values.

  16. val limit: Long

    Permalink

    limit is a limit on the number of keys returned for the request.

    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.

  17. val maxCreateRevision: Long

    Permalink

    max_create_revision is the upper bound for returned key create revisions; all keys with greater create revisions will be filtered away.

  18. val maxModRevision: Long

    Permalink

    max_mod_revision is the upper bound for returned key mod revisions; all keys with greater mod revisions will be filtered away.

  19. def mergeFrom(_input__: CodedInputStream): RangeRequest

    Permalink
    Definition Classes
    RangeRequest → Message
  20. val minCreateRevision: Long

    Permalink

    min_create_revision is the lower bound for returned key create revisions; all keys with lesser create trevisions will be filtered away.

  21. val minModRevision: Long

    Permalink

    min_mod_revision is the lower bound for returned key mod revisions; all keys with lesser mod revisions will be filtered away.

  22. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  23. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  24. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  25. val rangeEnd: ByteString

    Permalink

    range_end is the upper bound on the requested range [key, range_end).

    range_end is the upper bound on the requested range [key, range_end). If range_end is '&92;0', the range is all keys >= key. If range_end is key plus one (e.g., "aa"+1 == "ab", "a&92;xff"+1 == "b"), then the range request gets all keys prefixed with key. If both key and range_end are '&92;0', then the range request returns all keys.

  26. val revision: Long

    Permalink

    revision is the point-in-time of the key-value store to use for the range.

    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.

  27. val serializable: Boolean

    Permalink

    serializable sets the range request to use serializable member-local reads.

    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.

  28. final def serializedSize: Int

    Permalink
    Definition Classes
    RangeRequest → GeneratedMessage
  29. val sortOrder: SortOrder

    Permalink

    sort_order is the order for returned sorted results.

  30. val sortTarget: SortTarget

    Permalink

    sort_target is the key-value field to use for sorting.

  31. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  32. def toByteArray: Array[Byte]

    Permalink
    Definition Classes
    GeneratedMessage
  33. def toByteString: ByteString

    Permalink
    Definition Classes
    GeneratedMessage
  34. def toPMessage: PMessage

    Permalink
    Definition Classes
    GeneratedMessage
  35. def toString(): String

    Permalink
    Definition Classes
    RangeRequest → AnyRef → Any
  36. def update(ms: (Lens[RangeRequest, RangeRequest]) ⇒ Mutation[RangeRequest]*): RangeRequest

    Permalink
    Definition Classes
    Updatable
  37. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  38. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  39. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  40. def withCountOnly(__v: Boolean): RangeRequest

    Permalink
  41. def withKey(__v: ByteString): RangeRequest

    Permalink
  42. def withKeysOnly(__v: Boolean): RangeRequest

    Permalink
  43. def withLimit(__v: Long): RangeRequest

    Permalink
  44. def withMaxCreateRevision(__v: Long): RangeRequest

    Permalink
  45. def withMaxModRevision(__v: Long): RangeRequest

    Permalink
  46. def withMinCreateRevision(__v: Long): RangeRequest

    Permalink
  47. def withMinModRevision(__v: Long): RangeRequest

    Permalink
  48. def withRangeEnd(__v: ByteString): RangeRequest

    Permalink
  49. def withRevision(__v: Long): RangeRequest

    Permalink
  50. def withSerializable(__v: Boolean): RangeRequest

    Permalink
  51. def withSortOrder(__v: SortOrder): RangeRequest

    Permalink
  52. def withSortTarget(__v: SortTarget): RangeRequest

    Permalink
  53. def writeDelimitedTo(output: OutputStream): Unit

    Permalink
    Definition Classes
    GeneratedMessage
  54. def writeTo(_output__: CodedOutputStream): Unit

    Permalink
    Definition Classes
    RangeRequest → GeneratedMessage
  55. def writeTo(output: OutputStream): Unit

    Permalink
    Definition Classes
    GeneratedMessage

Deprecated Value Members

  1. def getAllFields: Map[FieldDescriptor, Any]

    Permalink
    Definition Classes
    GeneratedMessage
    Annotations
    @deprecated
    Deprecated

    (Since version 0.6.0) Use toPMessage

  2. def getField(field: FieldDescriptor): Any

    Permalink
    Definition Classes
    GeneratedMessage
    Annotations
    @deprecated
    Deprecated

    (Since version 0.6.0) Use getField that accepts a ScalaPB descriptor and returns PValue

Inherited from Product

Inherited from Equals

Inherited from Updatable[RangeRequest]

Inherited from Message[RangeRequest]

Inherited from GeneratedMessage

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped