package v3electionpb

Get desktop application:
View/edit binary Protocol Buffers messages

The election service exposes client-side election facilities as a gRPC interface.

• rpc Campaign (CampaignRequest, CampaignResponse)

  v3election.proto:20

  Campaign waits to acquire leadership in an election, returning a LeaderKey representing the leadership if successful. The LeaderKey can then be used to issue new values on the election, transactionally guard API requests on leadership still being held, and resign from the election.

  option (google.api.http) = { post: "/v3/election/campaign" body: "*" };

  message CampaignRequest

  v3election.proto:58

  • bytes name = 1

    name is the election's identifier for the campaign.

  • int64 lease = 2

    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.

  • bytes value = 3

    value is the initial proclaimed value set when the campaigner wins the election.

  message CampaignResponse

  v3election.proto:70

  • optional etcdserverpb.ResponseHeader header = 1

  • optional LeaderKey leader = 2

    leader describes the resources used for holding leadership of the election.

• rpc Proclaim (ProclaimRequest, ProclaimResponse)

  v3election.proto:27

  Proclaim updates the leader's posted value with a new value.

  option (google.api.http) = { post: "/v3/election/proclaim" body: "*" };

  message ProclaimRequest

  v3election.proto:110

  • optional LeaderKey leader = 1

    leader is the leadership hold on the election.

  • bytes value = 2

    value is an update meant to overwrite the leader's current value.

  message ProclaimResponse

  v3election.proto:117

  • optional etcdserverpb.ResponseHeader header = 1

• rpc Leader (LeaderRequest, LeaderResponse)

  v3election.proto:34

  Leader returns the current election proclamation, if any.

  option (google.api.http) = { post: "/v3/election/leader" body: "*" };

• rpc Observe (LeaderRequest, stream LeaderResponse)

  v3election.proto:42

  Observe streams election proclamations in-order as made by the election's elected leaders.

  option (google.api.http) = { post: "/v3/election/observe" body: "*" };

• rpc Resign (ResignRequest, ResignResponse)

  v3election.proto:50

  Resign releases election leadership so other campaigners may acquire leadership on the election.

  option (google.api.http) = { post: "/v3/election/resign" body: "*" };

  message ResignRequest

  v3election.proto:101

  • optional LeaderKey leader = 1

    leader is the leadership to relinquish by resignation.

  message ResignResponse

  v3election.proto:106

  • optional etcdserverpb.ResponseHeader header = 1

Used in: CampaignResponse, ProclaimRequest, ResignRequest

• bytes name = 1

  name is the election identifier that corresponds to the leadership key.

• bytes key = 2

  key is an opaque key representing the ownership of the election. If the key is deleted, then leadership is lost.

• int64 rev = 3

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

  lease is the lease ID of the election leader.

Used as request type in: Election.Leader, Election.Observe

• bytes name = 1

  name is the election identifier for the leadership information.

Used as response type in: Election.Leader, Election.Observe

• optional etcdserverpb.ResponseHeader header = 1

• optional mvccpb.KeyValue kv = 2

  kv is the key-value pair representing the latest leader update.