Skip to content

Commit f38fca3

Browse files
committed
Addressing review comments
1 parent 05ce25c commit f38fca3

File tree

3 files changed

+10
-1
lines changed

3 files changed

+10
-1
lines changed

src/cisco_gnmi/client.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -321,6 +321,9 @@ def subscribe_xpaths(
321321
Specifies the maximum allowable silent period in nanoseconds when
322322
suppress_redundant is in use. The target should send a value at least once
323323
in the period specified. Also applies in ON_CHANGE.
324+
prefix : proto.gnmi_pb2.Path, optional
325+
A common path prepended to all path elements in the message. This reduces message size by
326+
removing redundent path elements. Smaller message == improved thoughput.
324327
325328
Returns
326329
-------

src/cisco_gnmi/nx.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,9 @@ def set_json(self, update_json_configs=None, replace_json_configs=None, ietf=Fal
105105
JSON configs to apply as replacements.
106106
ietf : bool, optional
107107
Use JSON_IETF vs JSON.
108+
prefix : proto.gnmi_pb2.Path, optional
109+
A common path prepended to all path elements in the message. This reduces message size by
110+
removing redundent path elements. Smaller message == improved thoughput.
108111
109112
Returns
110113
-------
@@ -172,7 +175,7 @@ def get_xpaths(self, xpaths, data_type="ALL", encoding="JSON"):
172175
[ALL, CONFIG, STATE, OPERATIONAL]
173176
encoding : proto.gnmi_pb2.GetRequest.Encoding, optional
174177
A direct value or key from the Encoding enum
175-
[JSON, JSON_IETF]
178+
[JSON] is only setting supported at this time
176179
177180
Returns
178181
-------

src/cisco_gnmi/xe.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -266,6 +266,9 @@ def subscribe_xpaths(
266266
Specifies the maximum allowable silent period in nanoseconds when
267267
suppress_redundant is in use. The target should send a value at least once
268268
in the period specified.
269+
prefix : proto.gnmi_pb2.Path, optional
270+
A common path prepended to all path elements in the message. This reduces message size by
271+
removing redundent path elements. Smaller message == improved thoughput.
269272
270273
Returns
271274
-------

0 commit comments

Comments
 (0)