Skip to content

Protocol Documentation

Table of Contents

Top

api/types/snapshot/network/types.proto

DeviceSnapshotRef

DeviceSnapshotRef is a reference to a device snapshot

Field Type Label Description
device_snapshot_id string 'device_snapshot_id' is the unique identifier of the device snapshot

NetworkSnapshot

NetworkSnapshot is a snapshot of all network changes

Field Type Label Description
id string 'id' is the unique snapshot identifier
index uint64 'index' is a monotonically increasing, globally unique snapshot index
revision uint64 'revision' is the request revision number
status onos.config.snapshot.Status 'status' is the snapshot status
retention onos.config.snapshot.RetentionOptions 'retention' specifies the duration for which to retain changes
created google.protobuf.Timestamp 'created' is the time at which the configuration was created
updated google.protobuf.Timestamp 'updated' is the time at which the configuration was last updated
refs DeviceSnapshotRef repeated 'refs' is a set of references to stored device snapshots

Scalar Value Types

.proto Type Notes C++ Type Java Type Python Type
double double double float
float 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
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
uint32 Uses variable-length encoding. uint32 int int/long
uint64 Uses variable-length encoding. uint64 long int/long
sint32 Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. int32 int int
sint64 Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. int64 long int/long
fixed32 Always four bytes. More efficient than uint32 if values are often greater than 2^28. uint32 int int
fixed64 Always eight bytes. More efficient than uint64 if values are often greater than 2^56. uint64 long int/long
sfixed32 Always four bytes. int32 int int
sfixed64 Always eight bytes. int64 long int/long
bool bool boolean boolean
string A string must always contain UTF-8 encoded or 7-bit ASCII text. string String str/unicode
bytes May contain any arbitrary sequence of bytes. string ByteString str