org.opennms.features.openconfig.proto.gnmi

Class gNMIGrpc.gNMIStub

java.lang.Object

io.grpc.stub.AbstractStub<gNMIGrpc.gNMIStub>

org.opennms.features.openconfig.proto.gnmi.gNMIGrpc.gNMIStub

Enclosing class:

gNMIGrpc

public static final class gNMIGrpc.gNMIStub
extends io.grpc.stub.AbstractStub<gNMIGrpc.gNMIStub>

Nested Class Summary

Nested classes/interfaces inherited from class io.grpc.stub.AbstractStub

io.grpc.stub.AbstractStub.StubFactory<T extends io.grpc.stub.AbstractStub<T>>

Method Summary

Modifier and Type	Method and Description
protected gNMIGrpc.gNMIStub	build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
void	capabilities(Gnmi.CapabilityRequest request, io.grpc.stub.StreamObserver<Gnmi.CapabilityResponse> responseObserver) Capabilities allows the client to retrieve the set of capabilities that is supported by the target.
void	get(Gnmi.GetRequest request, io.grpc.stub.StreamObserver<Gnmi.GetResponse> responseObserver) Retrieve a snapshot of data from the target.
void	set(Gnmi.SetRequest request, io.grpc.stub.StreamObserver<Gnmi.SetResponse> responseObserver) Set allows the client to modify the state of data on the target.
io.grpc.stub.StreamObserver<Gnmi.SubscribeRequest>	subscribe(io.grpc.stub.StreamObserver<Gnmi.SubscribeResponse> responseObserver) Subscribe allows a client to request the target to send it values of particular paths within the data tree.

Methods inherited from class io.grpc.stub.AbstractStub

getCallOptions, getChannel, newStub, newStub, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withExecutor, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOption, withWaitForReady

Methods inherited from class java.lang.Object

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

Method Detail

build

protected gNMIGrpc.gNMIStub build(io.grpc.Channel channel,
                                  io.grpc.CallOptions callOptions)

Specified by:

build in class io.grpc.stub.AbstractStub<gNMIGrpc.gNMIStub>

capabilities

public void capabilities(Gnmi.CapabilityRequest request,
                         io.grpc.stub.StreamObserver<Gnmi.CapabilityResponse> responseObserver)

 Capabilities allows the client to retrieve the set of capabilities that
 is supported by the target. This allows the target to validate the
 service version that is implemented and retrieve the set of models that
 the target supports. The models can then be specified in subsequent RPCs
 to restrict the set of data that is utilized.
 Reference: gNMI Specification Section 3.2
 

get

public void get(Gnmi.GetRequest request,
                io.grpc.stub.StreamObserver<Gnmi.GetResponse> responseObserver)

 Retrieve a snapshot of data from the target. A Get RPC requests that the
 target snapshots a subset of the data tree as specified by the paths
 included in the message and serializes this to be returned to the
 client using the specified encoding.
 Reference: gNMI Specification Section 3.3
 

set

public void set(Gnmi.SetRequest request,
                io.grpc.stub.StreamObserver<Gnmi.SetResponse> responseObserver)

 Set allows the client to modify the state of data on the target. The
 paths to modified along with the new values that the client wishes
 to set the value to.
 Reference: gNMI Specification Section 3.4
 

subscribe

public io.grpc.stub.StreamObserver<Gnmi.SubscribeRequest> subscribe(io.grpc.stub.StreamObserver<Gnmi.SubscribeResponse> responseObserver)

 Subscribe allows a client to request the target to send it values
 of particular paths within the data tree. These values may be streamed
 at a particular cadence (STREAM), sent one off on a long-lived channel
 (POLL), or sent as a one-off retrieval (ONCE).
 Reference: gNMI Specification Section 3.5