GnmiClient

All Superinterfaces:

org.onosproject.grpc.api.GrpcClient
```
@Beta
public interface GnmiClient
extends org.onosproject.grpc.api.GrpcClient
```
Client to control a gNMI server.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`java.util.concurrent.CompletableFuture<gnmi.Gnmi.CapabilityResponse>`	`capabilities()`	Gets capability from a target.
`java.util.concurrent.CompletableFuture<gnmi.Gnmi.GetResponse>`	`get(gnmi.Gnmi.GetRequest request)`	Retrieves a snapshot of data from the device.
`java.util.concurrent.CompletableFuture<gnmi.Gnmi.SetResponse>`	`set(gnmi.Gnmi.SetRequest request)`	Modifies the state of data on the device.
`void`	`subscribe(gnmi.Gnmi.SubscribeRequest request)`	Starts a subscription for the given request.
`void`	`unsubscribe()`	Terminates any Subscribe RPC active.

Methods inherited from interface org.onosproject.grpc.api.GrpcClient
isServerReachable, probeService, shutdown

- Method Detail
  - capabilities
```
java.util.concurrent.CompletableFuture<gnmi.Gnmi.CapabilityResponse> capabilities()
```
    Gets capability from a target.
    
    Returns:
    
    the capability response
  - get
```
java.util.concurrent.CompletableFuture<gnmi.Gnmi.GetResponse> get(gnmi.Gnmi.GetRequest request)
```
    Retrieves a snapshot of data from the device.
    
    Parameters:
    
    request - the get request
    
    Returns:
    
    the snapshot of data from the device
  - set
```
java.util.concurrent.CompletableFuture<gnmi.Gnmi.SetResponse> set(gnmi.Gnmi.SetRequest request)
```
    Modifies the state of data on the device.
    
    Parameters:
    
    request - the set request
    
    Returns:
    
    the set result
  - subscribe
```
void subscribe(gnmi.Gnmi.SubscribeRequest request)
```
    Starts a subscription for the given request. Updates will be notified by the controller via GnmiEvent.Type.UPDATE events. The client guarantees that a Subscription RPC is active at all times despite channel or server failures, unless unsubscribe() is called.
    
    Parameters:
    
    request - the subscribe request
  - unsubscribe
```
void unsubscribe()
```
    Terminates any Subscribe RPC active.