Skip to content

Protocol Documentation

Table of Contents

Top

onos/config/v2/value.proto

PathValue

PathValue is the state of a path/value in the configuration tree

Field Type Label Description
path string 'path' is the path to change
value TypedValue 'value' is the change value
deleted bool 'deleted' indicates whether this is a delete

PathValues

PathValues is a set of path/value pairs

Field Type Label Description
values PathValues.ValuesEntry repeated 'values' is a set of change values to apply

PathValues.ValuesEntry

Field Type Label Description
key string
value PathValue

TypedValue

TypedValue is a value represented as a byte array

Field Type Label Description
bytes bytes 'bytes' is the bytes array
type ValueType 'type' is the value type
type_opts int32 repeated 'type_opts' is a set of type options

ValueType

ValueType is the type for a value

Name Number Description
EMPTY 0
STRING 1
INT 2
UINT 3
BOOL 4
DECIMAL 5
FLOAT 6
BYTES 7
LEAFLIST_STRING 8
LEAFLIST_INT 9
LEAFLIST_UINT 10
LEAFLIST_BOOL 11
LEAFLIST_DECIMAL 12
LEAFLIST_FLOAT 13
LEAFLIST_BYTES 14

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)