Skip to content

Protocol Documentation

Table of Contents

Top

atomix/election/v1/election.proto

AnointRequest

Field Type Label Description
candidate_id string

AnointResponse

Field Type Label Description
term Term

CloseRequest

CloseResponse

CreateRequest

Field Type Label Description
config LeaderElectionConfig

CreateResponse

EnterRequest

Field Type Label Description
candidate_id string

EnterResponse

Field Type Label Description
term Term

Event

Field Type Label Description
type Event.Type
term Term

EventsRequest

EventsResponse

Field Type Label Description
event Event

EvictRequest

Field Type Label Description
candidate_id string

EvictResponse

Field Type Label Description
term Term

GetTermRequest

GetTermResponse

Field Type Label Description
term Term

LeaderElectionConfig

PromoteRequest

Field Type Label Description
candidate_id string

PromoteResponse

Field Type Label Description
term Term

Term

Field Type Label Description
leader_id string
candidates string repeated
timestamp atomix.time.v1.Timestamp

WithdrawRequest

Field Type Label Description
candidate_id string

WithdrawResponse

Field Type Label Description
term Term

Event.Type

Name Number Description
NONE 0
CHANGED 1

LeaderElection

LeaderElection is a service for a leader election primitive

Method Name Request Type Response Type Description
Create CreateRequest CreateResponse
Close CloseRequest CloseResponse
Enter EnterRequest EnterResponse Enter enters the leader election
Withdraw WithdrawRequest WithdrawResponse Withdraw withdraws a candidate from the leader election
Anoint AnointRequest AnointResponse Anoint anoints a candidate leader
Promote PromoteRequest PromoteResponse Promote promotes a candidate
Evict EvictRequest EvictResponse Evict evicts a candidate from the election
GetTerm GetTermRequest GetTermResponse GetTerm gets the current leadership term
Events EventsRequest EventsResponse stream Events listens for leadership events

Scalar Value Types

.proto Type Notes C++ Java Python Go C# PHP Ruby
double double double float float64 double float Float
float float float float float32 float float Float
int32 Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. int32 int int int32 int integer Bignum or Fixnum (as required)
int64 Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. int64 long int/long int64 long integer/string Bignum
uint32 Uses variable-length encoding. uint32 int int/long uint32 uint integer Bignum or Fixnum (as required)
uint64 Uses variable-length encoding. uint64 long int/long uint64 ulong integer/string Bignum or Fixnum (as required)
sint32 Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. int32 int int int32 int integer Bignum or Fixnum (as required)
sint64 Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. int64 long int/long int64 long integer/string Bignum
fixed32 Always four bytes. More efficient than uint32 if values are often greater than 2^28. uint32 int int uint32 uint integer Bignum or Fixnum (as required)
fixed64 Always eight bytes. More efficient than uint64 if values are often greater than 2^56. uint64 long int/long uint64 ulong integer/string Bignum
sfixed32 Always four bytes. int32 int int int32 int integer Bignum or Fixnum (as required)
sfixed64 Always eight bytes. int64 long int/long int64 long integer/string Bignum
bool bool boolean boolean bool bool boolean TrueClass/FalseClass
string A string must always contain UTF-8 encoded or 7-bit ASCII text. string String str/unicode string string string String (UTF-8)
bytes May contain any arbitrary sequence of bytes. string ByteString str []byte ByteString string String (ASCII-8BIT)
Back to top