Package org.opennms.features.openconfig.proto.gnmi

Class Gnmi

java.lang.Object

org.opennms.features.openconfig.proto.gnmi.Gnmi

public final class Gnmi
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Gnmi.Alias	Alias specifies a data tree path, and an associated string which defines an alias which is to be used for this path in the context of the RPC.
static class	Gnmi.AliasList	AliasList specifies a list of aliases.
static interface	Gnmi.AliasListOrBuilder
static interface	Gnmi.AliasOrBuilder
static class	Gnmi.CapabilityRequest	CapabilityRequest is sent by the client in the Capabilities RPC to request that the target reports its capabilities.
static interface	Gnmi.CapabilityRequestOrBuilder
static class	Gnmi.CapabilityResponse	CapabilityResponse is used by the target to report its capabilities to the client within the Capabilities RPC.
static interface	Gnmi.CapabilityResponseOrBuilder
static class	Gnmi.Decimal64	Decimal64 is used to encode a fixed precision decimal number.
static interface	Gnmi.Decimal64OrBuilder
static class	Gnmi.Encoding	Encoding defines the value encoding formats that are supported by the gNMI protocol.
static class	Gnmi.Error	Deprecated.
static interface	Gnmi.ErrorOrBuilder	Deprecated.
static class	Gnmi.GetRequest	GetRequest is sent when a client initiates a Get RPC.
static interface	Gnmi.GetRequestOrBuilder
static class	Gnmi.GetResponse	GetResponse is used by the target to respond to a GetRequest from a client.
static interface	Gnmi.GetResponseOrBuilder
static class	Gnmi.ModelData	ModelData is used to describe a set of schema modules.
static interface	Gnmi.ModelDataOrBuilder
static class	Gnmi.Notification	Notification is a re-usable message that is used to encode data from the target to the client.
static interface	Gnmi.NotificationOrBuilder
static class	Gnmi.Path	Path encodes a data tree path as a series of repeated strings, with each element of the path representing a data tree node name and the associated attributes.
static class	Gnmi.PathElem	PathElem encodes an element of a gNMI path, along with any attributes (keys) that may be associated with it.
static interface	Gnmi.PathElemOrBuilder
static interface	Gnmi.PathOrBuilder
static class	Gnmi.Poll	Poll is sent within a SubscribeRequest to trigger the device to send telemetry updates for the paths that are associated with the subscription.
static interface	Gnmi.PollOrBuilder
static class	Gnmi.QOSMarking	QOSMarking specifies the DSCP value to be set on transmitted telemetry updates from the target.
static interface	Gnmi.QOSMarkingOrBuilder
static class	Gnmi.ScalarArray	ScalarArray is used to encode a mixed-type array of values.
static interface	Gnmi.ScalarArrayOrBuilder
static class	Gnmi.SetRequest	SetRequest is sent from a client to the target to update values in the data tree.
static interface	Gnmi.SetRequestOrBuilder
static class	Gnmi.SetResponse	SetResponse is the response to a SetRequest, sent from the target to the client.
static interface	Gnmi.SetResponseOrBuilder
static class	Gnmi.SubscribeRequest	SubscribeRequest is the message sent by the client to the target when initiating a subscription to a set of paths within the data tree.
static interface	Gnmi.SubscribeRequestOrBuilder
static class	Gnmi.SubscribeResponse	SubscribeResponse is the message used by the target within a Subscribe RPC.
static interface	Gnmi.SubscribeResponseOrBuilder
static class	Gnmi.Subscription	Subscription is a single request within a SubscriptionList.
static class	Gnmi.SubscriptionList	SubscriptionList is used within a Subscribe message to specify the list of paths that the client wishes to subscribe to.
static interface	Gnmi.SubscriptionListOrBuilder
static class	Gnmi.SubscriptionMode	SubscriptionMode is the mode of the subscription, specifying how the target must return values in a subscription.
static interface	Gnmi.SubscriptionOrBuilder
static class	Gnmi.TypedValue	TypedValue is used to encode a value being sent between the client and target (originated by either entity).
static interface	Gnmi.TypedValueOrBuilder
static class	Gnmi.Update	Update is a re-usable message that is used to store a particular Path, Value pair.
static interface	Gnmi.UpdateOrBuilder
static class	Gnmi.UpdateResult	UpdateResult is used within the SetResponse message to communicate the result of an operation specified within a SetRequest message.
static interface	Gnmi.UpdateResultOrBuilder
static class	Gnmi.Value	Deprecated.
static interface	Gnmi.ValueOrBuilder	Deprecated.

Field Summary

Fields

Modifier and Type	Field	Description
static int	GNMI_SERVICE_FIELD_NUMBER
static com.google.protobuf.GeneratedMessage.GeneratedExtension<com.google.protobuf.DescriptorProtos.FileOptions,String>	gnmiService	The gNMI service semantic version.

Method Summary

Modifier and Type	Method	Description
static com.google.protobuf.Descriptors.FileDescriptor	getDescriptor()
static void	registerAllExtensions(com.google.protobuf.ExtensionRegistry registry)
static void	registerAllExtensions(com.google.protobuf.ExtensionRegistryLite registry)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

GNMI_SERVICE_FIELD_NUMBER

public static final int GNMI_SERVICE_FIELD_NUMBER

See Also:

Constant Field Values

gnmiService

public static final com.google.protobuf.GeneratedMessage.GeneratedExtension<com.google.protobuf.DescriptorProtos.FileOptions,String> gnmiService

 The gNMI service semantic version.
 

extend .google.protobuf.FileOptions { ... }

Method Detail

registerAllExtensions

public static void registerAllExtensions(com.google.protobuf.ExtensionRegistryLite registry)

registerAllExtensions

public static void registerAllExtensions(com.google.protobuf.ExtensionRegistry registry)

getDescriptor

public static com.google.protobuf.Descriptors.FileDescriptor getDescriptor()