For the complete documentation index, see llms.txt. This page is also available as Markdown.

SetValue

This is Task.

Task version: 2.0.0

Required Frends version: 5.5+

Required .NET version: 6.0

Compatible Agents: Crossplatform

Task Parameters

Name
Description

ValueType : ValueType

Type of the value we want to save in Redis

Possible values:

  • String: Type of the value we want to save in Redis

  • Hash: Type of the value we want to save in Redis

  • List: Type of the value we want to save in Redis

  • Set: Type of the value we want to save in Redis

Default: 1 Example: ValueType.String

Key : String

Key to set

Default: - Example: Foo

StringValue : String

String value to set

Default: - Example: Bar

ListValue : List<String>

List value to set

Default: - Example: ["Foo", "Bar"]

HashValue : Dictionary<String, String>

Dictionary value to set

Default: - Example: { { "Foo", "Bar" }, { "Moo", "Baz" } }

CollectionOperation : Operation

Operation that will be executed in case of collection-like type.

String values are always overwritten.

Possible values:

  • Append: Operation that will be executed in case of collection-like type.

String values are always overwritten.

  • Overwrite: Operation that will be executed in case of collection-like type.

String values are always overwritten.

Default: 1 Example: Operation.Append

ExpiryInSeconds : Nullable<Int32>

Time to live in seconds. Leave empty for infinite.

Default: - Example: 3600

Name
Description

ConnectionMethod : ConnectionMethod

Method to use to connect to Redis

Possible values:

  • SimpleConnectionString: Method to use to connect to Redis

  • MicrosoftEntraId: Method to use to connect to Redis

Default: 1 Example: ConnectionMethod.SimpleConnectionString

ConnectionString : String

Connection string to Redis.

Default: - Example: 127.0.0.1:6379

Name
Description

ThrowErrorOnFailure : Boolean

True: Throw an exception.

False: Error will be added to the Result.Error.AdditionalInformation list instead of stopping the Task.

Default: True Example: true

ErrorMessageOnFailure : String

Message that will be used when an error occurs.

Default: - Example: Task failed during execution

Task Result

Name
Description

Success : Boolean

Success flag Example: true

Error : Error

Error that occurred during task execution. Example: object { string Message, Exception AdditionalInfo }

Task Changelog

Changelog for Task Frends.Redis.SetValue.

[2.0.0] - 2026-03-03

Added

  • Add support for more Redis value types (string, hash, list, set)

  • [Breaking Change] Rename Input.Value to Input.StringValue to distinguish between values of different types.

  • Add option to define if collection-like values will be appended or overwritten.

  • Add support for Microsoft Entra ID

[1.1.0] - 2025-07-31

Changed

  • Make the default error message empty by default

[1.0.0] - 2025-05-13

Changed

  • Initial implementation

Last updated

Was this helpful?