Skip to content

Protocol Documentation

Table of Contents

Top

atomix/list/v1/list.proto

AppendRequest

Field Type Label Description
value Value

AppendResponse

ClearRequest

ClearResponse

CloseRequest

CloseResponse

ContainsRequest

Field Type Label Description
value Value

ContainsResponse

Field Type Label Description
contains bool

CreateRequest

Field Type Label Description
config ListConfig

CreateResponse

ElementsRequest

ElementsResponse

Field Type Label Description
item Item

Event

Field Type Label Description
type Event.Type
item Item

EventsRequest

Field Type Label Description
replay bool

EventsResponse

Field Type Label Description
event Event

GetRequest

Field Type Label Description
index uint32

GetResponse

Field Type Label Description
item Item

InsertRequest

Field Type Label Description
index uint32
value Value

InsertResponse

Field Type Label Description
item Item

Item

Field Type Label Description
index uint32
value Value
timestamp atomix.time.v1.Timestamp

ListConfig

RemoveRequest

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

RemoveResponse

Field Type Label Description
item Item

SetRequest

Field Type Label Description
index uint32
value Value
timestamp atomix.time.v1.Timestamp

SetResponse

Field Type Label Description
item Item

SizeRequest

SizeResponse

Field Type Label Description
size uint32

Value

Field Type Label Description
value string

Event.Type

Name Number Description
NONE 0
ADD 1
REMOVE 2
REPLAY 3

List

List is a service for a list primitive

Method Name Request Type Response Type Description
Create CreateRequest CreateResponse
Close CloseRequest CloseResponse
Size SizeRequest SizeResponse Size gets the number of elements in the list
Append AppendRequest AppendResponse Append appends a value to the list
Insert InsertRequest InsertResponse Insert inserts a value at a specific index in the list
Get GetRequest GetResponse Get gets the value at an index in the list
Set SetRequest SetResponse Set sets the value at an index in the list
Remove RemoveRequest RemoveResponse Remove removes an element from the list
Clear ClearRequest ClearResponse Clear removes all elements from the list
Events EventsRequest EventsResponse stream Events listens for change events
Elements ElementsRequest ElementsResponse stream Elements streams all elements in the list

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