topo

package
v0.6.10 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 10, 2020 License: Apache-2.0 Imports: 10 Imported by: 159

README

Topology Service: Go Bindings

This package provides Go bindings for the gRPC services implemented by the µONOS Topology service.

Documentation

Index

Constants

View Source 
const (
	Address     = "address"
	Target      = "target"
	Type        = "type"
	Version     = "version"
	Timeout     = "timeout"
	Role        = "role"
	Displayname = "displayname"
	User        = "user"
	Password    = "password"
	TLSCaCert   = "tls-ca-cert"
	TLSCert     = "tls-cert"
	TLSKey      = "tls-key"
	TLSPlain    = "tls-plain"
	TLSInsecure = "tls-insecure"
)

Attribute keys

View Source 
const NullID = ""

NullID ...

Variables

View Source 
var (
	ErrInvalidLengthTopo        = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowTopo          = fmt.Errorf("proto: integer overflow")
	ErrUnexpectedEndOfGroupTopo = fmt.Errorf("proto: unexpected end of group")
)
View Source 
var ChannelState_name = map[int32]string{
	0: "UNKNOWN_CHANNEL_STATE",
	1: "CONNECTED",
	2: "DISCONNECTED",
}
View Source 
var ChannelState_value = map[string]int32{
	"UNKNOWN_CHANNEL_STATE": 0,
	"CONNECTED":             1,
	"DISCONNECTED":          2,
}
View Source 
var ConnectivityState_name = map[int32]string{
	0: "UNKNOWN_CONNECTIVITY_STATE",
	1: "REACHABLE",
	2: "UNREACHABLE",
}
View Source 
var ConnectivityState_value = map[string]int32{
	"UNKNOWN_CONNECTIVITY_STATE": 0,
	"REACHABLE":                  1,
	"UNREACHABLE":                2,
}
View Source 
var EventType_name = map[int32]string{
	0: "NONE",
	1: "ADDED",
	2: "UPDATED",
	3: "REMOVED",
}
View Source 
var EventType_value = map[string]int32{
	"NONE":    0,
	"ADDED":   1,
	"UPDATED": 2,
	"REMOVED": 3,
}
View Source 
var Object_Type_name = map[int32]string{
	0: "UNSPECIFIED",
	1: "ENTITY",
	2: "RELATION",
	3: "KIND",
}
View Source 
var Object_Type_value = map[string]int32{
	"UNSPECIFIED": 0,
	"ENTITY":      1,
	"RELATION":    2,
	"KIND":        3,
}
View Source 
var Protocol_name = map[int32]string{
	0: "UNKNOWN_PROTOCOL",
	1: "GNMI",
	2: "P4RUNTIME",
	3: "GNOI",
	4: "E2AP",
}
View Source 
var Protocol_value = map[string]int32{
	"UNKNOWN_PROTOCOL": 0,
	"GNMI":             1,
	"P4RUNTIME":        2,
	"GNOI":             3,
	"E2AP":             4,
}
View Source 
var ServiceState_name = map[int32]string{
	0: "UNKNOWN_SERVICE_STATE",
	1: "AVAILABLE",
	2: "UNAVAILABLE",
	3: "CONNECTING",
}
View Source 
var ServiceState_value = map[string]int32{
	"UNKNOWN_SERVICE_STATE": 0,
	"AVAILABLE":             1,
	"UNAVAILABLE":           2,
	"CONNECTING":            3,
}
View Source 
var TopoClientFactory = func(cc *grpc.ClientConn) TopoClient {
	return NewTopoClient(cc)
}

TopoClientFactory : Default EntityServiceClient creation.

Functions

func RegisterTopoServer 

func RegisterTopoServer(s *grpc.Server, srv TopoServer)

Types

type ChannelState 

type ChannelState int32

ConnectivityState represents the state of a gRPC channel to the device from the service container 

const (
	//UNKNOWN_CHANNEL_STATE constant needed to go around proto3 nullifying the 0 values
	ChannelState_UNKNOWN_CHANNEL_STATE ChannelState = 0
	// CONNECTED indicates the corresponding grpc channel is connected on this device
	ChannelState_CONNECTED ChannelState = 1
	// DISCONNECTED indicates the corresponding grpc channel is not connected on this device
	ChannelState_DISCONNECTED ChannelState = 2
)

func (ChannelState) EnumDescriptor 

func (ChannelState) EnumDescriptor() ([]byte, []int)

func (ChannelState) String 

func (x ChannelState) String() string

type ConnectivityState 

type ConnectivityState int32

ConnectivityState represents the L3 reachability of a device from the service container (e.g. enos-config), independently of gRPC or the service itself (e.g. gNMI) 

const (
	//UNKNOWN_CONNECTIVITY_STATE constant needed to go around proto3 nullifying the 0 values
	ConnectivityState_UNKNOWN_CONNECTIVITY_STATE ConnectivityState = 0
	// REACHABLE indicates the the service can reach the device at L3
	ConnectivityState_REACHABLE ConnectivityState = 1
	// UNREACHABLE indicates the the service can't reach the device at L3
	ConnectivityState_UNREACHABLE ConnectivityState = 2
)

func (ConnectivityState) EnumDescriptor 

func (ConnectivityState) EnumDescriptor() ([]byte, []int)

func (ConnectivityState) String 

func (x ConnectivityState) String() string

type CreateRequest 

type CreateRequest struct {
	Object *Object `protobuf:"bytes,1,opt,name=object,proto3" json:"object,omitempty"`
}

func (*CreateRequest) Descriptor 

func (*CreateRequest) Descriptor() ([]byte, []int)

func (*CreateRequest) GetObject 

func (m *CreateRequest) GetObject() *Object

func (*CreateRequest) Marshal 

func (m *CreateRequest) Marshal() (dAtA []byte, err error)

func (*CreateRequest) MarshalTo 

func (m *CreateRequest) MarshalTo(dAtA []byte) (int, error)

func (*CreateRequest) MarshalToSizedBuffer 

func (m *CreateRequest) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*CreateRequest) ProtoMessage 

func (*CreateRequest) ProtoMessage()

func (*CreateRequest) Reset 

func (m *CreateRequest) Reset()

func (*CreateRequest) Size 

func (m *CreateRequest) Size() (n int)

func (*CreateRequest) String 

func (m *CreateRequest) String() string

func (*CreateRequest) Unmarshal 

func (m *CreateRequest) Unmarshal(dAtA []byte) error

func (*CreateRequest) XXX_DiscardUnknown 

func (m *CreateRequest) XXX_DiscardUnknown()

func (*CreateRequest) XXX_Marshal 

func (m *CreateRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*CreateRequest) XXX_Merge 

func (m *CreateRequest) XXX_Merge(src proto.Message)

func (*CreateRequest) XXX_Size 

func (m *CreateRequest) XXX_Size() int

func (*CreateRequest) XXX_Unmarshal 

func (m *CreateRequest) XXX_Unmarshal(b []byte) error

type CreateResponse 

type CreateResponse struct {
	Object *Object `protobuf:"bytes,1,opt,name=object,proto3" json:"object,omitempty"`
}

func (*CreateResponse) Descriptor 

func (*CreateResponse) Descriptor() ([]byte, []int)

func (*CreateResponse) GetObject 

func (m *CreateResponse) GetObject() *Object

func (*CreateResponse) Marshal 

func (m *CreateResponse) Marshal() (dAtA []byte, err error)

func (*CreateResponse) MarshalTo 

func (m *CreateResponse) MarshalTo(dAtA []byte) (int, error)

func (*CreateResponse) MarshalToSizedBuffer 

func (m *CreateResponse) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*CreateResponse) ProtoMessage 

func (*CreateResponse) ProtoMessage()

func (*CreateResponse) Reset 

func (m *CreateResponse) Reset()

func (*CreateResponse) Size 

func (m *CreateResponse) Size() (n int)

func (*CreateResponse) String 

func (m *CreateResponse) String() string

func (*CreateResponse) Unmarshal 

func (m *CreateResponse) Unmarshal(dAtA []byte) error

func (*CreateResponse) XXX_DiscardUnknown 

func (m *CreateResponse) XXX_DiscardUnknown()

func (*CreateResponse) XXX_Marshal 

func (m *CreateResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*CreateResponse) XXX_Merge 

func (m *CreateResponse) XXX_Merge(src proto.Message)

func (*CreateResponse) XXX_Size 

func (m *CreateResponse) XXX_Size() int

func (*CreateResponse) XXX_Unmarshal 

func (m *CreateResponse) XXX_Unmarshal(b []byte) error

type DeleteRequest 

type DeleteRequest struct {
	ID ID `protobuf:"bytes,1,opt,name=id,proto3,casttype=ID" json:"id,omitempty"`
}

func (*DeleteRequest) Descriptor 

func (*DeleteRequest) Descriptor() ([]byte, []int)

func (*DeleteRequest) GetID 

func (m *DeleteRequest) GetID() ID

func (*DeleteRequest) Marshal 

func (m *DeleteRequest) Marshal() (dAtA []byte, err error)

func (*DeleteRequest) MarshalTo 

func (m *DeleteRequest) MarshalTo(dAtA []byte) (int, error)

func (*DeleteRequest) MarshalToSizedBuffer 

func (m *DeleteRequest) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*DeleteRequest) ProtoMessage 

func (*DeleteRequest) ProtoMessage()

func (*DeleteRequest) Reset 

func (m *DeleteRequest) Reset()

func (*DeleteRequest) Size 

func (m *DeleteRequest) Size() (n int)

func (*DeleteRequest) String 

func (m *DeleteRequest) String() string

func (*DeleteRequest) Unmarshal 

func (m *DeleteRequest) Unmarshal(dAtA []byte) error

func (*DeleteRequest) XXX_DiscardUnknown 

func (m *DeleteRequest) XXX_DiscardUnknown()

func (*DeleteRequest) XXX_Marshal 

func (m *DeleteRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*DeleteRequest) XXX_Merge 

func (m *DeleteRequest) XXX_Merge(src proto.Message)

func (*DeleteRequest) XXX_Size 

func (m *DeleteRequest) XXX_Size() int

func (*DeleteRequest) XXX_Unmarshal 

func (m *DeleteRequest) XXX_Unmarshal(b []byte) error

type DeleteResponse 

type DeleteResponse struct {
}

func (*DeleteResponse) Descriptor 

func (*DeleteResponse) Descriptor() ([]byte, []int)

func (*DeleteResponse) Marshal 

func (m *DeleteResponse) Marshal() (dAtA []byte, err error)

func (*DeleteResponse) MarshalTo 

func (m *DeleteResponse) MarshalTo(dAtA []byte) (int, error)

func (*DeleteResponse) MarshalToSizedBuffer 

func (m *DeleteResponse) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*DeleteResponse) ProtoMessage 

func (*DeleteResponse) ProtoMessage()

func (*DeleteResponse) Reset 

func (m *DeleteResponse) Reset()

func (*DeleteResponse) Size 

func (m *DeleteResponse) Size() (n int)

func (*DeleteResponse) String 

func (m *DeleteResponse) String() string

func (*DeleteResponse) Unmarshal 

func (m *DeleteResponse) Unmarshal(dAtA []byte) error

func (*DeleteResponse) XXX_DiscardUnknown 

func (m *DeleteResponse) XXX_DiscardUnknown()

func (*DeleteResponse) XXX_Marshal 

func (m *DeleteResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*DeleteResponse) XXX_Merge 

func (m *DeleteResponse) XXX_Merge(src proto.Message)

func (*DeleteResponse) XXX_Size 

func (m *DeleteResponse) XXX_Size() int

func (*DeleteResponse) XXX_Unmarshal 

func (m *DeleteResponse) XXX_Unmarshal(b []byte) error

type Entity 

type Entity struct {
	// user-defined entity kind
	KindID    ID               `protobuf:"bytes,1,opt,name=kind_id,json=kindId,proto3,casttype=ID" json:"kind_id,omitempty"`
	Protocols []*ProtocolState `protobuf:"bytes,2,rep,name=protocols,proto3" json:"protocols,omitempty"`
}

Entity represents any "thing" that is represented in the topology

func (*Entity) Descriptor 

func (*Entity) Descriptor() ([]byte, []int)

func (*Entity) GetKindID 

func (m *Entity) GetKindID() ID

func (*Entity) GetProtocols 

func (m *Entity) GetProtocols() []*ProtocolState

func (*Entity) Marshal 

func (m *Entity) Marshal() (dAtA []byte, err error)

func (*Entity) MarshalTo 

func (m *Entity) MarshalTo(dAtA []byte) (int, error)

func (*Entity) MarshalToSizedBuffer 

func (m *Entity) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*Entity) ProtoMessage 

func (*Entity) ProtoMessage()

func (*Entity) Reset 

func (m *Entity) Reset()

func (*Entity) Size 

func (m *Entity) Size() (n int)

func (*Entity) String 

func (m *Entity) String() string

func (*Entity) Unmarshal 

func (m *Entity) Unmarshal(dAtA []byte) error

func (*Entity) XXX_DiscardUnknown 

func (m *Entity) XXX_DiscardUnknown()

func (*Entity) XXX_Marshal 

func (m *Entity) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Entity) XXX_Merge 

func (m *Entity) XXX_Merge(src proto.Message)

func (*Entity) XXX_Size 

func (m *Entity) XXX_Size() int

func (*Entity) XXX_Unmarshal 

func (m *Entity) XXX_Unmarshal(b []byte) error

type Event 

type Event struct {
	Type   EventType `protobuf:"varint,1,opt,name=type,proto3,enum=onos.topo.EventType" json:"type,omitempty"`
	Object Object    `protobuf:"bytes,2,opt,name=object,proto3" json:"object"`
}

Event is a topo operation event

func (*Event) Descriptor 

func (*Event) Descriptor() ([]byte, []int)

func (*Event) GetObject 

func (m *Event) GetObject() Object

func (*Event) GetType 

func (m *Event) GetType() EventType

func (*Event) Marshal 

func (m *Event) Marshal() (dAtA []byte, err error)

func (*Event) MarshalTo 

func (m *Event) MarshalTo(dAtA []byte) (int, error)

func (*Event) MarshalToSizedBuffer 

func (m *Event) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*Event) ProtoMessage 

func (*Event) ProtoMessage()

func (*Event) Reset 

func (m *Event) Reset()

func (*Event) Size 

func (m *Event) Size() (n int)

func (*Event) String 

func (m *Event) String() string

func (*Event) Unmarshal 

func (m *Event) Unmarshal(dAtA []byte) error

func (*Event) XXX_DiscardUnknown 

func (m *Event) XXX_DiscardUnknown()

func (*Event) XXX_Marshal 

func (m *Event) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Event) XXX_Merge 

func (m *Event) XXX_Merge(src proto.Message)

func (*Event) XXX_Size 

func (m *Event) XXX_Size() int

func (*Event) XXX_Unmarshal 

func (m *Event) XXX_Unmarshal(b []byte) error

type EventType 

type EventType int32

EventType is a topo operation event type 

const (
	EventType_NONE    EventType = 0
	EventType_ADDED   EventType = 1
	EventType_UPDATED EventType = 2
	EventType_REMOVED EventType = 3
)

func (EventType) EnumDescriptor 

func (EventType) EnumDescriptor() ([]byte, []int)

func (EventType) String 

func (x EventType) String() string

type GetRequest 

type GetRequest struct {
	ID ID `protobuf:"bytes,1,opt,name=id,proto3,casttype=ID" json:"id,omitempty"`
}

func (*GetRequest) Descriptor 

func (*GetRequest) Descriptor() ([]byte, []int)

func (*GetRequest) GetID 

func (m *GetRequest) GetID() ID

func (*GetRequest) Marshal 

func (m *GetRequest) Marshal() (dAtA []byte, err error)

func (*GetRequest) MarshalTo 

func (m *GetRequest) MarshalTo(dAtA []byte) (int, error)

func (*GetRequest) MarshalToSizedBuffer 

func (m *GetRequest) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*GetRequest) ProtoMessage 

func (*GetRequest) ProtoMessage()

func (*GetRequest) Reset 

func (m *GetRequest) Reset()

func (*GetRequest) Size 

func (m *GetRequest) Size() (n int)

func (*GetRequest) String 

func (m *GetRequest) String() string

func (*GetRequest) Unmarshal 

func (m *GetRequest) Unmarshal(dAtA []byte) error

func (*GetRequest) XXX_DiscardUnknown 

func (m *GetRequest) XXX_DiscardUnknown()

func (*GetRequest) XXX_Marshal 

func (m *GetRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*GetRequest) XXX_Merge 

func (m *GetRequest) XXX_Merge(src proto.Message)

func (*GetRequest) XXX_Size 

func (m *GetRequest) XXX_Size() int

func (*GetRequest) XXX_Unmarshal 

func (m *GetRequest) XXX_Unmarshal(b []byte) error

type GetResponse 

type GetResponse struct {
	Object *Object `protobuf:"bytes,1,opt,name=object,proto3" json:"object,omitempty"`
}

func (*GetResponse) Descriptor 

func (*GetResponse) Descriptor() ([]byte, []int)

func (*GetResponse) GetObject 

func (m *GetResponse) GetObject() *Object

func (*GetResponse) Marshal 

func (m *GetResponse) Marshal() (dAtA []byte, err error)

func (*GetResponse) MarshalTo 

func (m *GetResponse) MarshalTo(dAtA []byte) (int, error)

func (*GetResponse) MarshalToSizedBuffer 

func (m *GetResponse) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*GetResponse) ProtoMessage 

func (*GetResponse) ProtoMessage()

func (*GetResponse) Reset 

func (m *GetResponse) Reset()

func (*GetResponse) Size 

func (m *GetResponse) Size() (n int)

func (*GetResponse) String 

func (m *GetResponse) String() string

func (*GetResponse) Unmarshal 

func (m *GetResponse) Unmarshal(dAtA []byte) error

func (*GetResponse) XXX_DiscardUnknown 

func (m *GetResponse) XXX_DiscardUnknown()

func (*GetResponse) XXX_Marshal 

func (m *GetResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*GetResponse) XXX_Merge 

func (m *GetResponse) XXX_Merge(src proto.Message)

func (*GetResponse) XXX_Size 

func (m *GetResponse) XXX_Size() int

func (*GetResponse) XXX_Unmarshal 

func (m *GetResponse) XXX_Unmarshal(b []byte) error

type ID 

type ID string

ID ...

type Kind 

type Kind struct {
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Map of attributes and their default values for this Kind
	Attributes map[string]string `` /* 161-byte string literal not displayed */
}

func (*Kind) Descriptor 

func (*Kind) Descriptor() ([]byte, []int)

func (*Kind) GetAttributes 

func (m *Kind) GetAttributes() map[string]string

func (*Kind) GetName 

func (m *Kind) GetName() string

func (*Kind) Marshal 

func (m *Kind) Marshal() (dAtA []byte, err error)

func (*Kind) MarshalTo 

func (m *Kind) MarshalTo(dAtA []byte) (int, error)

func (*Kind) MarshalToSizedBuffer 

func (m *Kind) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*Kind) ProtoMessage 

func (*Kind) ProtoMessage()

func (*Kind) Reset 

func (m *Kind) Reset()

func (*Kind) Size 

func (m *Kind) Size() (n int)

func (*Kind) String 

func (m *Kind) String() string

func (*Kind) Unmarshal 

func (m *Kind) Unmarshal(dAtA []byte) error

func (*Kind) XXX_DiscardUnknown 

func (m *Kind) XXX_DiscardUnknown()

func (*Kind) XXX_Marshal 

func (m *Kind) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Kind) XXX_Merge 

func (m *Kind) XXX_Merge(src proto.Message)

func (*Kind) XXX_Size 

func (m *Kind) XXX_Size() int

func (*Kind) XXX_Unmarshal 

func (m *Kind) XXX_Unmarshal(b []byte) error

type ListRequest 

type ListRequest struct {
}

func (*ListRequest) Descriptor 

func (*ListRequest) Descriptor() ([]byte, []int)

func (*ListRequest) Marshal 

func (m *ListRequest) Marshal() (dAtA []byte, err error)

func (*ListRequest) MarshalTo 

func (m *ListRequest) MarshalTo(dAtA []byte) (int, error)

func (*ListRequest) MarshalToSizedBuffer 

func (m *ListRequest) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*ListRequest) ProtoMessage 

func (*ListRequest) ProtoMessage()

func (*ListRequest) Reset 

func (m *ListRequest) Reset()

func (*ListRequest) Size 

func (m *ListRequest) Size() (n int)

func (*ListRequest) String 

func (m *ListRequest) String() string

func (*ListRequest) Unmarshal 

func (m *ListRequest) Unmarshal(dAtA []byte) error

func (*ListRequest) XXX_DiscardUnknown 

func (m *ListRequest) XXX_DiscardUnknown()

func (*ListRequest) XXX_Marshal 

func (m *ListRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ListRequest) XXX_Merge 

func (m *ListRequest) XXX_Merge(src proto.Message)

func (*ListRequest) XXX_Size 

func (m *ListRequest) XXX_Size() int

func (*ListRequest) XXX_Unmarshal 

func (m *ListRequest) XXX_Unmarshal(b []byte) error

type ListResponse 

type ListResponse struct {
	Objects []Object `protobuf:"bytes,1,rep,name=objects,proto3" json:"objects"`
}

func (*ListResponse) Descriptor 

func (*ListResponse) Descriptor() ([]byte, []int)

func (*ListResponse) GetObjects 

func (m *ListResponse) GetObjects() []Object

func (*ListResponse) Marshal 

func (m *ListResponse) Marshal() (dAtA []byte, err error)

func (*ListResponse) MarshalTo 

func (m *ListResponse) MarshalTo(dAtA []byte) (int, error)

func (*ListResponse) MarshalToSizedBuffer 

func (m *ListResponse) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*ListResponse) ProtoMessage 

func (*ListResponse) ProtoMessage()

func (*ListResponse) Reset 

func (m *ListResponse) Reset()

func (*ListResponse) Size 

func (m *ListResponse) Size() (n int)

func (*ListResponse) String 

func (m *ListResponse) String() string

func (*ListResponse) Unmarshal 

func (m *ListResponse) Unmarshal(dAtA []byte) error

func (*ListResponse) XXX_DiscardUnknown 

func (m *ListResponse) XXX_DiscardUnknown()

func (*ListResponse) XXX_Marshal 

func (m *ListResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ListResponse) XXX_Merge 

func (m *ListResponse) XXX_Merge(src proto.Message)

func (*ListResponse) XXX_Size 

func (m *ListResponse) XXX_Size() int

func (*ListResponse) XXX_Unmarshal 

func (m *ListResponse) XXX_Unmarshal(b []byte) error

type Object 

type Object struct {
	ID       ID          `protobuf:"bytes,1,opt,name=id,proto3,casttype=ID" json:"id,omitempty"`
	Revision Revision    `protobuf:"varint,2,opt,name=revision,proto3,casttype=Revision" json:"revision,omitempty"`
	Type     Object_Type `protobuf:"varint,3,opt,name=type,proto3,enum=onos.topo.Object_Type" json:"type,omitempty"`
	// Types that are valid to be assigned to Obj:
	//	*Object_Entity
	//	*Object_Relation
	//	*Object_Kind
	Obj        isObject_Obj      `protobuf_oneof:"obj"`
	Attributes map[string]string `` /* 161-byte string literal not displayed */
}

func (*Object) Descriptor 

func (*Object) Descriptor() ([]byte, []int)

func (*Object) GetAttributes 

func (m *Object) GetAttributes() map[string]string

func (*Object) GetEntity 

func (m *Object) GetEntity() *Entity

func (*Object) GetID 

func (m *Object) GetID() ID

func (*Object) GetKind 

func (m *Object) GetKind() *Kind

func (*Object) GetObj 

func (m *Object) GetObj() isObject_Obj

func (*Object) GetRelation 

func (m *Object) GetRelation() *Relation

func (*Object) GetRevision 

func (m *Object) GetRevision() Revision

func (*Object) GetType 

func (m *Object) GetType() Object_Type

func (*Object) Marshal 

func (m *Object) Marshal() (dAtA []byte, err error)

func (*Object) MarshalTo 

func (m *Object) MarshalTo(dAtA []byte) (int, error)

func (*Object) MarshalToSizedBuffer 

func (m *Object) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*Object) ProtoMessage 

func (*Object) ProtoMessage()

func (*Object) Reset 

func (m *Object) Reset()

func (*Object) Size 

func (m *Object) Size() (n int)

func (*Object) String 

func (m *Object) String() string

func (*Object) Unmarshal 

func (m *Object) Unmarshal(dAtA []byte) error

func (*Object) XXX_DiscardUnknown 

func (m *Object) XXX_DiscardUnknown()

func (*Object) XXX_Marshal 

func (m *Object) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Object) XXX_Merge 

func (m *Object) XXX_Merge(src proto.Message)

func (*Object) XXX_OneofWrappers 

func (*Object) XXX_OneofWrappers() []interface{}

XXX_OneofWrappers is for the internal use of the proto package.

func (*Object) XXX_Size 

func (m *Object) XXX_Size() int

func (*Object) XXX_Unmarshal 

func (m *Object) XXX_Unmarshal(b []byte) error

type Object_Entity 

type Object_Entity struct {
	Entity *Entity `protobuf:"bytes,4,opt,name=entity,proto3,oneof" json:"entity,omitempty"`
}

func (*Object_Entity) MarshalTo 

func (m *Object_Entity) MarshalTo(dAtA []byte) (int, error)

func (*Object_Entity) MarshalToSizedBuffer 

func (m *Object_Entity) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*Object_Entity) Size 

func (m *Object_Entity) Size() (n int)

type Object_Kind 

type Object_Kind struct {
	Kind *Kind `protobuf:"bytes,6,opt,name=kind,proto3,oneof" json:"kind,omitempty"`
}

func (*Object_Kind) MarshalTo 

func (m *Object_Kind) MarshalTo(dAtA []byte) (int, error)

func (*Object_Kind) MarshalToSizedBuffer 

func (m *Object_Kind) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*Object_Kind) Size 

func (m *Object_Kind) Size() (n int)

type Object_Relation 

type Object_Relation struct {
	Relation *Relation `protobuf:"bytes,5,opt,name=relation,proto3,oneof" json:"relation,omitempty"`
}

func (*Object_Relation) MarshalTo 

func (m *Object_Relation) MarshalTo(dAtA []byte) (int, error)

func (*Object_Relation) MarshalToSizedBuffer 

func (m *Object_Relation) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*Object_Relation) Size 

func (m *Object_Relation) Size() (n int)

type Object_Type 

type Object_Type int32
const (
	Object_UNSPECIFIED Object_Type = 0
	Object_ENTITY      Object_Type = 1
	Object_RELATION    Object_Type = 2
	Object_KIND        Object_Type = 3
)

func (Object_Type) EnumDescriptor 

func (Object_Type) EnumDescriptor() ([]byte, []int)

func (Object_Type) String 

func (x Object_Type) String() string

type Protocol 

type Protocol int32

Protocol to interact with a device 

const (
	//UNKNOWN_PROTOCOL constant needed to go around proto3 nullifying the 0 values
	Protocol_UNKNOWN_PROTOCOL Protocol = 0
	// GNMI protocol reference
	Protocol_GNMI Protocol = 1
	// P4RUNTIME protocol reference
	Protocol_P4RUNTIME Protocol = 2
	// GNOI protocol reference
	Protocol_GNOI Protocol = 3
	// E2 Control Plane Protocol
	Protocol_E2AP Protocol = 4
)

func (Protocol) EnumDescriptor 

func (Protocol) EnumDescriptor() ([]byte, []int)

func (Protocol) String 

func (x Protocol) String() string

type ProtocolState 

type ProtocolState struct {
	//The protocol to which state relates
	Protocol Protocol `protobuf:"varint,1,opt,name=protocol,proto3,enum=onos.topo.Protocol" json:"protocol,omitempty"`
	//ConnectivityState contains the L3 connectivity information
	ConnectivityState ConnectivityState `protobuf:"varint,2,opt,name=connectivityState,proto3,enum=onos.topo.ConnectivityState" json:"connectivityState,omitempty"`
	//ChannelState relates to the availability of the gRPC channel
	ChannelState ChannelState `protobuf:"varint,3,opt,name=channelState,proto3,enum=onos.topo.ChannelState" json:"channelState,omitempty"`
	//ServiceState indicates the availability of the gRPC servic on top of the channel
	ServiceState ServiceState `protobuf:"varint,4,opt,name=serviceState,proto3,enum=onos.topo.ServiceState" json:"serviceState,omitempty"`
}

ProtocolState contains information related to service and connectivity to a device

func (*ProtocolState) Descriptor 

func (*ProtocolState) Descriptor() ([]byte, []int)

func (*ProtocolState) GetChannelState 

func (m *ProtocolState) GetChannelState() ChannelState

func (*ProtocolState) GetConnectivityState 

func (m *ProtocolState) GetConnectivityState() ConnectivityState

func (*ProtocolState) GetProtocol 

func (m *ProtocolState) GetProtocol() Protocol

func (*ProtocolState) GetServiceState 

func (m *ProtocolState) GetServiceState() ServiceState

func (*ProtocolState) Marshal 

func (m *ProtocolState) Marshal() (dAtA []byte, err error)

func (*ProtocolState) MarshalTo 

func (m *ProtocolState) MarshalTo(dAtA []byte) (int, error)

func (*ProtocolState) MarshalToSizedBuffer 

func (m *ProtocolState) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*ProtocolState) ProtoMessage 

func (*ProtocolState) ProtoMessage()

func (*ProtocolState) Reset 

func (m *ProtocolState) Reset()

func (*ProtocolState) Size 

func (m *ProtocolState) Size() (n int)

func (*ProtocolState) String 

func (m *ProtocolState) String() string

func (*ProtocolState) Unmarshal 

func (m *ProtocolState) Unmarshal(dAtA []byte) error

func (*ProtocolState) XXX_DiscardUnknown 

func (m *ProtocolState) XXX_DiscardUnknown()

func (*ProtocolState) XXX_Marshal 

func (m *ProtocolState) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ProtocolState) XXX_Merge 

func (m *ProtocolState) XXX_Merge(src proto.Message)

func (*ProtocolState) XXX_Size 

func (m *ProtocolState) XXX_Size() int

func (*ProtocolState) XXX_Unmarshal 

func (m *ProtocolState) XXX_Unmarshal(b []byte) error

type Relation 

type Relation struct {
	// user defined relation kind
	KindID      ID `protobuf:"bytes,1,opt,name=kind_id,json=kindId,proto3,casttype=ID" json:"kind_id,omitempty"`
	SrcEntityID ID `protobuf:"bytes,2,opt,name=src_entity_id,json=srcEntityId,proto3,casttype=ID" json:"src_entity_id,omitempty"`
	TgtEntityID ID `protobuf:"bytes,3,opt,name=tgt_entity_id,json=tgtEntityId,proto3,casttype=ID" json:"tgt_entity_id,omitempty"`
}

func (*Relation) Descriptor 

func (*Relation) Descriptor() ([]byte, []int)

func (*Relation) GetKindID 

func (m *Relation) GetKindID() ID

func (*Relation) GetSrcEntityID 

func (m *Relation) GetSrcEntityID() ID

func (*Relation) GetTgtEntityID 

func (m *Relation) GetTgtEntityID() ID

func (*Relation) Marshal 

func (m *Relation) Marshal() (dAtA []byte, err error)

func (*Relation) MarshalTo 

func (m *Relation) MarshalTo(dAtA []byte) (int, error)

func (*Relation) MarshalToSizedBuffer 

func (m *Relation) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*Relation) ProtoMessage 

func (*Relation) ProtoMessage()

func (*Relation) Reset 

func (m *Relation) Reset()

func (*Relation) Size 

func (m *Relation) Size() (n int)

func (*Relation) String 

func (m *Relation) String() string

func (*Relation) Unmarshal 

func (m *Relation) Unmarshal(dAtA []byte) error

func (*Relation) XXX_DiscardUnknown 

func (m *Relation) XXX_DiscardUnknown()

func (*Relation) XXX_Marshal 

func (m *Relation) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Relation) XXX_Merge 

func (m *Relation) XXX_Merge(src proto.Message)

func (*Relation) XXX_Size 

func (m *Relation) XXX_Size() int

func (*Relation) XXX_Unmarshal 

func (m *Relation) XXX_Unmarshal(b []byte) error

type Revision 

type Revision uint64

Revision is an object revision

type ServiceState 

type ServiceState int32

ServiceState represents the state of the gRPC service (e.g. gNMI) to the device from the service container 

const (
	//UNKNOWN_SERVICE_STATE constant needed to go around proto3 nullifying the 0 values
	ServiceState_UNKNOWN_SERVICE_STATE ServiceState = 0
	// AVAILABLE indicates the corresponding grpc service is available
	ServiceState_AVAILABLE ServiceState = 1
	// UNAVAILABLE indicates the corresponding grpc service is not available
	ServiceState_UNAVAILABLE ServiceState = 2
	// CONNECTING indicates the corresponding protocol is in the connecting phase on this device
	ServiceState_CONNECTING ServiceState = 3
)

func (ServiceState) EnumDescriptor 

func (ServiceState) EnumDescriptor() ([]byte, []int)

func (ServiceState) String 

func (x ServiceState) String() string

type TopoClient 

type TopoClient interface {
	// Create a new topology object
	Create(ctx context.Context, in *CreateRequest, opts ...grpc.CallOption) (*CreateResponse, error)
	// Get an object from topology
	Get(ctx context.Context, in *GetRequest, opts ...grpc.CallOption) (*GetResponse, error)
	// Update an existing topology object
	Update(ctx context.Context, in *UpdateRequest, opts ...grpc.CallOption) (*UpdateResponse, error)
	// Delete an object from topology
	Delete(ctx context.Context, in *DeleteRequest, opts ...grpc.CallOption) (*DeleteResponse, error)
	// List gets a stream of requested objects
	List(ctx context.Context, in *ListRequest, opts ...grpc.CallOption) (*ListResponse, error)
	// Watch returns a stream of topo change notifications
	Watch(ctx context.Context, in *WatchRequest, opts ...grpc.CallOption) (Topo_WatchClient, error)
}

TopoClient is the client API for Topo service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func CreateTopoClient 

func CreateTopoClient(cc *grpc.ClientConn) TopoClient

CreateTopoClient creates and returns a new topo device client

func NewTopoClient 

func NewTopoClient(cc *grpc.ClientConn) TopoClient

type TopoServer 

type TopoServer interface {
	// Create a new topology object
	Create(context.Context, *CreateRequest) (*CreateResponse, error)
	// Get an object from topology
	Get(context.Context, *GetRequest) (*GetResponse, error)
	// Update an existing topology object
	Update(context.Context, *UpdateRequest) (*UpdateResponse, error)
	// Delete an object from topology
	Delete(context.Context, *DeleteRequest) (*DeleteResponse, error)
	// List gets a stream of requested objects
	List(context.Context, *ListRequest) (*ListResponse, error)
	// Watch returns a stream of topo change notifications
	Watch(*WatchRequest, Topo_WatchServer) error
}

TopoServer is the server API for Topo service.

type Topo_WatchClient 

type Topo_WatchClient interface {
	Recv() (*WatchResponse, error)
	grpc.ClientStream
}

type Topo_WatchServer 

type Topo_WatchServer interface {
	Send(*WatchResponse) error
	grpc.ServerStream
}

type UnimplementedTopoServer 

type UnimplementedTopoServer struct {
}

UnimplementedTopoServer can be embedded to have forward compatible implementations.

func (*UnimplementedTopoServer) Create 

func (*UnimplementedTopoServer) Create(ctx context.Context, req *CreateRequest) (*CreateResponse, error)

func (*UnimplementedTopoServer) Delete 

func (*UnimplementedTopoServer) Delete(ctx context.Context, req *DeleteRequest) (*DeleteResponse, error)

func (*UnimplementedTopoServer) Get 

func (*UnimplementedTopoServer) Get(ctx context.Context, req *GetRequest) (*GetResponse, error)

func (*UnimplementedTopoServer) List 

func (*UnimplementedTopoServer) List(ctx context.Context, req *ListRequest) (*ListResponse, error)

func (*UnimplementedTopoServer) Update 

func (*UnimplementedTopoServer) Update(ctx context.Context, req *UpdateRequest) (*UpdateResponse, error)

func (*UnimplementedTopoServer) Watch 

func (*UnimplementedTopoServer) Watch(req *WatchRequest, srv Topo_WatchServer) error

type UpdateRequest 

type UpdateRequest struct {
	Object *Object `protobuf:"bytes,1,opt,name=object,proto3" json:"object,omitempty"`
}

func (*UpdateRequest) Descriptor 

func (*UpdateRequest) Descriptor() ([]byte, []int)

func (*UpdateRequest) GetObject 

func (m *UpdateRequest) GetObject() *Object

func (*UpdateRequest) Marshal 

func (m *UpdateRequest) Marshal() (dAtA []byte, err error)

func (*UpdateRequest) MarshalTo 

func (m *UpdateRequest) MarshalTo(dAtA []byte) (int, error)

func (*UpdateRequest) MarshalToSizedBuffer 

func (m *UpdateRequest) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*UpdateRequest) ProtoMessage 

func (*UpdateRequest) ProtoMessage()

func (*UpdateRequest) Reset 

func (m *UpdateRequest) Reset()

func (*UpdateRequest) Size 

func (m *UpdateRequest) Size() (n int)

func (*UpdateRequest) String 

func (m *UpdateRequest) String() string

func (*UpdateRequest) Unmarshal 

func (m *UpdateRequest) Unmarshal(dAtA []byte) error

func (*UpdateRequest) XXX_DiscardUnknown 

func (m *UpdateRequest) XXX_DiscardUnknown()

func (*UpdateRequest) XXX_Marshal 

func (m *UpdateRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*UpdateRequest) XXX_Merge 

func (m *UpdateRequest) XXX_Merge(src proto.Message)

func (*UpdateRequest) XXX_Size 

func (m *UpdateRequest) XXX_Size() int

func (*UpdateRequest) XXX_Unmarshal 

func (m *UpdateRequest) XXX_Unmarshal(b []byte) error

type UpdateResponse 

type UpdateResponse struct {
	Object *Object `protobuf:"bytes,1,opt,name=object,proto3" json:"object,omitempty"`
}

func (*UpdateResponse) Descriptor 

func (*UpdateResponse) Descriptor() ([]byte, []int)

func (*UpdateResponse) GetObject 

func (m *UpdateResponse) GetObject() *Object

func (*UpdateResponse) Marshal 

func (m *UpdateResponse) Marshal() (dAtA []byte, err error)

func (*UpdateResponse) MarshalTo 

func (m *UpdateResponse) MarshalTo(dAtA []byte) (int, error)

func (*UpdateResponse) MarshalToSizedBuffer 

func (m *UpdateResponse) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*UpdateResponse) ProtoMessage 

func (*UpdateResponse) ProtoMessage()

func (*UpdateResponse) Reset 

func (m *UpdateResponse) Reset()

func (*UpdateResponse) Size 

func (m *UpdateResponse) Size() (n int)

func (*UpdateResponse) String 

func (m *UpdateResponse) String() string

func (*UpdateResponse) Unmarshal 

func (m *UpdateResponse) Unmarshal(dAtA []byte) error

func (*UpdateResponse) XXX_DiscardUnknown 

func (m *UpdateResponse) XXX_DiscardUnknown()

func (*UpdateResponse) XXX_Marshal 

func (m *UpdateResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*UpdateResponse) XXX_Merge 

func (m *UpdateResponse) XXX_Merge(src proto.Message)

func (*UpdateResponse) XXX_Size 

func (m *UpdateResponse) XXX_Size() int

func (*UpdateResponse) XXX_Unmarshal 

func (m *UpdateResponse) XXX_Unmarshal(b []byte) error

type WatchRequest 

type WatchRequest struct {
	Noreplay bool `protobuf:"varint,2,opt,name=noreplay,proto3" json:"noreplay,omitempty"`
}

func (*WatchRequest) Descriptor 

func (*WatchRequest) Descriptor() ([]byte, []int)

func (*WatchRequest) GetNoreplay 

func (m *WatchRequest) GetNoreplay() bool

func (*WatchRequest) Marshal 

func (m *WatchRequest) Marshal() (dAtA []byte, err error)

func (*WatchRequest) MarshalTo 

func (m *WatchRequest) MarshalTo(dAtA []byte) (int, error)

func (*WatchRequest) MarshalToSizedBuffer 

func (m *WatchRequest) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*WatchRequest) ProtoMessage 

func (*WatchRequest) ProtoMessage()

func (*WatchRequest) Reset 

func (m *WatchRequest) Reset()

func (*WatchRequest) Size 

func (m *WatchRequest) Size() (n int)

func (*WatchRequest) String 

func (m *WatchRequest) String() string

func (*WatchRequest) Unmarshal 

func (m *WatchRequest) Unmarshal(dAtA []byte) error

func (*WatchRequest) XXX_DiscardUnknown 

func (m *WatchRequest) XXX_DiscardUnknown()

func (*WatchRequest) XXX_Marshal 

func (m *WatchRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*WatchRequest) XXX_Merge 

func (m *WatchRequest) XXX_Merge(src proto.Message)

func (*WatchRequest) XXX_Size 

func (m *WatchRequest) XXX_Size() int

func (*WatchRequest) XXX_Unmarshal 

func (m *WatchRequest) XXX_Unmarshal(b []byte) error

type WatchResponse 

type WatchResponse struct {
	Event Event `protobuf:"bytes,1,opt,name=event,proto3" json:"event"`
}

func (*WatchResponse) Descriptor 

func (*WatchResponse) Descriptor() ([]byte, []int)

func (*WatchResponse) GetEvent 

func (m *WatchResponse) GetEvent() Event

func (*WatchResponse) Marshal 

func (m *WatchResponse) Marshal() (dAtA []byte, err error)

func (*WatchResponse) MarshalTo 

func (m *WatchResponse) MarshalTo(dAtA []byte) (int, error)

func (*WatchResponse) MarshalToSizedBuffer 

func (m *WatchResponse) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*WatchResponse) ProtoMessage 

func (*WatchResponse) ProtoMessage()

func (*WatchResponse) Reset 

func (m *WatchResponse) Reset()

func (*WatchResponse) Size 

func (m *WatchResponse) Size() (n int)

func (*WatchResponse) String 

func (m *WatchResponse) String() string

func (*WatchResponse) Unmarshal 

func (m *WatchResponse) Unmarshal(dAtA []byte) error

func (*WatchResponse) XXX_DiscardUnknown 

func (m *WatchResponse) XXX_DiscardUnknown()

func (*WatchResponse) XXX_Marshal 

func (m *WatchResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*WatchResponse) XXX_Merge 

func (m *WatchResponse) XXX_Merge(src proto.Message)

func (*WatchResponse) XXX_Size 

func (m *WatchResponse) XXX_Size() int

func (*WatchResponse) XXX_Unmarshal 

func (m *WatchResponse) XXX_Unmarshal(b []byte) error

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.