Protocol Documentation¶

Table of Contents¶

atomix/runtime/election/v1/election.proto
Scalar Value Types

atomix/runtime/election/v1/election.proto¶

AnointRequest¶

Field	Type	Label	Description
id	atomix.runtime.v1.PrimitiveId
candidate	string

AnointResponse¶

Field	Type	Label	Description
term	Term

CloseRequest¶

Field	Type	Label	Description
id	atomix.runtime.v1.PrimitiveId

CloseResponse¶

CreateRequest¶

Field	Type	Label	Description
id	atomix.runtime.v1.PrimitiveId
tags	string	repeated

CreateResponse¶

DemoteRequest¶

Field	Type	Label	Description
id	atomix.runtime.v1.PrimitiveId
candidate	string

DemoteResponse¶

Field	Type	Label	Description
term	Term

EnterRequest¶

Field	Type	Label	Description
id	atomix.runtime.v1.PrimitiveId
candidate	string

EnterResponse¶

Field	Type	Label	Description
term	Term

EvictRequest¶

Field	Type	Label	Description
id	atomix.runtime.v1.PrimitiveId
candidate	string

EvictResponse¶

Field	Type	Label	Description
term	Term

GetTermRequest¶

Field	Type	Label	Description
id	atomix.runtime.v1.PrimitiveId

GetTermResponse¶

Field	Type	Label	Description
term	Term

PromoteRequest¶

Field	Type	Label	Description
id	atomix.runtime.v1.PrimitiveId
candidate	string

PromoteResponse¶

Field	Type	Label	Description
term	Term

Term¶

Field	Type	Label
term	uint64
leader	string
candidates	string	repeated

WatchRequest¶

Field	Type	Label	Description
id	atomix.runtime.v1.PrimitiveId

WatchResponse¶

Field	Type	Label	Description
term	Term

WithdrawRequest¶

Field	Type	Label	Description
id	atomix.runtime.v1.PrimitiveId
candidate	string

WithdrawResponse¶

Field	Type	Label	Description
term	Term

LeaderElection¶

LeaderElection is a service for a leader election primitive

Method Name	Request Type	Response Type	Description
Create	CreateRequest	CreateResponse	Create creates the leader election
Close	CloseRequest	CloseResponse	Close closes the leader election
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
Demote	DemoteRequest	DemoteResponse	Demote demotes a candidate
Evict	EvictRequest	EvictResponse	Evict evicts a candidate from the election
GetTerm	GetTermRequest	GetTermResponse	GetTerm gets the current leadership term
Watch	WatchRequest	WatchResponse stream	Watch watches the election for 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)