Method Set

Namespace

Skyline.DataMiner.DataSources.OpenConfig.Gnmi.Api

Assembly

Skyline.DataMiner.DataSources.OpenConfig.Gnmi.dll

Set(string, string, double)

Sets the value for a specific path.

public void Set(string path, string value, double timeout = 5)

Parameters

path string

The node path to set. This should be a leaf node.

value string

The string value to set. The gNMI TypedValue used will be StringVal.

timeout double

Timeout in seconds for the request to complete. Default: 5 seconds.

Exceptions

ArgumentException

The path argument cannot be null, empty, or a whitespace.

Set(Path, string, double)

Sets the value for a specific path.

public void Set(Path path, string value, double timeout = 5)

Parameters

path Path

The node path to set. This should be a leaf node.

value string

The string value to set. The gNMI TypedValue used will be StringVal.

timeout double

Timeout in seconds for the request to complete. Default: 5 seconds.

Exceptions

ArgumentNullException

The path argument cannot be null.

RequestFailedException

An exception was thrown by the DxM.

Set(string, string, StringValueContentType, double)

Sets the value for a specific path.

public void Set(string path, string value, StringValueContentType contentType, double timeout = 5)

Parameters

path string

The node path to set. This should be a leaf node unless the contentType is JSON and the data source supports this.

value string

The string value to set.

contentType StringValueContentType

Format of the value parameter. It can be one of the following enum values: - StringValue means that the value parameter is a plain string. - AsciiString means that the value parameter is a plain ASCII string. - JsonUtf8 means that the value parameter is a JSON-encoded string that will be sent to the data source in UTF-8 encoding. - JsonIetfUtf8 means that the value parameter is a JSON-encoded string that follows the RFC8259 standard and will be sent to the data source in UTF-8 encoding.

timeout double

Timeout in seconds for the request to complete. Default: 5 seconds.

Exceptions

ArgumentException

The path argument cannot be null, empty, or a whitespace.

ArgumentException

Argument contentType contains a type that is not supported.

Set(Path, string, StringValueContentType, double)

Sets the value for a specific path.

public void Set(Path path, string value, StringValueContentType contentType, double timeout = 5)

Parameters

path Path

The node path to set. This should be a leaf node unless the contentType is JSON and the data source supports this.

value string

The string value to set.

contentType StringValueContentType

Format of the value parameter. It can be one of the following enum values: - StringValue means that the value parameter is a plain string. - AsciiString means that the value parameter is a plain ASCII string. - JsonUtf8 means that the value parameter is a JSON-encoded string that will be sent to the data source in UTF-8 encoding. - JsonIetfUtf8 means that the value parameter is a JSON-encoded string that follows the RFC8259 standard and will be sent to the data source in UTF-8 encoding.

timeout double

Timeout in seconds for the request to complete. Default: 5 seconds.

Exceptions

ArgumentNullException

The path argument cannot be null.

ArgumentException

Argument contentType contains a type that is not supported.

RequestFailedException

An exception was thrown by the DxM.

Set(string, bool, double)

Sets the value for a specific path.

public void Set(string path, bool value, double timeout = 5)

Parameters

path string

The node path to set. This should be a leaf node.

value bool

The boolean value to set. The gNMI TypedValue used will be BoolVal.

timeout double

Timeout in seconds for the request to complete. Default: 5 seconds.

Exceptions

ArgumentException

The path argument cannot be null, empty, or a whitespace.

Set(Path, bool, double)

Sets the value for a specific path.

public void Set(Path path, bool value, double timeout = 5)

Parameters

path Path

The node path to set. This should be a leaf node.

value bool

The boolean value to set. The gNMI TypedValue used will be BoolVal.

timeout double

Timeout in seconds for the request to complete. Default: 5 seconds.

Exceptions

ArgumentNullException

The path argument cannot be null.

RequestFailedException

An exception was thrown by the DxM.

Set(string, double, double)

Sets the value for a specific path.

public void Set(string path, double value, double timeout = 5)

Parameters

path string

The node path to set. This should be a leaf node.

value double

The double value to set. The gNMI TypedValue used will be DoubleVal.

timeout double

Timeout in seconds for the request to complete. Default: 5 seconds.

Exceptions

ArgumentException

The path argument cannot be null, empty, or a whitespace.

Set(Path, double, double)

Sets the value for a specific path.

public void Set(Path path, double value, double timeout = 5)

Parameters

path Path

The node path to set. This should be a leaf node.

value double

The double value to set. The gNMI TypedValue used will be DoubleVal.

timeout double

Timeout in seconds for the request to complete. Default: 5 seconds.

Exceptions

ArgumentNullException

The path argument cannot be null.

RequestFailedException

An exception was thrown by the DxM.

Set(string, long, double)

Sets the value for a specific path.

public void Set(string path, long value, double timeout = 5)

Parameters

path string

The node path to set. This should be a leaf node.

value long

The Int64 value to set. The gNMI TypedValue used will be IntVal.

timeout double

Timeout in seconds for the request to complete. Default: 5 seconds.

Exceptions

ArgumentException

The path argument cannot be null, empty, or a whitespace.

Set(Path, long, double)

Sets the value for a specific path.

public void Set(Path path, long value, double timeout = 5)

Parameters

path Path

The node path to set. This should be a leaf node.

value long

The Int64 value to set. The gNMI TypedValue used will be IntVal.

timeout double

Timeout in seconds for the request to complete. Default: 5 seconds.

Exceptions

ArgumentNullException

The path argument cannot be null.

RequestFailedException

An exception was thrown by the DxM.

Set(string, ulong, double)

Sets the value for a specific path.

public void Set(string path, ulong value, double timeout = 5)

Parameters

path string

The node path to set. This should be a leaf node.

value ulong

The UInt64 value to set. The gNMI TypedValue used will be UintVal.

timeout double

Timeout in seconds for the request to complete. Default: 5 seconds.

Exceptions

ArgumentException

The path argument cannot be null, empty, or a whitespace.

Set(Path, ulong, double)

Sets the value for a specific path.

public void Set(Path path, ulong value, double timeout = 5)

Parameters

path Path

The node path to set. This should be a leaf node.

value ulong

The UInt64 value to set. The gNMI TypedValue used will be UintVal.

timeout double

Timeout in seconds for the request to complete. Default: 5 seconds.

Exceptions

ArgumentNullException

The path argument cannot be null.

RequestFailedException

An exception was thrown by the DxM.