Categorygithub.com/openconfig/gnmic/pkg/api
modulepackage
0.1.8
Repository: https://github.com/openconfig/gnmic.git
Documentation: pkg.go.dev

# Packages

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

# Functions

No description provided by the author
Address sets the target address.
AllowAggregation creates a GNMIOption that sets the AllowAggregation field in a *gnmi.SubscribeRequest with RequestType Subscribe.
Atomic sets the .Atomic field in a gnmi.Notification message.
No description provided by the author
No description provided by the author
DataType creates a GNMIOption that adds the data type to the supplied proto.Message which must be a *gnmi.GetRequest.
DataTypeALL creates a GNMIOption that sets the gnmi.GetRequest data type to ALL.
DataTypeCONFIG creates a GNMIOption that sets the gnmi.GetRequest data type to CONFIG.
DataTypeOPERATIONAL creates a GNMIOption that sets the gnmi.GetRequest data type to OPERATIONAL.
DataTypeSTATE creates a GNMIOption that sets the gnmi.GetRequest data type to STATE.
Delete creates a GNMIOption that creates a *gnmi.Path and adds it to the supplied proto.Message.
Encoding creates a GNMIOption that adds the encoding type to the supplied proto.Message which can be a *gnmi.GetRequest, *gnmi.SetRequest or a *gnmi.SubscribeRequest with RequestType Subscribe.
EncodingASCII creates a GNMIOption that sets the encoding type to ASCII in a gnmi.GetRequest or gnmi.SubscribeRequest.
EncodingBYTES creates a GNMIOption that sets the encoding type to BYTES in a gnmi.GetRequest or gnmi.SubscribeRequest.
EncodingCustom creates a GNMIOption that adds the encoding type to the supplied proto.Message which can be a *gnmi.GetRequest, *gnmi.SetRequest or a *gnmi.SubscribeRequest with RequestType Subscribe.
EncodingJSON creates a GNMIOption that sets the encoding type to JSON in a gnmi.GetRequest or gnmi.SubscribeRequest.
EncodingJSON_IETF creates a GNMIOption that sets the encoding type to JSON_IETF in a gnmi.GetRequest or gnmi.SubscribeRequest.
EncodingPROTO creates a GNMIOption that sets the encoding type to PROTO in a gnmi.GetRequest or gnmi.SubscribeRequest.
No description provided by the author
Extension creates a GNMIOption that applies the supplied gnmi_ext.Extension to the provided proto.Message.
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
Extension_HistoryRange creates a GNMIOption that adds a gNMI extension of type History TimeRange with the supplied start and end times.
Extension_HistorySnapshotTime creates a GNMIOption that adds a gNMI extension of type History Snapshot with the supplied snapshot time.
Gzip, if set to true, adds gzip compression to the gRPC connection.
HeartbeatInterval creates a GNMIOption that sets the HeartbeatInterval in a proto.Message of type *gnmi.Subscription.
Insecure sets the option to create a gNMI client with an insecure gRPC connection.
LogTLSSecret, if set to true, enables logging of the TLS master key.
Name sets the target name.
NewCapabilitiesRequest creates a new *gnmi.CapabilityeRequest using the provided GNMIOption list.
NewCapabilitiesResponse creates a new *gnmi.CapabilityResponse using the provided GNMIOption list.
No description provided by the author
NewGetRequest creates a new *gnmi.GetRequest using the provided GNMIOption list.
NewGetResponse creates a new *gnmi.GetResponse using the provided GNMIOption list.
No description provided by the author
No description provided by the author
No description provided by the author
NewSetRequest creates a new *gnmi.SetRequest using the provided GNMIOption list.
NewSetResponse creates a new *gnmi.SetResponse using the provided GNMIOption list.
NewSubscribePollRequest creates a new *gnmi.SubscribeRequest with request type Poll using the provided GNMIOption list.
NewSubscribeRequest creates a new *gnmi.SubscribeRequest using the provided GNMIOption list.
NewSubscribeResponse creates a *gnmi.SubscribeResponse with a gnmi.SubscribeResponse_Update as response type.
NewSubscribeResponse creates a *gnmi.SubscribeResponse with a gnmi.SubscribeResponse_SyncResponse as response type.
No description provided by the author
Notification creates a GNMIOption that builds a gnmi.Notification from the supplied GNMIOptions and adds it to the supplied proto.Message.
Operation creates a GNMIOption that sets the gnmi.UpdateResult_Operation value in a gnmi.UpdateResult.
OperationDELETE creates a GNMIOption that sets the gnmi.SetResponse Operation to DELETE.
OperationINVALID creates a GNMIOption that sets the gnmi.SetResponse Operation to INVALID.
OperationREPLACE creates a GNMIOption that sets the gnmi.SetResponse Operation to REPLACE.
OperationUPDATE creates a GNMIOption that sets the gnmi.SetResponse Operation to UPDATE.
Password sets the target Password.
Path creates a GNMIOption that creates a *gnmi.Path and adds it to the supplied proto.Message which can be a *gnmi.GetRequest, *gnmi.SetRequest or a *gnmi.Subscription.
Prefix creates a GNMIOption that creates a *gnmi.Path and adds it to the supplied proto.Message (as a Path Prefix).
Qos creates a GNMIOption that sets the QosMarking field in a *gnmi.SubscribeRequest with RequestType Subscribe.
Replace creates a GNMIOption that creates a *gnmi.Update message and adds it to the supplied proto.Message.
SampleInterval creates a GNMIOption that sets the SampleInterval in a proto.Message of type *gnmi.Subscription.
SkipVerify sets the option to create a gNMI client with a secure gRPC connection without verifying the target's certificates.
UpdatesOnly creates a GNMIOption that creates a *gnmi.Subscription based on the supplied GNMIOption(s) and adds it the supplied proto.Mesage which must be of type *gnmi.SubscribeRequest with RequestType Subscribe.
SubscriptionListMode creates a GNMIOption that sets the SubscribeRequest Mode.
SubscriptionListModeONCE creates a GNMIOption that sets the Subscription List Mode to ONCE.
SubscriptionListModePOLL creates a GNMIOption that sets the Subscription List Mode to POLL.
SubscriptionListModeSTREAM creates a GNMIOption that sets the Subscription List Mode to STREAM.
SubscriptionMode creates a GNMIOption that sets the Subscription mode in a proto.Message of type *gnmi.Subscription.
SubscriptionModeON_CHANGE creates a GNMIOption that sets the subscription mode to ON_CHANGE.
SubscriptionModeSAMPLE creates a GNMIOption that sets the subscription mode to SAMPLE.
SubscriptionModeTARGET_DEFINED creates a GNMIOption that sets the subscription mode to TARGET_DEFINED.
No description provided by the author
No description provided by the author
SupportedEncoding creates an GNMIOption that sets the provided encodings as supported encodings in a gnmi.CapabilitiesResponse.
SupportedModel creates an GNMIOption that sets the provided name, org and version as a supported model in a gnmi.CapabilitiesResponse.
SuppressRedundant creates a GNMIOption that sets the SuppressRedundant in a proto.Message of type *gnmi.Subscription.
No description provided by the author
Target creates a GNMIOption that set the gnmi Prefix target to the supplied string value.
No description provided by the author
No description provided by the author
Common Options.
No description provided by the author
Timeout sets the gNMI client creation timeout.
Timestamp sets the supplied timestamp in a gnmi.Notification message.
TimestampNow is the same as Timestamp(time.Now().UnixNano()).
TLSCA sets that path towards the TLS certificate authority file.
TLSCert sets that path towards the TLS certificate file.
TLSConfig.
TLSKey sets that path towards the TLS key file.
TLSMaxVersion sets the TLS maximum version used during the TLS handshake.
TLSMinVersion sets the TLS minimum version used during the TLS handshake.
TLSVersion sets the desired TLS version used during the TLS handshake.
Token sets the per RPC credentials for all RPC calls.
No description provided by the author
No description provided by the author
No description provided by the author
UnionReplace creates a GNMIOption that creates a *gnmi.Update message and adds it to the supplied proto.Message.
Update creates a GNMIOption that creates a *gnmi.Update message and adds it to the supplied proto.Message, the supplied message must be a *gnmi.SetRequest.
UpdateResult creates a GNMIOption that creates a gnmi.UpdateResult and adds it to a proto.Message of type gnmi.SetResponse.
UpdatesOnly creates a GNMIOption that sets the UpdatesOnly field in a *gnmi.SubscribeRequest with RequestType Subscribe.
UseModel creates a GNMIOption that add a gnmi.DataModel to a gnmi.GetRequest or gnmi.SubscribeRequest based on the name, org and version strings provided.
Username sets the target Username.
Value creates a GNMIOption that creates a *gnmi.TypedValue and adds it to the supplied proto.Message.
Version sets the provided gNMI version string in a gnmi.CapabilityResponse message.

# Constants

No description provided by the author

# Variables

No description provided by the author
ErrInvalidMsgType is returned by a GNMIOption in case the Option is supplied an unexpected proto.Message.
ErrInvalidValue is returned by a GNMIOption in case the Option is supplied an unexpected value.

# Type aliases

GNMIOption is a function that acts on the supplied proto.Message.
No description provided by the author
TunnelOption is a function that acts on the supplied proto.Message.