# README
Topology Service: Go Bindings
This package provides Go bindings for the gRPC services implemented by the µONOS Topology service.
# Functions
CreateTopoClient creates and returns a new topo device client.
MultiRelationID creates a unique relationship ID from the specified source, kind and target IDs, and also from an additional discriminant to allow for multiples of same kinds of relations between the same two objects.
NewEntity allocates a new topology entity using the specified ID and kind.
NewMockisObject_Obj creates a new mock instance.
NewMockTopo_WatchClient creates a new mock instance.
NewMockTopo_WatchServer creates a new mock instance.
NewMockTopoClient creates a new mock instance.
NewMockTopoServer creates a new mock instance.
NewRelation allocates a new topology relation using the specified source, target, and kind.
No description provided by the author
No description provided by the author
RelationID creates a unique relationship ID from the specified source, kind and target IDs.
ToAny provides a convenience utility to convert an aspect message to protobuf types.Any.
# Constants
DEPRECATED Entity and Relation Kinds.
TODO UPPERCASE entity kinds and relations should be replaced gradually with CamelCase ones.
No description provided by the author
No description provided by the author
CONNECTED indicates the corresponding grpc channel is connected on this device.
DISCONNECTED indicates the corresponding grpc channel is not connected on this device.
UNKNOWN_CHANNEL_STATE constant needed to go around proto3 nullifying the 0 values.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
TODO UPPERCASE entity kinds and relations should be replaced gradually with CamelCase ones.
REACHABLE indicates the the service can reach the device at L3.
UNKNOWN_CONNECTIVITY_STATE constant needed to go around proto3 nullifying the 0 values.
UNREACHABLE indicates the the service can't reach the device at L3.
DEPRECATED Entity and Relation Kinds.
TODO UPPERCASE entity kinds and relations should be replaced gradually with CamelCase ones.
No description provided by the author
TODO UPPERCASE entity kinds and relations should be replaced gradually with CamelCase ones.
Relations.
TODO UPPERCASE entity kinds and relations should be replaced gradually with CamelCase ones.
DEPRECATED Entity and Relation Kinds.
TODO UPPERCASE entity kinds and relations should be replaced gradually with CamelCase ones.
RAN Entities.
RAN Entitiy kinds.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
DEPRECATED Entity and Relation Kinds.
TODO UPPERCASE entity kinds and relations should be replaced gradually with CamelCase ones.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
TODO UPPERCASE entity kinds and relations should be replaced gradually with CamelCase ones.
TODO UPPERCASE entity kinds and relations should be replaced gradually with CamelCase ones.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
TODO UPPERCASE entity kinds and relations should be replaced gradually with CamelCase ones.
No description provided by the author
No description provided by the author
TODO UPPERCASE entity kinds and relations should be replaced gradually with CamelCase ones.
TODO UPPERCASE entity kinds and relations should be replaced gradually with CamelCase ones.
DEPRECATED Entity and Relation Kinds.
TODO UPPERCASE entity kinds and relations should be replaced gradually with CamelCase ones.
No description provided by the author
TODO UPPERCASE entity kinds and relations should be replaced gradually with CamelCase ones.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NullID represents a null/empty/omitted identifier; usually an indicator for system to generate one.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
onos-config entity.
onos-config entity.
TODO UPPERCASE entity kinds and relations should be replaced gradually with CamelCase ones.
Realizes the last saved, but not yet committed, config.
Verifies, saves and realizes the given config, while preserving the forwarding state in the target.
No description provided by the author
Verifies that the target can realize the given config.
Saves and realizes the given config if the P4Runtime target can realize it.
Saves the config if the P4Runtime target can realize it.
Fabric Entity kinds.
TODO UPPERCASE entity kinds and relations should be replaced gradually with CamelCase ones.
E2 Control Plane Protocol.
GNMI protocol reference.
GNOI protocol reference.
P4RUNTIME protocol reference.
UNKNOWN_PROTOCOL constant needed to go around proto3 nullifying the 0 values.
TODO UPPERCASE entity kinds and relations should be replaced gradually with CamelCase ones.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
TODO UPPERCASE entity kinds and relations should be replaced gradually with CamelCase ones.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
TODO UPPERCASE entity kinds and relations should be replaced gradually with CamelCase ones.
TODO UPPERCASE entity kinds and relations should be replaced gradually with CamelCase ones.
AVAILABLE indicates the corresponding grpc service is available.
CONNECTING indicates the corresponding protocol is in the connecting phase on this device.
UNAVAILABLE indicates the corresponding grpc service is not available.
UNKNOWN_SERVICE_STATE constant needed to go around proto3 nullifying the 0 values.
No description provided by the author
No description provided by the author
No description provided by the author
TODO UPPERCASE entity kinds and relations should be replaced gradually with CamelCase ones.
TODO UPPERCASE entity kinds and relations should be replaced gradually with CamelCase ones.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
DEPRECATED Entity and Relation Kinds.
TODO UPPERCASE entity kinds and relations should be replaced gradually with CamelCase ones.
# Variables
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
TopoClientFactory : Default EntityServiceClient creation.
No description provided by the author
No description provided by the author
# Structs
No description provided by the author
No description provided by the author
Aspect for ad-hoc properties.
No description provided by the author
No description provided by the author
Basic asset information.
No description provided by the author
ECEF-compatible cartesian coordinates.
No description provided by the author
Configurable device aspect.
No description provided by the author
No description provided by the author
Controller aspect; represents an instance of the controller deployment.
No description provided by the author
Area of coverage; expected value type of "coverage" aspect.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
E2Cell aspect; expected value type of "E2CELL" aspect and expected on entities of "E2CELL" kind.
No description provided by the author
No description provided by the author
E2Node aspect; expected value type of "E2NODE" aspect and expected on entities of "E2NODE" kind.
E2NodeConfig aspect tracks the managed configuration for an E2 node.
E2TInfo E2T aspect;.
No description provided by the author
Endpoint is a pair of an IP Address or DNS name and a TCP port number.
Entity represents any "thing" that is represented in the topology.
No description provided by the author
Event is a topo operation event.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
DEPRECATED: GNMIServer is an entity aspect tracking gNMI server contact details.
No description provided by the author
No description provided by the author
Interface determines address and type of an endpoint interface.
IPAddress defines an IPv4 or IPv6 address.
Kind represents an archetype of an object, i.e.
No description provided by the author
No description provided by the author
No description provided by the author
Lease aspect with an expiration timestamp for RAN entities.
Link is an aspect carrying basic link information.
DEPRECATED.
DEPRECATED.
LocalAgents is an aspect carrying information required to interact with various Stratum device local agents.
No description provided by the author
No description provided by the author
No description provided by the author
LogicalLink link aspect; represents a link between two physical interfaces.
Aspect for tracking device mastership.
No description provided by the author
No description provided by the author
MockisObject_Obj is a mock of isObject_Obj interface.
MockisObject_ObjMockRecorder is the mock recorder for MockisObject_Obj.
MockTopo_WatchClient is a mock of Topo_WatchClient interface.
MockTopo_WatchClientMockRecorder is the mock recorder for MockTopo_WatchClient.
MockTopo_WatchServer is a mock of Topo_WatchServer interface.
MockTopo_WatchServerMockRecorder is the mock recorder for MockTopo_WatchServer.
MockTopoClient is a mock of TopoClient interface.
MockTopoClientMockRecorder is the mock recorder for MockTopoClient.
MockTopoServer is a mock of TopoServer interface.
MockTopoServerMockRecorder is the mock recorder for MockTopoServer.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NetworkInterface is an aspect carrying basic network interface information.
NetworkLayer aspect; aspect for a NetworkLayer entity with a specific kind.
No description provided by the author
No description provided by the author
Object is an one of the following: a kind (archetype of entity or relation), an entity, a relation.
No description provided by the author
No description provided by the author
No description provided by the author
Minimal satellite orbit data, e.g.
No description provided by the author
No description provided by the author
No description provided by the author
DEPRECATED: P4PipelineInfo p4 pipeline information.
DEPRECATED: P4RTMastershipState mastership state for the P4runtime targets.
DEPRECATED: P4RTServerInfo aspect; specifies the control end point in a programmable device.
DEPRECATED: P4RuntimeServer is an entity aspect tracking P4Runtime server contact details.
PhyInterface aspect; an aspect to represent a physical switch interface.
No description provided by the author
Port is an aspect carrying the basic port information.
Protocols.
ProtocolState contains information related to service and connectivity to a device.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Relation represents any "relation" between two entitites in the topology.
Filter for targets of given relation kinds and given source ids; optionally, filters by specified target kind.
Router aspect; aspect of a ROUTER entity (Layer 3).
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
DEPRECATED: Service service entity which will be used to store mastership state for an application.
No description provided by the author
No description provided by the author
No description provided by the author
StratumAgents is an aspect carrying information required to interact with a Stratum device agents.
Switch aspect; aspect for a SWITCH entity.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
TLS connectivity aspect.
No description provided by the author
No description provided by the author
UnimplementedTopoServer can be embedded to have forward compatible implementations.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
A set of waypoints that can be interpolated.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Interfaces
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
TopoClient is the client API for Topo service.
TopoServer is the server API for Topo service.
# Type aliases
No description provided by the author
ConnectivityState represents the state of a gRPC channel to the device from the service container.
ComponentType is for use in encoding node component type in topo Entity URI identifier; see section 9.2.6 of ORAN E2AP v02.00 spec.
ConnectivityState represents the L3 reachability of a device from the service container (e.g.
No description provided by the author
No description provided by the author
No description provided by the author
EventType is a topo operation event type.
ID represents a client-assigned unique identifier.
No description provided by the author
No description provided by the author
No description provided by the author
NodeType is for use in encoding node type in topo Entity URI identifier; see section 9.2.6 of ORAN E2AP v02.00 spec.
No description provided by the author
No description provided by the author
No description provided by the author
ConfigurationAction.
PolicyTypeDescription describe what this A1 policy is.
PolicyTypeID is an identifier of A1 policy type.
PolicyTypeName is a name of A1 policy type.
PolicyTypeVersion is a version of A1 policy type.
Protocol to interact with a device.
TODO: Deprecate! Use language specific constant definitions instead.
TODO: Deprecate! Use language specific constant definitions instead.
No description provided by the author
Revision is an object revision.
No description provided by the author
No description provided by the author
No description provided by the author
ServiceState represents the state of the gRPC service (e.g.
No description provided by the author
No description provided by the author
UUID represents a system-assigned unique identifier of a topology object.