Protocol Documentation¶

Table of Contents¶

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

atomix/runtime/multimap/v1/multimap.proto¶

ClearRequest¶

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

ClearResponse¶

CloseRequest¶

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

CloseResponse¶

ContainsRequest¶

Field	Type	Label	Description
id	atomix.runtime.v1.PrimitiveId
key	string
value	string

ContainsResponse¶

Field	Type	Label	Description
result	bool

CreateRequest¶

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

CreateResponse¶

EntriesRequest¶

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

EntriesResponse¶

Field	Type	Label	Description
entry	Entry

Entry¶

Field	Type	Label	Description
key	string
values	string	repeated

Event¶

Field	Type	Label	Description
key	string
added	Event.Added
removed	Event.Removed

Event.Added¶

Field	Type	Label	Description
value	string

Event.Removed¶

Field	Type	Label	Description
value	string

EventsRequest¶

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

EventsResponse¶

Field	Type	Label	Description
event	Event

GetRequest¶

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

GetResponse¶

Field	Type	Label	Description
values	string	repeated

PutAllRequest¶

Field	Type	Label
id	atomix.runtime.v1.PrimitiveId
key	string
values	string	repeated

PutAllResponse¶

Field	Type	Label	Description
updated	bool

PutEntriesRequest¶

Field	Type	Label	Description
id	atomix.runtime.v1.PrimitiveId
entries	Entry	repeated

PutEntriesResponse¶

Field	Type	Label	Description
updated	bool

PutRequest¶

Field	Type	Label	Description
id	atomix.runtime.v1.PrimitiveId
key	string
value	string

PutResponse¶

RemoveAllRequest¶

Field	Type	Label
id	atomix.runtime.v1.PrimitiveId
key	string
values	string	repeated

RemoveAllResponse¶

Field	Type	Label	Description
updated	bool

RemoveEntriesRequest¶

Field	Type	Label	Description
id	atomix.runtime.v1.PrimitiveId
entries	Entry	repeated

RemoveEntriesResponse¶

Field	Type	Label	Description
updated	bool

RemoveRequest¶

Field	Type	Label	Description
id	atomix.runtime.v1.PrimitiveId
key	string
value	string

RemoveResponse¶

Field	Type	Label	Description
values	string	repeated

ReplaceRequest¶

Field	Type	Label
id	atomix.runtime.v1.PrimitiveId
key	string
values	string	repeated

ReplaceResponse¶

Field	Type	Label	Description
prev_values	string	repeated

SizeRequest¶

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

SizeResponse¶

Field	Type	Label	Description
size	uint32

MultiMap¶

MultiMap is a service for a multimap primitive

Method Name	Request Type	Response Type	Description
Create	CreateRequest	CreateResponse	Create creates the map
Close	CloseRequest	CloseResponse	Close closes the map
Size	SizeRequest	SizeResponse	Size returns the size of the map
Put	PutRequest	PutResponse	Put adds a value to an entry in the map
PutAll	PutAllRequest	PutAllResponse	PutAll adds values to an entry in the map
PutEntries	PutEntriesRequest	PutEntriesResponse	PutEntries adds entries to the map
Replace	ReplaceRequest	ReplaceResponse	Replace replaces the values of an entry in the map
Contains	ContainsRequest	ContainsResponse	Contains checks if an entry exists in the map
Get	GetRequest	GetResponse	Get gets the entry for a key
Remove	RemoveRequest	RemoveResponse	Remove removes an entry from the map
RemoveAll	RemoveAllRequest	RemoveAllResponse	RemoveAll removes a key from the map
RemoveEntries	RemoveEntriesRequest	RemoveEntriesResponse	RemoveEntries removes entries from the map
Clear	ClearRequest	ClearResponse	Clear removes all entries from the map
Events	EventsRequest	EventsResponse stream	Events listens for change events
Entries	EntriesRequest	EntriesResponse stream	Entries lists all entries in the map

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)