package etcdserverpb

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc Put (PutRequest, PutResponse)

  etcd_service.proto:13

  Put puts the given key into the key-value store. A put request increments the revision of the key-value store and generates one event in the event history.

  message PutRequest

  etcd.proto:115

  • bytes key = 1

    key is the key, in bytes, to put into the key-value store.

  • bytes value = 2

    value is the value, in bytes, to associate with the key in the key-value store.

  • int64 lease = 3

    lease is the lease ID to associate with the key in the key-value store. A lease value of 0 indicates no lease.

  • bool prev_kv = 4

    If prev_kv is set, etcd gets the previous key-value pair before changing it. The previous key-value pair will be returned in the put response.

  • bool ignore_value = 5

    If ignore_value is set, etcd updates the key using its current value. Returns an error if the key does not exist.

  • bool ignore_lease = 6

    If ignore_lease is set, etcd updates the key using its current lease. Returns an error if the key does not exist.

  message PutResponse

  etcd.proto:137

  • optional ResponseHeader header = 1

  • optional KeyValue prev_kv = 2

    if prev_kv is set in the request, the previous key-value pair will be returned.

• rpc Range (RangeRequest, RangeResponse)

  etcd_service.proto:8

  Range gets the keys in the range from the key-value store.

  message RangeRequest

  etcd.proto:37

  • bytes key = 1

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

  • bytes range_end = 2

    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.

  • int64 limit = 3

    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 revision = 4

    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.

  • RangeRequest.SortOrder sort_order = 5

    sort_order is the order for returned sorted results.

  • RangeRequest.SortTarget sort_target = 6

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

  • bool serializable = 7

    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 keys_only = 8

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

  • bool count_only = 9

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

  • int64 min_mod_revision = 10

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

  • int64 max_mod_revision = 11

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

  • int64 min_create_revision = 12

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

  • int64 max_create_revision = 13

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

  message RangeResponse

  etcd.proto:104

  • optional ResponseHeader header = 1

  • repeated KeyValue kvs = 2

    kvs is the list of key-value pairs matched by the range request. kvs is empty when count is requested.

  • bool more = 3

    more indicates if there are more keys to return in the requested range.

  • int64 count = 4

    count is set to the number of keys within the range when requested.

Used in: PutResponse, RangeResponse

• bytes key = 1

  key is the key in bytes. An empty key is not allowed.

• int64 create_revision = 2

  create_revision is the revision of last creation on this key.

• int64 mod_revision = 3

  mod_revision is the revision of last modification on this key.

• int64 version = 4

  version is the version of the key. A deletion resets the version to zero and any modification of the key increases its version.

• bytes value = 5

  value is the value held by the key, in bytes.

• int64 lease = 6

  lease is the ID of the lease that attached to key. When the attached lease expires, the key will be deleted. If lease is 0, then no lease is attached to the key.

Used in: RangeRequest

• NONE = 0

  default, no sorting

• ASCEND = 1

  lowest target value first

• DESCEND = 2

  highest target value first

Used in: RangeRequest

• KEY = 0

• VERSION = 1

• CREATE = 2

• MOD = 3

• VALUE = 4

Used in: PutResponse, RangeResponse

• uint64 cluster_id = 1

  cluster_id is the ID of the cluster which sent the response.

• uint64 member_id = 2

  member_id is the ID of the member which sent the response.

• int64 revision = 3

  revision is the key-value store revision when the request was applied. For watch progress responses, the header.revision indicates progress. All future events recieved in this stream are guaranteed to have a higher revision number than the header.revision number.

• uint64 raft_term = 4

  raft_term is the raft term when the request was applied.