Skip to content

Protocol Documentation

Table of Contents

Top

onos/config/v2/proposal.proto

ChangeProposal

Field Type Label Description
values ChangeProposal.ValuesEntry repeated 'changes' is the proposed change values

ChangeProposal.ValuesEntry

Field Type Label Description
key string
value PathValue

Proposal

Field Type Label Description
meta ObjectMeta
id string 'id' is the unique identifier of the proposal
target_id string 'target_id' is the proposal's target identifier
transaction_index uint64 'transaction_index' is the unique index of the transaction
change ChangeProposal
rollback RollbackProposal
status ProposalStatus 'status' is the current lifecycle status of the proposal
target_info TargetTypeVersion

ProposalAbortPhase

Field Type Label Description
status ProposalPhaseStatus
state ProposalAbortPhase.State

ProposalApplyPhase

Field Type Label Description
status ProposalPhaseStatus
state ProposalApplyPhase.State
term uint64
failure Failure

ProposalCommitPhase

Field Type Label Description
status ProposalPhaseStatus
state ProposalCommitPhase.State

ProposalEvent

ProposalEvent proposal store event

Field Type Label Description
type ProposalEvent.EventType
proposal Proposal

ProposalInitializePhase

Field Type Label Description
status ProposalPhaseStatus
state ProposalInitializePhase.State

ProposalPhaseStatus

Field Type Label Description
start google.protobuf.Timestamp
end google.protobuf.Timestamp

ProposalPhases

Field Type Label Description
initialize ProposalInitializePhase 'initialize' is the proposal initialization phase status
validate ProposalValidatePhase 'validate' is the proposal validation phase status
commit ProposalCommitPhase 'commit' is the proposal commit phase status
apply ProposalApplyPhase 'apply' is the proposal apply phase status
abort ProposalAbortPhase 'abort' is the proposal abort phase status

ProposalStatus

ProposalStatus is the status of a Proposal

Field Type Label Description
phases ProposalPhases 'phases' is the proposal phases
prev_index uint64 'prev_index' is the index of the previous proposal associated with this target
next_index uint64 'next_index' is the index of the next proposal associated with this target
rollback_index uint64 'rollback_index' is a reference to the index to which to roll back
rollback_values ProposalStatus.RollbackValuesEntry repeated 'rollback_values' is the set of values to use to roll back the proposal

ProposalStatus.RollbackValuesEntry

Field Type Label Description
key string
value PathValue

ProposalValidatePhase

Field Type Label Description
status ProposalPhaseStatus
state ProposalValidatePhase.State
failure Failure

RollbackProposal

Field Type Label Description
rollback_index uint64 'rollback_index' is the index of the transaction to roll back

ProposalAbortPhase.State

Name Number Description
ABORTING 0
ABORTED 1

ProposalApplyPhase.State

Name Number Description
APPLYING 0
APPLIED 1
FAILED 2

ProposalCommitPhase.State

Name Number Description
COMMITTING 0
COMMITTED 1

ProposalEvent.EventType

EventType proposal event types for proposal store

Name Number Description
UNKNOWN 0
CREATED 1
UPDATED 2
DELETED 3
REPLAYED 4

ProposalInitializePhase.State

Name Number Description
INITIALIZING 0
INITIALIZED 1

ProposalValidatePhase.State

Name Number Description
VALIDATING 0
VALIDATED 1
FAILED 2

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)