Documentation ¶
Overview ¶
Package telemetry is a generated protocol buffer package.
It is generated from these files:
oc.proto
It has these top-level messages:
SubscriptionRequest SubscriptionInput Collector Path SubscriptionAdditionalConfig SubscriptionReply SubscriptionResponse OpenConfigData KeyValue Delete Eom CancelSubscriptionRequest CancelSubscriptionReply GetSubscriptionsRequest GetSubscriptionsReply GetOperationalStateRequest GetOperationalStateReply DataEncodingRequest DataEncodingReply
Index ¶
- Variables
- func RegisterOpenConfigTelemetryServer(s *grpc.Server, srv OpenConfigTelemetryServer)
- type CancelSubscriptionReply
- func (*CancelSubscriptionReply) Descriptor() ([]byte, []int)
- func (m *CancelSubscriptionReply) GetCode() ReturnCode
- func (m *CancelSubscriptionReply) GetCodeStr() string
- func (*CancelSubscriptionReply) ProtoMessage()
- func (m *CancelSubscriptionReply) Reset()
- func (m *CancelSubscriptionReply) String() string
- type CancelSubscriptionRequest
- type Collector
- type DataEncodingReply
- type DataEncodingRequest
- type Delete
- type EncodingType
- type Eom
- type GetOperationalStateReply
- type GetOperationalStateRequest
- func (*GetOperationalStateRequest) Descriptor() ([]byte, []int)
- func (m *GetOperationalStateRequest) GetSubscriptionId() uint32
- func (m *GetOperationalStateRequest) GetVerbosity() VerbosityLevel
- func (*GetOperationalStateRequest) ProtoMessage()
- func (m *GetOperationalStateRequest) Reset()
- func (m *GetOperationalStateRequest) String() string
- type GetSubscriptionsReply
- type GetSubscriptionsRequest
- type KeyValue
- func (*KeyValue) Descriptor() ([]byte, []int)
- func (m *KeyValue) GetBoolValue() bool
- func (m *KeyValue) GetBytesValue() []byte
- func (m *KeyValue) GetDoubleValue() float64
- func (m *KeyValue) GetIntValue() int64
- func (m *KeyValue) GetKey() string
- func (m *KeyValue) GetSintValue() int64
- func (m *KeyValue) GetStrValue() string
- func (m *KeyValue) GetUintValue() uint64
- func (m *KeyValue) GetValue() isKeyValue_Value
- func (*KeyValue) ProtoMessage()
- func (m *KeyValue) Reset()
- func (m *KeyValue) String() string
- func (*KeyValue) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, ...)
- type KeyValue_BoolValue
- type KeyValue_BytesValue
- type KeyValue_DoubleValue
- type KeyValue_IntValue
- type KeyValue_SintValue
- type KeyValue_StrValue
- type KeyValue_UintValue
- type OpenConfigData
- func (*OpenConfigData) Descriptor() ([]byte, []int)
- func (m *OpenConfigData) GetComponentId() uint32
- func (m *OpenConfigData) GetDelete() []*Delete
- func (m *OpenConfigData) GetEom() []*Eom
- func (m *OpenConfigData) GetKv() []*KeyValue
- func (m *OpenConfigData) GetPath() string
- func (m *OpenConfigData) GetSequenceNumber() uint64
- func (m *OpenConfigData) GetSubComponentId() uint32
- func (m *OpenConfigData) GetSyncResponse() bool
- func (m *OpenConfigData) GetSystemId() string
- func (m *OpenConfigData) GetTimestamp() uint64
- func (*OpenConfigData) ProtoMessage()
- func (m *OpenConfigData) Reset()
- func (m *OpenConfigData) String() string
- type OpenConfigTelemetryClient
- type OpenConfigTelemetryServer
- type OpenConfigTelemetry_TelemetrySubscribeClient
- type OpenConfigTelemetry_TelemetrySubscribeServer
- type Path
- func (*Path) Descriptor() ([]byte, []int)
- func (m *Path) GetFilter() string
- func (m *Path) GetMaxSilentInterval() uint32
- func (m *Path) GetNeedEom() bool
- func (m *Path) GetPath() string
- func (m *Path) GetSampleFrequency() uint32
- func (m *Path) GetSuppressUnchanged() bool
- func (*Path) ProtoMessage()
- func (m *Path) Reset()
- func (m *Path) String() string
- type ReturnCode
- type SubscriptionAdditionalConfig
- func (*SubscriptionAdditionalConfig) Descriptor() ([]byte, []int)
- func (m *SubscriptionAdditionalConfig) GetLimitRecords() int32
- func (m *SubscriptionAdditionalConfig) GetLimitTimeSeconds() int32
- func (m *SubscriptionAdditionalConfig) GetNeedEos() bool
- func (*SubscriptionAdditionalConfig) ProtoMessage()
- func (m *SubscriptionAdditionalConfig) Reset()
- func (m *SubscriptionAdditionalConfig) String() string
- type SubscriptionInput
- type SubscriptionReply
- type SubscriptionRequest
- func (*SubscriptionRequest) Descriptor() ([]byte, []int)
- func (m *SubscriptionRequest) GetAdditionalConfig() *SubscriptionAdditionalConfig
- func (m *SubscriptionRequest) GetInput() *SubscriptionInput
- func (m *SubscriptionRequest) GetPathList() []*Path
- func (*SubscriptionRequest) ProtoMessage()
- func (m *SubscriptionRequest) Reset()
- func (m *SubscriptionRequest) String() string
- type SubscriptionResponse
- type VerbosityLevel
Constants ¶
This section is empty.
Variables ¶
var EncodingType_name = map[int32]string{
0: "UNDEFINED",
1: "XML",
2: "JSON_IETF",
3: "PROTO3",
}
var EncodingType_value = map[string]int32{
"UNDEFINED": 0,
"XML": 1,
"JSON_IETF": 2,
"PROTO3": 3,
}
var ReturnCode_name = map[int32]string{
0: "SUCCESS",
1: "NO_SUBSCRIPTION_ENTRY",
2: "UNKNOWN_ERROR",
}
var ReturnCode_value = map[string]int32{
"SUCCESS": 0,
"NO_SUBSCRIPTION_ENTRY": 1,
"UNKNOWN_ERROR": 2,
}
var VerbosityLevel_name = map[int32]string{
0: "DETAIL",
1: "TERSE",
2: "BRIEF",
}
var VerbosityLevel_value = map[string]int32{
"DETAIL": 0,
"TERSE": 1,
"BRIEF": 2,
}
Functions ¶
func RegisterOpenConfigTelemetryServer ¶
func RegisterOpenConfigTelemetryServer(s *grpc.Server, srv OpenConfigTelemetryServer)
Types ¶
type CancelSubscriptionReply ¶
type CancelSubscriptionReply struct { // Return code Code ReturnCode `protobuf:"varint,1,opt,name=code,enum=telemetry.ReturnCode" json:"code,omitempty"` // Return code string CodeStr string `protobuf:"bytes,2,opt,name=code_str,json=codeStr" json:"code_str,omitempty"` }
Reply to telemetry subscription cancellation request
func (*CancelSubscriptionReply) Descriptor ¶
func (*CancelSubscriptionReply) Descriptor() ([]byte, []int)
func (*CancelSubscriptionReply) GetCode ¶
func (m *CancelSubscriptionReply) GetCode() ReturnCode
func (*CancelSubscriptionReply) GetCodeStr ¶
func (m *CancelSubscriptionReply) GetCodeStr() string
func (*CancelSubscriptionReply) ProtoMessage ¶
func (*CancelSubscriptionReply) ProtoMessage()
func (*CancelSubscriptionReply) Reset ¶
func (m *CancelSubscriptionReply) Reset()
func (*CancelSubscriptionReply) String ¶
func (m *CancelSubscriptionReply) String() string
type CancelSubscriptionRequest ¶
type CancelSubscriptionRequest struct { // Subscription identifier as returned by the device when // subscription was requested SubscriptionId uint32 `protobuf:"varint,1,opt,name=subscription_id,json=subscriptionId" json:"subscription_id,omitempty"` }
Message sent for a telemetry subscription cancellation request
func (*CancelSubscriptionRequest) Descriptor ¶
func (*CancelSubscriptionRequest) Descriptor() ([]byte, []int)
func (*CancelSubscriptionRequest) GetSubscriptionId ¶
func (m *CancelSubscriptionRequest) GetSubscriptionId() uint32
func (*CancelSubscriptionRequest) ProtoMessage ¶
func (*CancelSubscriptionRequest) ProtoMessage()
func (*CancelSubscriptionRequest) Reset ¶
func (m *CancelSubscriptionRequest) Reset()
func (*CancelSubscriptionRequest) String ¶
func (m *CancelSubscriptionRequest) String() string
type Collector ¶
type Collector struct { // IP address of collector endpoint Address string `protobuf:"bytes,1,opt,name=address" json:"address,omitempty"` // Transport protocol port number for the collector destination. Port uint32 `protobuf:"varint,2,opt,name=port" json:"port,omitempty"` }
Collector endpoints to send data specified as an ip+port combination.
func (*Collector) Descriptor ¶
func (*Collector) GetAddress ¶
func (*Collector) ProtoMessage ¶
func (*Collector) ProtoMessage()
type DataEncodingReply ¶
type DataEncodingReply struct {
EncodingList []EncodingType `` /* 126-byte string literal not displayed */
}
Reply to data encodings supported request
func (*DataEncodingReply) Descriptor ¶
func (*DataEncodingReply) Descriptor() ([]byte, []int)
func (*DataEncodingReply) GetEncodingList ¶
func (m *DataEncodingReply) GetEncodingList() []EncodingType
func (*DataEncodingReply) ProtoMessage ¶
func (*DataEncodingReply) ProtoMessage()
func (*DataEncodingReply) Reset ¶
func (m *DataEncodingReply) Reset()
func (*DataEncodingReply) String ¶
func (m *DataEncodingReply) String() string
type DataEncodingRequest ¶
type DataEncodingRequest struct { }
Message sent for a data encoding request
func (*DataEncodingRequest) Descriptor ¶
func (*DataEncodingRequest) Descriptor() ([]byte, []int)
func (*DataEncodingRequest) ProtoMessage ¶
func (*DataEncodingRequest) ProtoMessage()
func (*DataEncodingRequest) Reset ¶
func (m *DataEncodingRequest) Reset()
func (*DataEncodingRequest) String ¶
func (m *DataEncodingRequest) String() string
type Delete ¶
type Delete struct {
Path string `protobuf:"bytes,1,opt,name=path" json:"path,omitempty"`
}
Message indicating delete for a particular path
func (*Delete) Descriptor ¶
func (*Delete) ProtoMessage ¶
func (*Delete) ProtoMessage()
type EncodingType ¶
type EncodingType int32
Encoding Type Supported
const ( EncodingType_UNDEFINED EncodingType = 0 EncodingType_XML EncodingType = 1 EncodingType_JSON_IETF EncodingType = 2 EncodingType_PROTO3 EncodingType = 3 )
func (EncodingType) EnumDescriptor ¶
func (EncodingType) EnumDescriptor() ([]byte, []int)
func (EncodingType) String ¶
func (x EncodingType) String() string
type Eom ¶
type Eom struct {
Path string `protobuf:"bytes,1,opt,name=path" json:"path,omitempty"`
}
Message indicating EOM for a particular path
func (*Eom) Descriptor ¶
func (*Eom) ProtoMessage ¶
func (*Eom) ProtoMessage()
type GetOperationalStateReply ¶
type GetOperationalStateReply struct { // List of key-value pairs where // key = operational state definition // value = operational state value Kv []*KeyValue `protobuf:"bytes,1,rep,name=kv" json:"kv,omitempty"` }
Reply to telemetry agent operational states request
func (*GetOperationalStateReply) Descriptor ¶
func (*GetOperationalStateReply) Descriptor() ([]byte, []int)
func (*GetOperationalStateReply) GetKv ¶
func (m *GetOperationalStateReply) GetKv() []*KeyValue
func (*GetOperationalStateReply) ProtoMessage ¶
func (*GetOperationalStateReply) ProtoMessage()
func (*GetOperationalStateReply) Reset ¶
func (m *GetOperationalStateReply) Reset()
func (*GetOperationalStateReply) String ¶
func (m *GetOperationalStateReply) String() string
type GetOperationalStateRequest ¶
type GetOperationalStateRequest struct { // Per-subscription_id level operational state can be requested. // // Subscription identifier as returned by the device when // subscription was requested // --- or --- // 0xFFFFFFFF for all subscription identifiers including agent-level // operational stats // --- or --- // If subscription_id is not present then sent only agent-level // operational stats SubscriptionId uint32 `protobuf:"varint,1,opt,name=subscription_id,json=subscriptionId" json:"subscription_id,omitempty"` // Control verbosity of the output Verbosity VerbosityLevel `protobuf:"varint,2,opt,name=verbosity,enum=telemetry.VerbosityLevel" json:"verbosity,omitempty"` }
Message sent for telemetry agent operational states request
func (*GetOperationalStateRequest) Descriptor ¶
func (*GetOperationalStateRequest) Descriptor() ([]byte, []int)
func (*GetOperationalStateRequest) GetSubscriptionId ¶
func (m *GetOperationalStateRequest) GetSubscriptionId() uint32
func (*GetOperationalStateRequest) GetVerbosity ¶
func (m *GetOperationalStateRequest) GetVerbosity() VerbosityLevel
func (*GetOperationalStateRequest) ProtoMessage ¶
func (*GetOperationalStateRequest) ProtoMessage()
func (*GetOperationalStateRequest) Reset ¶
func (m *GetOperationalStateRequest) Reset()
func (*GetOperationalStateRequest) String ¶
func (m *GetOperationalStateRequest) String() string
type GetSubscriptionsReply ¶
type GetSubscriptionsReply struct { // List of current telemetry subscriptions SubscriptionList []*SubscriptionReply `protobuf:"bytes,1,rep,name=subscription_list,json=subscriptionList" json:"subscription_list,omitempty"` }
Reply to telemetry subscription get request
func (*GetSubscriptionsReply) Descriptor ¶
func (*GetSubscriptionsReply) Descriptor() ([]byte, []int)
func (*GetSubscriptionsReply) GetSubscriptionList ¶
func (m *GetSubscriptionsReply) GetSubscriptionList() []*SubscriptionReply
func (*GetSubscriptionsReply) ProtoMessage ¶
func (*GetSubscriptionsReply) ProtoMessage()
func (*GetSubscriptionsReply) Reset ¶
func (m *GetSubscriptionsReply) Reset()
func (*GetSubscriptionsReply) String ¶
func (m *GetSubscriptionsReply) String() string
type GetSubscriptionsRequest ¶
type GetSubscriptionsRequest struct { // Subscription identifier as returned by the device when // subscription was requested // --- or --- // 0xFFFFFFFF for all subscription identifiers SubscriptionId uint32 `protobuf:"varint,1,opt,name=subscription_id,json=subscriptionId" json:"subscription_id,omitempty"` }
Message sent for a telemetry get request
func (*GetSubscriptionsRequest) Descriptor ¶
func (*GetSubscriptionsRequest) Descriptor() ([]byte, []int)
func (*GetSubscriptionsRequest) GetSubscriptionId ¶
func (m *GetSubscriptionsRequest) GetSubscriptionId() uint32
func (*GetSubscriptionsRequest) ProtoMessage ¶
func (*GetSubscriptionsRequest) ProtoMessage()
func (*GetSubscriptionsRequest) Reset ¶
func (m *GetSubscriptionsRequest) Reset()
func (*GetSubscriptionsRequest) String ¶
func (m *GetSubscriptionsRequest) String() string
type KeyValue ¶
type KeyValue struct { // Key Key string `protobuf:"bytes,1,opt,name=key" json:"key,omitempty"` // One of possible values // // Types that are valid to be assigned to Value: // *KeyValue_DoubleValue // *KeyValue_IntValue // *KeyValue_UintValue // *KeyValue_SintValue // *KeyValue_BoolValue // *KeyValue_StrValue // *KeyValue_BytesValue Value isKeyValue_Value `protobuf_oneof:"value"` }
Simple Key-value, where value could be one of scalar types
func (*KeyValue) Descriptor ¶
func (*KeyValue) GetBoolValue ¶
func (*KeyValue) GetBytesValue ¶
func (*KeyValue) GetDoubleValue ¶
func (*KeyValue) GetIntValue ¶
func (*KeyValue) GetSintValue ¶
func (*KeyValue) GetStrValue ¶
func (*KeyValue) GetUintValue ¶
func (*KeyValue) ProtoMessage ¶
func (*KeyValue) ProtoMessage()
type KeyValue_BoolValue ¶
type KeyValue_BoolValue struct {
BoolValue bool `protobuf:"varint,9,opt,name=bool_value,json=boolValue,oneof"`
}
type KeyValue_BytesValue ¶
type KeyValue_BytesValue struct {
BytesValue []byte `protobuf:"bytes,11,opt,name=bytes_value,json=bytesValue,proto3,oneof"`
}
type KeyValue_DoubleValue ¶
type KeyValue_DoubleValue struct {
DoubleValue float64 `protobuf:"fixed64,5,opt,name=double_value,json=doubleValue,oneof"`
}
type KeyValue_IntValue ¶
type KeyValue_IntValue struct {
IntValue int64 `protobuf:"varint,6,opt,name=int_value,json=intValue,oneof"`
}
type KeyValue_SintValue ¶
type KeyValue_SintValue struct {
SintValue int64 `protobuf:"zigzag64,8,opt,name=sint_value,json=sintValue,oneof"`
}
type KeyValue_StrValue ¶
type KeyValue_StrValue struct {
StrValue string `protobuf:"bytes,10,opt,name=str_value,json=strValue,oneof"`
}
type KeyValue_UintValue ¶
type KeyValue_UintValue struct {
UintValue uint64 `protobuf:"varint,7,opt,name=uint_value,json=uintValue,oneof"`
}
type OpenConfigData ¶
type OpenConfigData struct { // router name:export IP address SystemId string `protobuf:"bytes,1,opt,name=system_id,json=systemId" json:"system_id,omitempty"` // line card / RE (slot number) ComponentId uint32 `protobuf:"varint,2,opt,name=component_id,json=componentId" json:"component_id,omitempty"` // PFE (if applicable) SubComponentId uint32 `protobuf:"varint,3,opt,name=sub_component_id,json=subComponentId" json:"sub_component_id,omitempty"` // Path specification for elements of OpenConfig data models Path string `protobuf:"bytes,4,opt,name=path" json:"path,omitempty"` // Sequence number, monotonically increasing for each // system_id, component_id, sub_component_id + path. SequenceNumber uint64 `protobuf:"varint,5,opt,name=sequence_number,json=sequenceNumber" json:"sequence_number,omitempty"` // timestamp (milliseconds since epoch) Timestamp uint64 `protobuf:"varint,6,opt,name=timestamp" json:"timestamp,omitempty"` // List of key-value pairs Kv []*KeyValue `protobuf:"bytes,7,rep,name=kv" json:"kv,omitempty"` // For delete. If filled, it indicates delete Delete []*Delete `protobuf:"bytes,8,rep,name=delete" json:"delete,omitempty"` // If filled, it indicates end of marker for the // respective path in the list. Eom []*Eom `protobuf:"bytes,9,rep,name=eom" json:"eom,omitempty"` // If filled, it indicates end of sync for complete subscription SyncResponse bool `protobuf:"varint,10,opt,name=sync_response,json=syncResponse" json:"sync_response,omitempty"` }
- Telemetry data send back on the same connection as the subscription request.
func (*OpenConfigData) Descriptor ¶
func (*OpenConfigData) Descriptor() ([]byte, []int)
func (*OpenConfigData) GetComponentId ¶
func (m *OpenConfigData) GetComponentId() uint32
func (*OpenConfigData) GetDelete ¶
func (m *OpenConfigData) GetDelete() []*Delete
func (*OpenConfigData) GetEom ¶
func (m *OpenConfigData) GetEom() []*Eom
func (*OpenConfigData) GetKv ¶
func (m *OpenConfigData) GetKv() []*KeyValue
func (*OpenConfigData) GetPath ¶
func (m *OpenConfigData) GetPath() string
func (*OpenConfigData) GetSequenceNumber ¶
func (m *OpenConfigData) GetSequenceNumber() uint64
func (*OpenConfigData) GetSubComponentId ¶
func (m *OpenConfigData) GetSubComponentId() uint32
func (*OpenConfigData) GetSyncResponse ¶
func (m *OpenConfigData) GetSyncResponse() bool
func (*OpenConfigData) GetSystemId ¶
func (m *OpenConfigData) GetSystemId() string
func (*OpenConfigData) GetTimestamp ¶
func (m *OpenConfigData) GetTimestamp() uint64
func (*OpenConfigData) ProtoMessage ¶
func (*OpenConfigData) ProtoMessage()
func (*OpenConfigData) Reset ¶
func (m *OpenConfigData) Reset()
func (*OpenConfigData) String ¶
func (m *OpenConfigData) String() string
type OpenConfigTelemetryClient ¶
type OpenConfigTelemetryClient interface { // Request an inline subscription for data at the specified path. // The device should send telemetry data back on the same // connection as the subscription request. TelemetrySubscribe(ctx context.Context, in *SubscriptionRequest, opts ...grpc.CallOption) (OpenConfigTelemetry_TelemetrySubscribeClient, error) // Terminates and removes an exisiting telemetry subscription CancelTelemetrySubscription(ctx context.Context, in *CancelSubscriptionRequest, opts ...grpc.CallOption) (*CancelSubscriptionReply, error) // Get the list of current telemetry subscriptions from the // target. This command returns a list of existing subscriptions // not including those that are established via configuration. GetTelemetrySubscriptions(ctx context.Context, in *GetSubscriptionsRequest, opts ...grpc.CallOption) (*GetSubscriptionsReply, error) // Get Telemetry Agent Operational States GetTelemetryOperationalState(ctx context.Context, in *GetOperationalStateRequest, opts ...grpc.CallOption) (*GetOperationalStateReply, error) // Return the set of data encodings supported by the device for // telemetry data GetDataEncodings(ctx context.Context, in *DataEncodingRequest, opts ...grpc.CallOption) (*DataEncodingReply, error) }
func NewOpenConfigTelemetryClient ¶
func NewOpenConfigTelemetryClient(cc *grpc.ClientConn) OpenConfigTelemetryClient
type OpenConfigTelemetryServer ¶
type OpenConfigTelemetryServer interface { // Request an inline subscription for data at the specified path. // The device should send telemetry data back on the same // connection as the subscription request. TelemetrySubscribe(*SubscriptionRequest, OpenConfigTelemetry_TelemetrySubscribeServer) error // Terminates and removes an exisiting telemetry subscription CancelTelemetrySubscription(context.Context, *CancelSubscriptionRequest) (*CancelSubscriptionReply, error) // Get the list of current telemetry subscriptions from the // target. This command returns a list of existing subscriptions // not including those that are established via configuration. GetTelemetrySubscriptions(context.Context, *GetSubscriptionsRequest) (*GetSubscriptionsReply, error) // Get Telemetry Agent Operational States GetTelemetryOperationalState(context.Context, *GetOperationalStateRequest) (*GetOperationalStateReply, error) // Return the set of data encodings supported by the device for // telemetry data GetDataEncodings(context.Context, *DataEncodingRequest) (*DataEncodingReply, error) }
type OpenConfigTelemetry_TelemetrySubscribeClient ¶
type OpenConfigTelemetry_TelemetrySubscribeClient interface { Recv() (*OpenConfigData, error) grpc.ClientStream }
type OpenConfigTelemetry_TelemetrySubscribeServer ¶
type OpenConfigTelemetry_TelemetrySubscribeServer interface { Send(*OpenConfigData) error grpc.ServerStream }
type Path ¶
type Path struct { // Data model path of interest // Path specification for elements of OpenConfig data models Path string `protobuf:"bytes,1,opt,name=path" json:"path,omitempty"` // Regular expression to be used in filtering state leaves Filter string `protobuf:"bytes,2,opt,name=filter" json:"filter,omitempty"` // If this is set to true, the target device will only send // updates to the collector upon a change in data value SuppressUnchanged bool `protobuf:"varint,3,opt,name=suppress_unchanged,json=suppressUnchanged" json:"suppress_unchanged,omitempty"` // Maximum time in ms the target device may go without sending // a message to the collector. If this time expires with // suppress-unchanged set, the target device must send an update // message regardless if the data values have changed. MaxSilentInterval uint32 `protobuf:"varint,4,opt,name=max_silent_interval,json=maxSilentInterval" json:"max_silent_interval,omitempty"` // Time in ms between collection and transmission of the // specified data to the collector platform. The target device // will sample the corresponding data (e.g,. a counter) and // immediately send to the collector destination. // // If sample-frequency is set to 0, then the network device // must emit an update upon every datum change. SampleFrequency uint32 `protobuf:"varint,5,opt,name=sample_frequency,json=sampleFrequency" json:"sample_frequency,omitempty"` // EOM needed for each walk cycle of this path? // For periodic sensor, applicable for each complete reap // For event sensor, applicable when initial dump is over // (same as EOS) // This feature is not implemented currently. NeedEom bool `protobuf:"varint,6,opt,name=need_eom,json=needEom" json:"need_eom,omitempty"` }
Data model path
func (*Path) Descriptor ¶
func (*Path) GetMaxSilentInterval ¶
func (*Path) GetNeedEom ¶
func (*Path) GetSampleFrequency ¶
func (*Path) GetSuppressUnchanged ¶
func (*Path) ProtoMessage ¶
func (*Path) ProtoMessage()
type ReturnCode ¶
type ReturnCode int32
Result of the operation
const ( ReturnCode_SUCCESS ReturnCode = 0 ReturnCode_NO_SUBSCRIPTION_ENTRY ReturnCode = 1 ReturnCode_UNKNOWN_ERROR ReturnCode = 2 )
func (ReturnCode) EnumDescriptor ¶
func (ReturnCode) EnumDescriptor() ([]byte, []int)
func (ReturnCode) String ¶
func (x ReturnCode) String() string
type SubscriptionAdditionalConfig ¶
type SubscriptionAdditionalConfig struct { // limit the number of records sent in the stream LimitRecords int32 `protobuf:"varint,1,opt,name=limit_records,json=limitRecords" json:"limit_records,omitempty"` // limit the time the stream remains open LimitTimeSeconds int32 `protobuf:"varint,2,opt,name=limit_time_seconds,json=limitTimeSeconds" json:"limit_time_seconds,omitempty"` // EOS needed for this subscription? NeedEos bool `protobuf:"varint,3,opt,name=need_eos,json=needEos" json:"need_eos,omitempty"` }
Configure subscription request additional features.
func (*SubscriptionAdditionalConfig) Descriptor ¶
func (*SubscriptionAdditionalConfig) Descriptor() ([]byte, []int)
func (*SubscriptionAdditionalConfig) GetLimitRecords ¶
func (m *SubscriptionAdditionalConfig) GetLimitRecords() int32
func (*SubscriptionAdditionalConfig) GetLimitTimeSeconds ¶
func (m *SubscriptionAdditionalConfig) GetLimitTimeSeconds() int32
func (*SubscriptionAdditionalConfig) GetNeedEos ¶
func (m *SubscriptionAdditionalConfig) GetNeedEos() bool
func (*SubscriptionAdditionalConfig) ProtoMessage ¶
func (*SubscriptionAdditionalConfig) ProtoMessage()
func (*SubscriptionAdditionalConfig) Reset ¶
func (m *SubscriptionAdditionalConfig) Reset()
func (*SubscriptionAdditionalConfig) String ¶
func (m *SubscriptionAdditionalConfig) String() string
type SubscriptionInput ¶
type SubscriptionInput struct { // List of optional collector endpoints to send data for // this subscription. // If no collector destinations are specified, the collector // destination is assumed to be the requester on the rpc channel. CollectorList []*Collector `protobuf:"bytes,1,rep,name=collector_list,json=collectorList" json:"collector_list,omitempty"` }
Data associated with a telemetry subscription
func (*SubscriptionInput) Descriptor ¶
func (*SubscriptionInput) Descriptor() ([]byte, []int)
func (*SubscriptionInput) GetCollectorList ¶
func (m *SubscriptionInput) GetCollectorList() []*Collector
func (*SubscriptionInput) ProtoMessage ¶
func (*SubscriptionInput) ProtoMessage()
func (*SubscriptionInput) Reset ¶
func (m *SubscriptionInput) Reset()
func (*SubscriptionInput) String ¶
func (m *SubscriptionInput) String() string
type SubscriptionReply ¶
type SubscriptionReply struct { // Response message to a telemetry subscription creation or // get request. Response *SubscriptionResponse `protobuf:"bytes,1,opt,name=response" json:"response,omitempty"` // List of data models paths and filters // which are used in a telemetry operation. PathList []*Path `protobuf:"bytes,2,rep,name=path_list,json=pathList" json:"path_list,omitempty"` }
1. Reply data message sent out using out-of-band channel.
func (*SubscriptionReply) Descriptor ¶
func (*SubscriptionReply) Descriptor() ([]byte, []int)
func (*SubscriptionReply) GetPathList ¶
func (m *SubscriptionReply) GetPathList() []*Path
func (*SubscriptionReply) GetResponse ¶
func (m *SubscriptionReply) GetResponse() *SubscriptionResponse
func (*SubscriptionReply) ProtoMessage ¶
func (*SubscriptionReply) ProtoMessage()
func (*SubscriptionReply) Reset ¶
func (m *SubscriptionReply) Reset()
func (*SubscriptionReply) String ¶
func (m *SubscriptionReply) String() string
type SubscriptionRequest ¶
type SubscriptionRequest struct { // Data associated with a telemetry subscription Input *SubscriptionInput `protobuf:"bytes,1,opt,name=input" json:"input,omitempty"` // List of data models paths and filters // which are used in a telemetry operation. PathList []*Path `protobuf:"bytes,2,rep,name=path_list,json=pathList" json:"path_list,omitempty"` // The below configuration is not defined in Openconfig RPC. // It is a proposed extension to configure additional // subscription request features. AdditionalConfig *SubscriptionAdditionalConfig `protobuf:"bytes,3,opt,name=additional_config,json=additionalConfig" json:"additional_config,omitempty"` }
Message sent for a telemetry subscription request
func (*SubscriptionRequest) Descriptor ¶
func (*SubscriptionRequest) Descriptor() ([]byte, []int)
func (*SubscriptionRequest) GetAdditionalConfig ¶
func (m *SubscriptionRequest) GetAdditionalConfig() *SubscriptionAdditionalConfig
func (*SubscriptionRequest) GetInput ¶
func (m *SubscriptionRequest) GetInput() *SubscriptionInput
func (*SubscriptionRequest) GetPathList ¶
func (m *SubscriptionRequest) GetPathList() []*Path
func (*SubscriptionRequest) ProtoMessage ¶
func (*SubscriptionRequest) ProtoMessage()
func (*SubscriptionRequest) Reset ¶
func (m *SubscriptionRequest) Reset()
func (*SubscriptionRequest) String ¶
func (m *SubscriptionRequest) String() string
type SubscriptionResponse ¶
type SubscriptionResponse struct { // Unique id for the subscription on the device. This is // generated by the device and returned in a subscription // request or when listing existing subscriptions SubscriptionId uint32 `protobuf:"varint,1,opt,name=subscription_id,json=subscriptionId" json:"subscription_id,omitempty"` }
Response message to a telemetry subscription creation or get request.
func (*SubscriptionResponse) Descriptor ¶
func (*SubscriptionResponse) Descriptor() ([]byte, []int)
func (*SubscriptionResponse) GetSubscriptionId ¶
func (m *SubscriptionResponse) GetSubscriptionId() uint32
func (*SubscriptionResponse) ProtoMessage ¶
func (*SubscriptionResponse) ProtoMessage()
func (*SubscriptionResponse) Reset ¶
func (m *SubscriptionResponse) Reset()
func (*SubscriptionResponse) String ¶
func (m *SubscriptionResponse) String() string
type VerbosityLevel ¶
type VerbosityLevel int32
Verbosity Level
const ( VerbosityLevel_DETAIL VerbosityLevel = 0 VerbosityLevel_TERSE VerbosityLevel = 1 VerbosityLevel_BRIEF VerbosityLevel = 2 )
func (VerbosityLevel) EnumDescriptor ¶
func (VerbosityLevel) EnumDescriptor() ([]byte, []int)
func (VerbosityLevel) String ¶
func (x VerbosityLevel) String() string