Skip to content

Protocol Documentation

Table of Contents

Top

atomix/runtime/value/v1/value.proto

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

DeleteRequest

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

DeleteResponse

Field Type Label Description
value VersionedValue

Event

Field Type Label Description
created Event.Created
updated Event.Updated
deleted Event.Deleted

Event.Created

Field Type Label Description
value VersionedValue

Event.Deleted

Field Type Label Description
value VersionedValue
expired bool

Event.Updated

Field Type Label Description
value VersionedValue
prev_value VersionedValue

EventsRequest

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

EventsResponse

Field Type Label Description
event Event

GetRequest

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

GetResponse

Field Type Label Description
value VersionedValue

InsertRequest

Field Type Label Description
id atomix.runtime.v1.PrimitiveId
value bytes
ttl google.protobuf.Duration

InsertResponse

Field Type Label Description
version uint64

SetRequest

Field Type Label Description
id atomix.runtime.v1.PrimitiveId
value bytes
ttl google.protobuf.Duration

SetResponse

Field Type Label Description
version uint64
prev_value VersionedValue

UpdateRequest

Field Type Label Description
id atomix.runtime.v1.PrimitiveId
value bytes
prev_version uint64
ttl google.protobuf.Duration

UpdateResponse

Field Type Label Description
version uint64
prev_value VersionedValue

VersionedValue

Field Type Label Description
value bytes
version uint64

WatchRequest

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

WatchResponse

Field Type Label Description
value VersionedValue

Value

Value is a service for a value primitive

Method Name Request Type Response Type Description
Create CreateRequest CreateResponse Create creates the value
Close CloseRequest CloseResponse Close closes the value
Set SetRequest SetResponse Set sets the value
Insert InsertRequest InsertResponse Insert inserts the value
Update UpdateRequest UpdateResponse Update updates the value
Get GetRequest GetResponse Get gets the value
Delete DeleteRequest DeleteResponse Delete deletes the value
Watch WatchRequest WatchResponse stream Watch watches the value
Events EventsRequest EventsResponse stream Events watches for value change 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)