Skip to content

Protocol Documentation

Table of Contents

Top

atomix/map/v1/map.proto

ClearRequest

ClearResponse

Field Type Label Description
timestamp atomix.time.v1.Timestamp

CloseRequest

CloseResponse

CreateRequest

Field Type Label Description
config MapConfig

CreateResponse

EntriesRequest

EntriesResponse

Field Type Label Description
entry Entry

Entry

Field Type Label Description
key string
value Value
timestamp atomix.time.v1.Timestamp

Event

Field Type Label Description
type Event.Type
entry Entry

EventsRequest

Field Type Label Description
key string
replay bool

EventsResponse

Field Type Label Description
event Event

GetRequest

Field Type Label Description
key string

GetResponse

Field Type Label Description
entry Entry

InsertRequest

Field Type Label Description
key string
value Value

InsertResponse

Field Type Label Description
entry Entry

MapCacheConfig

Field Type Label Description
enabled bool
size int32

MapConfig

Field Type Label Description
cache MapCacheConfig

PutRequest

Field Type Label Description
key string
value Value
if_timestamp atomix.time.v1.Timestamp

PutResponse

Field Type Label Description
entry Entry

RemoveRequest

Field Type Label Description
key string
if_timestamp atomix.time.v1.Timestamp

RemoveResponse

Field Type Label Description
entry Entry

SizeRequest

SizeResponse

Field Type Label Description
size uint32

UpdateRequest

Field Type Label Description
key string
value Value
if_timestamp atomix.time.v1.Timestamp

UpdateResponse

Field Type Label Description
entry Entry

Value

Field Type Label Description
value bytes
ttl google.protobuf.Duration

Event.Type

Name Number Description
NONE 0
INSERT 1
UPDATE 2
REMOVE 3
REPLAY 4

Map

Map is a service for a map primitive

Method Name Request Type Response Type Description
Create CreateRequest CreateResponse
Close CloseRequest CloseResponse
Size SizeRequest SizeResponse Size returns the size of the map
Put PutRequest PutResponse Put puts an entry into the map
Insert InsertRequest InsertResponse Insert inserts an entry into the map
Update UpdateRequest UpdateResponse Update updates an entry in the map
Get GetRequest GetResponse Get gets the entry for a key
Remove RemoveRequest RemoveResponse Remove removes an entry 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)
Back to top