API reference: concurrency
service Lock
(server/etcdserver/api/v3lock/v3lockpb/v3lock.proto)
message LockRequest
(server/etcdserver/api/v3lock/v3lockpb/v3lock.proto)
Field | Description | Type |
---|---|---|
name | name is the identifier for the distributed shared lock to be acquired. | bytes |
lease | lease is the ID of the lease that will be attached to ownership of the lock. If the lease expires or is revoked and currently holds the lock, the lock is automatically released. Calls to Lock with the same lease will be treated as a single acquisition; locking twice with the same lease is a no-op. | int64 |
message LockResponse
(server/etcdserver/api/v3lock/v3lockpb/v3lock.proto)
Field | Description | Type |
---|---|---|
header | etcdserverpb.ResponseHeader | |
key | key is a key that will exist on etcd for the duration that the Lock caller owns the lock. Users should not modify this key or the lock may exhibit undefined behavior. | bytes |
message UnlockRequest
(server/etcdserver/api/v3lock/v3lockpb/v3lock.proto)
Field | Description | Type |
---|---|---|
key | key is the lock ownership key granted by Lock. | bytes |
message (server/etcdserver/api/v3lock/v3lockpb/v3lock.proto)
Field | Description | Type |
---|---|---|
header | etcdserverpb.ResponseHeader |
service Election
(server/etcdserver/api/v3election/v3electionpb/v3election.proto)
message CampaignRequest
(server/etcdserver/api/v3election/v3electionpb/v3election.proto)
Field | Description | Type |
---|---|---|
name | name is the election’s identifier for the campaign. | bytes |
lease | lease is the ID of the lease attached to leadership of the election. If the lease expires or is revoked before resigning leadership, then the leadership is transferred to the next campaigner, if any. | int64 |
value | value is the initial proclaimed value set when the campaigner wins the election. | bytes |
message CampaignResponse
(server/etcdserver/api/v3election/v3electionpb/v3election.proto)
Field | Description | Type |
---|---|---|
header | etcdserverpb.ResponseHeader | |
leader | leader describes the resources used for holding leadereship of the election. | LeaderKey |
message LeaderKey
(server/etcdserver/api/v3election/v3electionpb/v3election.proto)
Field | Description | Type |
---|---|---|
name | name is the election identifier that correponds to the leadership key. | bytes |
key | key is an opaque key representing the ownership of the election. If the key is deleted, then leadership is lost. | bytes |
rev | rev is the creation revision of the key. It can be used to test for ownership of an election during transactions by testing the key’s creation revision matches rev. | int64 |
lease | lease is the lease ID of the election leader. | int64 |
message LeaderRequest
(server/etcdserver/api/v3election/v3electionpb/v3election.proto)
Field | Description | Type |
---|---|---|
name | name is the election identifier for the leadership information. | bytes |
message LeaderResponse
(server/etcdserver/api/v3election/v3electionpb/v3election.proto)
message ProclaimRequest
(server/etcdserver/api/v3election/v3electionpb/v3election.proto)
Field | Description | Type |
---|---|---|
leader | leader is the leadership hold on the election. | LeaderKey |
value | value is an update meant to overwrite the leader’s current value. | bytes |
message ProclaimResponse
(server/etcdserver/api/v3election/v3electionpb/v3election.proto)
Field | Description | Type |
---|---|---|
header | etcdserverpb.ResponseHeader |
message ResignRequest
(server/etcdserver/api/v3election/v3electionpb/v3election.proto)
Field | Description | Type |
---|---|---|
leader | leader is the leadership to relinquish by resignation. | LeaderKey |
message ResignResponse
(server/etcdserver/api/v3election/v3electionpb/v3election.proto)
Field | Description | Type |
---|---|---|
header | etcdserverpb.ResponseHeader |
message (api/mvccpb/kv.proto)
message KeyValue
(api/mvccpb/kv.proto)
Field | Description | Type |
---|---|---|
key | key is the key in bytes. An empty key is not allowed. | bytes |
create_revision | create_revision is the revision of last creation on this key. | int64 |
mod_revision | mod_revision is the revision of last modification on this key. | int64 |
version | version is the version of the key. A deletion resets the version to zero and any modification of the key increases its version. | int64 |
value | value is the value held by the key, in bytes. | bytes |
lease | 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. | int64 |