Set Set

yaml
type: "io.kestra.plugin.redis.string.Set"

Set the string value of a key.

Examples

yaml
id: redis_set
namespace: company.team

tasks:
  - id: set
    type: io.kestra.plugin.redis.string.Set
    url: redis://:redis@localhost:6379/0
    key: mykey
    value: myvalue
    serdeType: STRING

Properties

key

  • Type: string
  • Dynamic: ✔️
  • Required: ✔️

The redis key you want to set.

serdeType

  • Type: object
  • Dynamic:
  • Required: ✔️

url

  • Type: string
  • Dynamic: ✔️
  • Required: ✔️

The connection string.

value

  • Type: string
  • Dynamic: ✔️
  • Required: ✔️

The value you want to set.

get

  • Type: boolean
  • Dynamic:
  • Required:
  • Default: false

Define if you get the older value in response, does not work with Redis 5.X.

options

Options available when setting a key in Redis.

See redis documentation.

Outputs

oldValue

  • Type: string
  • Required:

Old value

The old value if you replaced an existing key Required Get to true

Definitions

io.kestra.plugin.redis.string.Set-Options

Properties

expirationDate
  • Type: string
  • Dynamic:
  • Required:
  • Format: date-time

Set the expiration date.

expirationDuration
  • Type: string
  • Dynamic:
  • Required:
  • Format: duration

Set the expiration duration.

keepTtl
  • Type: boolean
  • Dynamic:
  • Required:

Retain the time to live associated with the key.

mustExist
  • Type: boolean
  • Dynamic:
  • Required:

Only set the key if it already exist.

mustNotExist
  • Type: boolean
  • Dynamic:
  • Required:

Only set the key if it does not already exist.

Was this page helpful?